Skip to content

Commit 3e08b85

Browse files
rcsanchez97rcsanchez97
committed
CDRIVER-3794 document default values for connection options
1 parent 2188ce3 commit 3e08b85

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎src/libmongoc/doc/mongoc_uri_t.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,20 +87,20 @@ IPv4 and IPv6
8787
Connection Options
8888
------------------
8989

90-
========================================== ================================= ============================================================================================================================================================================================================================================
91-
Constant Key Description
92-
========================================== ================================= ============================================================================================================================================================================================================================================
93-
MONGOC_URI_RETRYREADS retryreads If "true" and the server is a MongoDB 3.6+ standalone, replica set, or sharded cluster, the driver safely retries a read that failed due to a network error or replica set failover.
94-
MONGOC_URI_RETRYWRITES retrywrites If "true" and the server is a MongoDB 3.6+ replica set or sharded cluster, the driver safely retries a write that failed due to a network error or replica set failover. Only inserts, updates of single documents, or deletes of single
95-
documents are retried.
96-
MONGOC_URI_APPNAME appname The client application name. This value is used by MongoDB when it logs connection information and profile information, such as slow queries.
97-
MONGOC_URI_TLS tls {true|false}, indicating if TLS must be used. (See also :symbol:`mongoc_client_set_ssl_opts` and :symbol:`mongoc_client_pool_set_ssl_opts`.)
98-
MONGOC_URI_COMPRESSORS compressors Comma separated list of compressors, if any, to use to compress the wire protocol messages. Snappy, zlib, and zstd are optional build time dependencies, and enable the "snappy", "zlib", and "zstd" values respectively. Defaults to empty (no compressors).
99-
MONGOC_URI_CONNECTTIMEOUTMS connecttimeoutms This setting applies to new server connections. It is also used as the socket timeout for server discovery and monitoring operations. The default is 10,000 ms (10 seconds).
100-
MONGOC_URI_SOCKETTIMEOUTMS sockettimeoutms The time in milliseconds to attempt to send or receive on a socket before the attempt times out. The default is 300,000 (5 minutes).
101-
MONGOC_URI_REPLICASET replicaset The name of the Replica Set that the driver should connect to.
102-
MONGOC_URI_ZLIBCOMPRESSIONLEVEL zlibcompressionlevel When the MONGOC_URI_COMPRESSORS includes "zlib" this options configures the zlib compression level, when the zlib compressor is used to compress client data.
103-
========================================== ================================= ============================================================================================================================================================================================================================================
90+
========================================== ================================= ================================= ============================================================================================================================================================================================================================================
91+
Constant Key Default Description
92+
========================================== ================================= ================================= ============================================================================================================================================================================================================================================
93+
MONGOC_URI_RETRYREADS retryreads true If "true" and the server is a MongoDB 3.6+ standalone, replica set, or sharded cluster, the driver safely retries a read that failed due to a network error or replica set failover.
94+
MONGOC_URI_RETRYWRITES retrywrites true if driver built w/ TLS If "true" and the server is a MongoDB 3.6+ replica set or sharded cluster, the driver safely retries a write that failed due to a network error or replica set failover. Only inserts, updates of single documents, or deletes of single
95+
documents are retried.
96+
MONGOC_URI_APPNAME appname Empty (no appname) The client application name. This value is used by MongoDB when it logs connection information and profile information, such as slow queries.
97+
MONGOC_URI_TLS tls Empty (not set, same as false) {true|false}, indicating if TLS must be used. (See also :symbol:`mongoc_client_set_ssl_opts` and :symbol:`mongoc_client_pool_set_ssl_opts`.)
98+
MONGOC_URI_COMPRESSORS compressors Empty (no compressors) Comma separated list of compressors, if any, to use to compress the wire protocol messages. Snappy, zlib, and zstd are optional build time dependencies, and enable the "snappy", "zlib", and "zstd" values respectively.
99+
MONGOC_URI_CONNECTTIMEOUTMS connecttimeoutms 10,000 ms (10 seconds) This setting applies to new server connections. It is also used as the socket timeout for server discovery and monitoring operations.
100+
MONGOC_URI_SOCKETTIMEOUTMS sockettimeoutms 300,000 ms (5 minutes) The time in milliseconds to attempt to send or receive on a socket before the attempt times out.
101+
MONGOC_URI_REPLICASET replicaset Empty (no replicaset) The name of the Replica Set that the driver should connect to.
102+
MONGOC_URI_ZLIBCOMPRESSIONLEVEL zlibcompressionlevel -1 When the MONGOC_URI_COMPRESSORS includes "zlib" this options configures the zlib compression level, when the zlib compressor is used to compress client data.
103+
========================================== ================================= ================================= ============================================================================================================================================================================================================================================
104104

105105
Setting any of the \*timeoutMS options above to ``0`` will be interpreted as "use the default value".
106106

0 commit comments

Comments
 (0)