Skip to content

Commit 3740ec8

Browse files
lindseymoorelindseymoore
committed
rachel feedback
1 parent 8266c19 commit 3740ec8

File tree

1 file changed

+73
-78
lines changed

1 file changed

+73
-78
lines changed

‎source/connection/connection-pools.txt

Lines changed: 73 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -52,110 +52,105 @@ string or by passing a ``MongoClientSettings`` object to the
5252
``MongoClients.create()`` method.
5353

5454
The following code creates a client with a maximum connection pool size of ``50``
55-
by using either a :guilabel:`Connection String` or :guilabel:`MongoClientSettings`
55+
by using either a connection String or MongoClientSettings
5656
object:
5757

5858
.. tabs::
5959

60-
.. tab:: Connection String
61-
:tabid: uri
60+
.. tab:: Connection String
61+
:tabid: uri
62+
63+
.. code-block:: java
6264

63-
.. code-block:: java
65+
ConnectionString connectionString = "mongodb://<host>:<port>/?maxPoolSize=50"
66+
MongoClient mongoClient = MongoClients.create(connectionString)
6467

65-
ConnectionString connectionString = "mongodb://<host>:<port>/?maxPoolSize=50"
66-
MongoClient mongoClient = MongoClients.create(connectionString)
68+
The following are connection string settings you can use to configure your
69+
connection pool:
6770

68-
.. tab:: MongoClientSettings
69-
:tabid: MongoClient
70-
71-
.. literalinclude:: /includes/fundamentals/code-snippets/ConnectionPool.java
72-
:start-after: begin MongoSettings
73-
:end-before: end MongoSettings
74-
:language: java
75-
:dedent:
76-
77-
Connection Pool Settings
78-
~~~~~~~~~~~~~~~~~~~~~~~~
71+
.. list-table::
72+
:widths: 25,75
73+
:header-rows: 1
7974

80-
The following are connection string settings you can use to configure your
81-
connection pool:
75+
* - Setting
76+
- Description
77+
78+
* - :urioption:`connectTimeoutMS`
8279

83-
.. list-table::
84-
:widths: 25,75
85-
:header-rows: 1
80+
- Specifies the maximum amount of time, in milliseconds, the Java driver
81+
waits for a connection to open before timing out. A value of 0 instructs
82+
the driver to never time out while waiting for a connection to open.
83+
84+
*Default:* ``10000`` (10 seconds)
85+
86+
* - :urioption:`maxConnecting`
87+
88+
- Maximum number of connections a pool may establish
89+
concurrently.
8690

87-
* - Setting
88-
- Description
89-
90-
* - :urioption:`connectTimeoutMS`
91+
*Default:* ``2``
92+
93+
* - :urioption:`maxIdleTimeMS`
94+
95+
- The maximum number of milliseconds that a connection can
96+
remain idle in the pool before being removed and closed.
9197

92-
- Specifies the maximum amount of time, in milliseconds, the Java driver
93-
waits for a connection to open before timing out. A value of 0 instructs
94-
the driver to never time out while waiting for a connection to open.
95-
96-
*Default:* ``10000`` (10 seconds)
97-
98-
* - :urioption:`maxConnecting`
99-
100-
- Maximum number of connections a pool may establish
101-
concurrently.
98+
*Default:* ``0``
99+
100+
* - :urioption:`maxPoolSize`
102101

103-
.. include:: /includes/connection-pool/max-connecting-use-case.rst
102+
- Maximum number of connections opened in the pool. When the
103+
connection pool reaches the maximum number of connections, new
104+
connections wait up until to the value of
105+
:urioption:`waitQueueTimeoutMS`.
104106

105-
*Default:* ``2``
106-
107-
* - :urioption:`maxIdleTimeMS`
108-
109-
- The maximum number of milliseconds that a connection can
110-
remain idle in the pool before being removed and closed.
107+
*Default:* ``100``
111108

112-
*Default:* ``0``
113-
114-
* - :urioption:`maxPoolSize`
109+
* - :urioption:`minPoolSize`
115110

116-
- Maximum number of connections opened in the pool. When the
117-
connection pool reaches the maximum number of connections, new
118-
connections wait up until to the value of
119-
:urioption:`waitQueueTimeoutMS`.
111+
- Minimum number of connections opened in the pool.
112+
The value of :urioption:`minPoolSize` must be less than
113+
the value of :urioption:`maxPoolSize`.
120114

121-
*Default:* ``100``
115+
*Default*: ``0``
122116

123-
* - :urioption:`minPoolSize`
117+
* - :urioption:`socketTimeoutMS`
124118

125-
- Minimum number of connections opened in the pool.
126-
The value of :urioption:`minPoolSize` must be less than
127-
the value of :urioption:`maxPoolSize`.
119+
- Number of milliseconds to wait before timeout on a TCP
120+
connection.
121+
122+
Do *not* use :urioption:`socketTimeoutMS` as a mechanism for
123+
preventing long-running server operations.
128124

129-
*Default*: ``0``
125+
Setting low socket timeouts may result in operations that error
126+
before the server responds.
127+
128+
*Default*: ``0``, which means no timeout.
130129

131-
* - :urioption:`socketTimeoutMS`
130+
* - :urioption:`waitQueueTimeoutMS`
132131

133-
- Number of milliseconds to wait before timeout on a TCP
134-
connection.
135-
136-
Do *not* use :urioption:`socketTimeoutMS` as a mechanism for
137-
preventing long-running server operations.
132+
- Maximum wait time in milliseconds that a thread can wait for
133+
a connection to become available. A value of ``0`` means there
134+
is no limit.
138135

139-
Setting low socket timeouts may result in operations that error
140-
before the server responds.
141-
142-
*Default*: ``0``, which means no timeout.
136+
*Default*: ``120000`` (120 seconds)
143137

144-
* - :urioption:`waitQueueTimeoutMS`
138+
For more information on these connection string options, see the
139+
:ref:`Connection Options <connection-options>`
140+
guide.
145141

146-
- Maximum wait time in milliseconds that a thread can wait for
147-
a connection to become available. A value of ``0`` means there
148-
is no limit.
149-
150-
*Default*: ``120000`` (120 seconds)
142+
.. tab:: MongoClientSettings
143+
:tabid: MongoClient
151144

152-
For more information on these connection string options, see the
153-
:ref:`Connection Options <connection-options>`
154-
guide.
145+
.. literalinclude:: /includes/fundamentals/code-snippets/ConnectionPool.java
146+
:start-after: begin MongoSettings
147+
:end-before: end MongoSettings
148+
:language: java
149+
:dedent:
155150

156-
For more information on configuring you connection pool by using a
157-
``MongoClientSettings`` object see the Connection Pool Settings section
158-
of the :ref:`<specify-mongoclient-settings>` guide.
151+
For more information on configuring you connection pool by using a
152+
``MongoClientSettings`` object see the Connection Pool Settings section
153+
of the :ref:`<specify-mongoclient-settings>` guide.
159154

160155
Additional Information
161156
----------------------

0 commit comments

Comments
 (0)