Skip to content

Commit 2149956

Browse files
author
Chris Cho
authored
DOCSP-12334: alphabetize connection options table (#128)
1 parent 312f0b7 commit 2149956

File tree

1 file changed

+108
-77
lines changed

1 file changed

+108
-77
lines changed

source/fundamentals/connection.txt

Lines changed: 108 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -93,22 +93,11 @@ URI to specify the behavior of the client.
9393
- Default Value
9494
- Description
9595

96-
* - **validateOptions**
97-
- boolean
98-
- ``false``
99-
- Specifies whether to error when the method parameters contain an
100-
unknown or incorrect option. If ``false``, the driver produces warnings
101-
only.
102-
103-
* - **poolSize**
104-
- integer
105-
- ``5``
106-
- Specifies the maximum size of the instance connection pool.
107-
108-
* - **minSize**
96+
* - **connectTimeoutMS**
10997
- integer
110-
- ``0``
111-
- Specifies the minimum size of the instance connection pool.
98+
- ``30000``
99+
- Specifies the number of milliseconds to wait before timeout on a TCP
100+
connection.
112101

113102
* - **family**
114103
- number
@@ -117,12 +106,16 @@ URI to specify the behavior of the client.
117106
are: ``4``, ``6``, ``0``, or ``null``. The ``0`` and ``null`` settings
118107
attempt to connect with IPv6 and fall back to IPv4 upon failure.
119108

120-
* - **noDelay**
109+
* - **forceServerObjectId**
121110
- boolean
122-
- ``true``
123-
- Specifies whether to use the TCP socket no-delay option. For more
124-
information, see the documentation for `Node.js socket.setNoDelay
125-
<https://nodejs.org/dist/latest-v10.x/docs/api/net.html#net_socket_setnodelay_nodelay>`_.
111+
- ``false``
112+
- Specifies whether to force the server to assign ``_id`` values to
113+
documents instead of the driver.
114+
115+
* - **ignoreUndefined**
116+
- boolean
117+
- ``false``
118+
- Specifies whether the BSON serializer should ignore undefined fields.
126119

127120
* - **keepAlive**
128121
- boolean
@@ -139,88 +132,81 @@ URI to specify the behavior of the client.
139132
documentation for `Node.js socket.setKeepAlive
140133
<https://nodejs.org/dist/latest-v10.x/docs/api/net.html#net_socket_setkeepalive_enable_initialdelay>`_.
141134

142-
* - **connectTimeoutMS**
143-
- integer
144-
- ``30000``
145-
- Specifies the number of milliseconds to wait before timeout on a TCP
146-
connection.
147-
148-
* - **socketTimeoutMS**
149-
- integer
150-
- ``360000``
151-
- Specifies the number of milliseconds to wait before timeout on a TCP
152-
socket.
135+
* - **logger**
136+
- object
137+
- ``null``
138+
- Specifies a custom logger for the client to use.
153139

154-
* - **w**
155-
- string or integer
140+
* - **loggerLevel**
141+
- string
156142
- ``null``
157-
- Specifies the write concern. For more information on values, see the
158-
server documentation on the
159-
:manual:`w Option </reference/write-concern/#w-option>`.
143+
- Specifies the logger level used by the driver. Valid choices are:
144+
``error``, ``warn``, ``info``, and ``debug``.
160145

161-
* - **forceServerObjectId**
162-
- boolean
163-
- ``false``
164-
- Specifies whether to force the server to assign ``_id`` values to
165-
documents instead of the driver.
146+
* - **minSize**
147+
- integer
148+
- ``0``
149+
- Specifies the minimum size of the instance connection pool.
166150

167-
* - **serializeFunctions**
151+
* - **noDelay**
168152
- boolean
169-
- ``false``
170-
- Specifies whether to serialize functions on any object passed to the
171-
server.
153+
- ``true``
154+
- Specifies whether to use the TCP socket no-delay option. For more
155+
information, see the documentation for `Node.js socket.setNoDelay
156+
<https://nodejs.org/dist/latest-v10.x/docs/api/net.html#net_socket_setnodelay_nodelay>`_.
172157

173-
* - **ignoreUndefined**
174-
- boolean
175-
- ``false``
176-
- Specifies whether the BSON serializer should ignore undefined fields.
158+
* - **pkFactory**
159+
- object
160+
- ``null``
161+
- Specifies a primary key factory object that generates custom ``_id``
162+
keys.
177163

178-
* - **raw**
164+
* - **poolSize**
165+
- integer
166+
- ``5``
167+
- Specifies the maximum size of the instance connection pool.
168+
169+
* - **promiseLibrary**
170+
- object
171+
- ``null``
172+
- Specifies the Promise library class the application uses (e.g. Bluebird).
173+
This library must be compatible with ES6.
174+
175+
* - **promoteBuffers**
179176
- boolean
180177
- ``false``
181-
- Specifies whether to return document results as raw BSON buffers.
178+
- Specifies whether to promote Binary BSON values to native Node.js
179+
``Buffer`` type data.
182180

183181
* - **promoteLongs**
184182
- boolean
185183
- ``true``
186184
- Specifies whether to convert ``Long`` values to a number if they fit
187185
inside 53 bits of resolution.
188186

189-
* - **promoteBuffers**
190-
- boolean
191-
- ``false``
192-
- Specifies whether to promote Binary BSON values to native Node.js
193-
``Buffer`` type data.
194-
195187
* - **promoteValues**
196188
- boolean
197189
- ``true``
198190
- Specifies whether to promote BSON values to Node.js native types when
199191
possible. When set to false, it uses wrapper types to present
200192
BSON values.
201193

202-
* - **pkFactory**
203-
- object
204-
- ``null``
205-
- Specifies a primary key factory object that generates custom ``_id``
206-
keys.
207-
208-
* - **promiseLibrary**
209-
- object
210-
- ``null``
211-
- Specifies the Promise library class the application uses (e.g. Bluebird).
212-
This library must be compatible with ES6.
194+
* - **raw**
195+
- boolean
196+
- ``false``
197+
- Specifies whether to return document results as raw BSON buffers.
213198

214-
* - **loggerLevel**
215-
- string
216-
- ``null``
217-
- Specifies the logger level used by the driver. Valid choices are:
218-
``error``, ``warn``, ``info``, and ``debug``.
199+
* - **serializeFunctions**
200+
- boolean
201+
- ``false``
202+
- Specifies whether to serialize functions on any object passed to the
203+
server.
219204

220-
* - **logger**
221-
- object
222-
- ``null``
223-
- Specifies a custom logger for the client to use.
205+
* - **socketTimeoutMS**
206+
- integer
207+
- ``360000``
208+
- Specifies the number of milliseconds to wait before timeout on a TCP
209+
socket.
224210

225211
* - **tls**
226212
- boolean
@@ -229,6 +215,51 @@ URI to specify the behavior of the client.
229215
connection with the instance. This is automatically set to ``true``
230216
when using a DNS seedlist (SRV) in the connection string. You can
231217
override this behavor by setting the value to ``false``.
218+
219+
* - **validateOptions**
220+
- boolean
221+
- ``false``
222+
- Specifies whether to error when the method parameters contain an
223+
unknown or incorrect option. If ``false``, the driver produces warnings
224+
only.
225+
226+
* - **w**
227+
- string or integer
228+
- ``null``
229+
- Specifies the write concern. For more information on values, see the
230+
server documentation on the
231+
:manual:`w Option </reference/write-concern/#w-option>`.
232+
233+
234+
235+
236+
237+
238+
239+
240+
241+
242+
243+
244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
254+
255+
256+
257+
258+
259+
260+
261+
262+
232263

233264
For a complete list of options, see the :node-api:`MongoClient
234265
<MongoClient.html>` API reference page.

0 commit comments

Comments
 (0)