|
4 | 4 | Connection Options |
5 | 5 | ================== |
6 | 6 |
|
| 7 | +.. facet:: |
| 8 | + :name: genre |
| 9 | + :values: reference |
| 10 | + |
| 11 | +.. meta:: |
| 12 | + :keywords: node.js, customize |
| 13 | + |
7 | 14 | This section explains the MongoDB connection and authentication options |
8 | 15 | supported by the driver. You can pass the connection options as |
9 | 16 | parameters of the connection URI to specify the behavior of the client. |
@@ -44,7 +51,7 @@ parameters of the connection URI to specify the behavior of the client. |
44 | 51 | * - **authSource** |
45 | 52 | - string |
46 | 53 | - ``null`` |
47 | | - - Specifies the database that connections should authenticate against. |
| 54 | + - Specifies the database that connections authenticate against. |
48 | 55 |
|
49 | 56 | * - **compressors** |
50 | 57 | - comma separated list of strings, for example, "snappy,zlib,zstd" |
@@ -118,8 +125,8 @@ parameters of the connection URI to specify the behavior of the client. |
118 | 125 | * - **minPoolSize** |
119 | 126 | - non-negative integer |
120 | 127 | - ``0`` |
121 | | - - Specifies the number of connections the driver should create and |
122 | | - maintain in the connection pool even when no operations are occurring. |
| 128 | + - Specifies the number of connections the driver creates and |
| 129 | + maintains in the connection pool even when no operations are occurring. |
123 | 130 | This count includes connections in use. |
124 | 131 |
|
125 | 132 | * - **proxyHost** |
@@ -246,17 +253,16 @@ parameters of the connection URI to specify the behavior of the client. |
246 | 253 | * - **tlsAllowInvalidCertificates** |
247 | 254 | - boolean |
248 | 255 | - ``false`` |
249 | | - - Specifies whether the driver should error when the server’s |
250 | | - TLS certificate is invalid. You should only set this option to |
251 | | - ``true`` for testing purposes. |
| 256 | + - Specifies whether the driver generates an error when the server's |
| 257 | + TLS certificate is invalid. Set this option to ``true`` for testing |
| 258 | + purposes only. |
252 | 259 |
|
253 | 260 | * - **tlsAllowInvalidHostnames** |
254 | 261 | - boolean |
255 | 262 | - ``false`` |
256 | | - - Specifies whether the driver should error when there is a mismatch |
257 | | - between the server’s hostname and the hostname specified by the |
258 | | - TLS certificate. You should only set this option to |
259 | | - ``true`` for testing purposes. |
| 263 | + - Specifies whether the driver generates an error when there is a mismatch |
| 264 | + between the server's hostname and the hostname specified by the |
| 265 | + TLS certificate. Set this option to ``true`` for testing purposes only. |
260 | 266 |
|
261 | 267 | * - **tlsCAFile** |
262 | 268 | - string |
@@ -285,8 +291,8 @@ parameters of the connection URI to specify the behavior of the client. |
285 | 291 | - boolean |
286 | 292 | - ``false`` |
287 | 293 | - Specifies to relax TLS constraints as much as possible, such as |
288 | | - allowing invalid certificates or hostname mismatches. You should |
289 | | - only set this option to ``true`` for testing purposes. |
| 294 | + allowing invalid certificates or hostname mismatches. Set this option |
| 295 | + to ``true`` for testing purposes only. |
290 | 296 |
|
291 | 297 | * - **w** |
292 | 298 | - non-negative integer or string |
|
0 commit comments