Skip to content

Commit b4c8ed6

Browse files
jason-price-mongodbjason-price-mongodb
jason-price-mongodb
and
jason-price-mongodb
authored
Docs-15280 mongos connection pool (#1311)
* DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool * DOCS-15280-mongos-connection-pool Co-authored-by: jason-price-mongodb <[email protected]>
1 parent 3f8dc22 commit b4c8ed6

9 files changed

+111
-3
lines changed

‎source/administration/connection-pool-overview.txt

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,15 @@ Settings
163163
*Default*: ``1``. See
164164
:parameter:`ShardingTaskExecutorPoolMinSize`.
165165

166-
This setting only applies to sharded deployments.
166+
Parameter only applies to sharded deployments.
167+
168+
* - :parameter:`ShardingTaskExecutorPoolMinSizeForConfigServers`
169+
170+
- .. include:: /includes/ShardingTaskExecutorPoolMinSizeForConfigServers-parameter.rst
171+
172+
*Default*: ``-1``
173+
174+
.. versionadded:: 6.0
167175

168176
* - :parameter:`ShardingTaskExecutorPoolMaxSize`
169177

@@ -174,8 +182,16 @@ Settings
174182
*Default*: 2\ :sup:`64` - 1. See
175183
:parameter:`ShardingTaskExecutorPoolMaxSize`.
176184

177-
This setting only applies to sharded deployments.
178-
185+
Parameter only applies to sharded deployments.
186+
187+
* - :parameter:`ShardingTaskExecutorPoolMaxSizeForConfigServers`
188+
189+
- .. include:: /includes/ShardingTaskExecutorPoolMaxSizeForConfigServers-parameter.rst
190+
191+
*Default*: ``-1``
192+
193+
.. versionadded:: 6.0
194+
179195
.. toctree::
180196
:titlesonly:
181197
:hidden:

‎source/includes/ShardingTaskExecutorPoolMaxSizeForConfigServers-parameter-example.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. |parameter| replace:: :parameter:`ShardingTaskExecutorPoolMaxSize`
2+
.. |maximum-or-minimum| replace:: maximum
3+
4+
.. include:: /includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter-example.rst

‎source/includes/ShardingTaskExecutorPoolMaxSizeForConfigServers-parameter.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. |parameter| replace:: :parameter:`ShardingTaskExecutorPoolMaxSize`
2+
.. |maximum-or-minimum| replace:: maximum
3+
4+
.. include:: /includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter.rst

‎source/includes/ShardingTaskExecutorPoolMinSizeForConfigServers-parameter-example.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. |parameter| replace:: :parameter:`ShardingTaskExecutorPoolMinSize`
2+
.. |maximum-or-minimum| replace:: minimum
3+
4+
.. include:: /includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter-example.rst

‎source/includes/ShardingTaskExecutorPoolMinSizeForConfigServers-parameter.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. |parameter| replace:: :parameter:`ShardingTaskExecutorPoolMinSize`
2+
.. |maximum-or-minimum| replace:: minimum
3+
4+
.. include:: /includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter.rst

‎source/includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter-example.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
The following example sets |parameter| to ``2`` during startup, which
2+
sets the |maximum-or-minimum| number of outbound connections each
3+
TaskExecutor connection pool can open to a configuration server to
4+
``2``:

‎source/includes/ShardingTaskExecutorPoolSizeForConfigServers-parameter.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Optional override for |parameter| to set the |maximum-or-minimum| number
2+
of outbound connections each TaskExecutor connection pool can open to a
3+
:ref:`configuration server <sharding-config-server>`.
4+
5+
When set to:
6+
7+
- ``-1``, |parameter| is used. This is the default.
8+
9+
- an integer value greater than ``-1``, overrides the
10+
|maximum-or-minimum| number of outbound connections each TaskExecutor
11+
connection pool can open to a configuration server.
12+
13+
Parameter only applies to sharded deployments.

‎source/reference/parameters.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3480,6 +3480,31 @@ Sharding Parameters
34803480

34813481
:parameter:`ShardingTaskExecutorPoolMinSize`
34823482

3483+
.. parameter:: ShardingTaskExecutorPoolMaxSizeForConfigServers
3484+
3485+
.. versionadded:: 6.0
3486+
3487+
Type: integer
3488+
3489+
Default: -1
3490+
3491+
|both|
3492+
3493+
.. include:: /includes/ShardingTaskExecutorPoolMaxSizeForConfigServers-parameter.rst
3494+
3495+
.. include:: /includes/ShardingTaskExecutorPoolMaxSizeForConfigServers-parameter-example.rst
3496+
3497+
.. code-block:: bash
3498+
3499+
mongos --setParameter ShardingTaskExecutorPoolMaxSizeForConfigServers=2
3500+
3501+
During runtime, you can also set the parameter with the
3502+
:dbcommand:`setParameter` command:
3503+
3504+
.. code-block:: javascript
3505+
3506+
db.adminCommand( { setParameter: 1, ShardingTaskExecutorPoolMaxSizeForConfigServers: 2 } )
3507+
34833508
.. _sharding-pool-minsize-parameters:
34843509

34853510
.. parameter:: ShardingTaskExecutorPoolMinSize
@@ -3536,6 +3561,31 @@ Sharding Parameters
35363561
- :parameter:`ShardingTaskExecutorPoolMaxSize`
35373562
- :parameter:`warmMinConnectionsInShardingTaskExecutorPoolOnStartup`
35383563

3564+
.. parameter:: ShardingTaskExecutorPoolMinSizeForConfigServers
3565+
3566+
.. versionadded:: 6.0
3567+
3568+
Type: integer
3569+
3570+
Default: -1
3571+
3572+
|both|
3573+
3574+
.. include:: /includes/ShardingTaskExecutorPoolMinSizeForConfigServers-parameter.rst
3575+
3576+
.. include:: /includes/ShardingTaskExecutorPoolMinSizeForConfigServers-parameter-example.rst
3577+
3578+
.. code-block:: bash
3579+
3580+
mongos --setParameter ShardingTaskExecutorPoolMinSizeForConfigServers=2
3581+
3582+
During runtime, you can also set the parameter with the
3583+
:dbcommand:`setParameter` command:
3584+
3585+
.. code-block:: javascript
3586+
3587+
db.adminCommand( { setParameter: 1, ShardingTaskExecutorPoolMinSizeForConfigServers: 2 } )
3588+
35393589
.. parameter:: ShardingTaskExecutorPoolRefreshRequirementMS
35403590

35413591
Type: integer

‎source/release-notes/6.0.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,15 @@ cluster. You can use :dbcommand:`setClusterParameter` to modify cluster-wide
164164
options and :dbcommand:`getClusterParameter` to retrieve the value of a cluster
165165
parameter.
166166

167+
Connection Pool Parameters
168+
~~~~~~~~~~~~~~~~~~~~~~~~~~
169+
170+
Starting in MongoDB 6.0, you can use
171+
:parameter:`ShardingTaskExecutorPoolMinSizeForConfigServers` and
172+
:parameter:`ShardingTaskExecutorPoolMaxSizeForConfigServers` to set the
173+
minimum and maximum sharding TaskExecutor connection pool size for
174+
:ref:`configuration servers <sharding-config-server>`.
175+
167176
Clustered Collections
168177
---------------------
169178

0 commit comments

Comments
 (0)