Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add citus.local_shared_pool_size #989

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add citus.local_shared_pool_size #989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion develop/api_guc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ citus.max_shared_pool_size (integer)
************************************

Specifies the maximum number of connections that the coordinator node, across
all simultaneous sessions, is allowed to make per worker node. PostgreSQL must
all simultaneous sessions, is allowed to make per remote node. PostgreSQL must
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this terminology something we want to generally change? Should probably keep it consistent...

allocate fixed resources for every connection and this GUC helps ease
connection pressure on workers.

Expand All @@ -406,6 +406,22 @@ the note below). The value -1 disables throttling.
on the coordinator. This gives extra space for connections required for
repartition queries on the workers.

citus.local_shared_pool_size (integer)
**************************************

Specifies the maximum number of connections, across all simultaneous
sessions, is allowed to make to the local node. This setting is relevant
when the local node has shards, such as Citus on Single Node.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the syntax to give a reference toCitus on Single Node section?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

:ref:`Citus on Single Node <development>`

or

:ref:`development`

if you want to use the text of the linked header, in this case Single-Node Citus.


By default, the value is automatically set equal to the half of the node's
own ``max_connections``.

The setting provides similar throttling as :ref:`max_shared_pool_size`, however
only for local node. The goal is that Citus should refrain to use all the avaliable
connection slots in ``max_connections`` and allow the client backends (e.g.,
``psql``) to have enough space to connect. The value -1 disables throttling.


citus.max_adaptive_executor_pool_size (integer)
***********************************************

Expand Down