@@ -66,6 +66,7 @@ timeout of 5 seconds by using each method:
66
66
:language: java
67
67
:start-after: start-string
68
68
:end-before: end-string
69
+ :dedent:
69
70
70
71
Behavior
71
72
~~~~~~~~
@@ -75,7 +76,7 @@ accepted values for ``timeoutMS``:
75
76
76
77
.. list-table::
77
78
:header-rows: 1
78
- :widths: 35 65
79
+ :widths: 25 75
79
80
80
81
* - Value
81
82
- Behavior
@@ -90,10 +91,10 @@ accepted values for ``timeoutMS``:
90
91
- | Defers the timeout behavior to the following settings:
91
92
|
92
93
| - :manual:`waitQueueTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.waitQueueTimeoutMS>`
93
- | - :manual:`socketTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.socketTimeoutMS>`
94
- | - :manual:`wTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.wtimeoutMS>`
95
- | - :manual:`maxTimeMS </reference/method/cursor.maxTimeMS/>` *(deprecated)*
96
- | - `maxCommitTimeMS <{+core-api+}/com/mongodb/TransactionOptions.Builder.html#maxCommitTime(java.lang.Long,java.util.concurrent.TimeUnit)>`__ *(deprecated)*
94
+ - :manual:`socketTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.socketTimeoutMS>`
95
+ - :manual:`wTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.wtimeoutMS>`
96
+ - :manual:`maxTimeMS </reference/method/cursor.maxTimeMS/>` *(deprecated)*
97
+ - `maxCommitTimeMS <{+core-api+}/com/mongodb/TransactionOptions.Builder.html#maxCommitTime(java.lang.Long,java.util.concurrent.TimeUnit)>`__ *(deprecated)*
97
98
|
98
99
| When the CSOT feature is no longer experimental, all the
99
100
preceding options will be deprecated.
@@ -159,9 +160,9 @@ Overrides
159
160
The {+driver-short+} supports various levels of configuration to control the
160
161
behavior and performance of database operations.
161
162
162
- You can specify a ``timeoutMS`` option at the operation level to override the
163
- client-level configuration for a specific operation . This allows you to
164
- customize timeouts based on the needs of individual queries .
163
+ You can specify a ``timeoutMS`` option at a lower level to override the
164
+ client-level configuration. This allows you to customize timeouts based
165
+ on the needs of individual operations .
165
166
166
167
The following example demonstrates how an collection-level timeout
167
168
configuration can override a client-level timeout configuration:
@@ -292,4 +293,11 @@ API Documentation
292
293
To learn more about using timeouts with the {+driver-short+}, see the following
293
294
API documentation:
294
295
295
-
296
+ - `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
297
+ - `MongoClientSettings.Builder.timeout() <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
298
+ - `MongoCollection.withTimeout() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withTimeout(long,java.util.concurrent.TimeUnit)>`__
299
+ - `ClientSessionOptions.Builder.defaultTimeout() <{+core-api+}/com/mongodb/ClientSessionOptions.Builder.html#defaultTimeout(long,java.util.concurrent.TimeUnit)>`__
300
+ - `TransactionOptions.Builder.timeout() <{+core-api+}/com/mongodb/TransactionOptions.Builder.html#timeout(java.lang.Long,java.util.concurrent.TimeUnit)>`__
301
+ - `ClientEncryptionSettings.Builder.timeout() <{+core-api+}/com/mongodb/ClientEncryptionSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
302
+ - `FindIterable.timeoutMode() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#timeoutMode(com.mongodb.client.cursor.TimeoutMode)>`__
303
+ - `TimeoutMode <{+core-api+}/com/mongodb/client/cursor/TimeoutMode.html>`__
0 commit comments