8000 DOCSP-35923: csot page by rustagir · Pull Request #657 · mongodb/docs-java · GitHub
[go: up one dir, main page]
Skip to content

DOCSP-35923: csot page #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Mar 31, 2025
Merged

DOCSP-35923: csot page #657

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
26b875a
DOCSP-35923: csot page
rustagir Mar 20, 2025
5a7d56b
small fix
rustagir Mar 20, 2025
f941168
api docs + fixes
rustagir Mar 20, 2025
739a254
txn code examples
rustagir Mar 20, 2025
721aca4
deprecations
rustagir Mar 20, 2025
a1c2f15
list fix
rustagir Mar 20, 2025
9f5742d
fix
rustagir Mar 20, 2025
50af85d
merge upstream
rustagir Mar 24, 2025
4c4e235
MW + MK PR fixes
rustagir Mar 24, 2025
89ba82a
Merge branch 'master' of github.com:mongodb/docs-java into DOCSP-3592…
rustagir Mar 26, 2025
d9e0b19
MK tech review 2
rustagir Mar 26, 2025
a5d5edc
fix links
rustagir Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix links
  • Loading branch information
@rustagir
rustagir committed Mar 31, 2025
commit a5d5edc1f5e6ba8e6e1f9b22f0936f89cb35757d
36 changes: 17 additions & 19 deletions source/connection/specify-connection-options/csot.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ accepted values for ``timeoutMS``:
- :manual:`socketTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.socketTimeoutMS>`
- :manual:`wTimeoutMS </reference/connection-string-options/#mongodb-urioption-urioption.wtimeoutMS>`
- :manual:`maxTimeMS </reference/method/cursor.maxTimeMS/>`
- `maxCommitTimeMS <{+core-api+}/com/mongodb/TransactionOptions.Builder.html#maxCommitTime(java.lang.Long,java.util.concurrent.TimeUnit)>`__
- `maxCommitTimeMS <{+core-api+}/TransactionOptions.Builder.html#maxCommitTime(java.lang.Long,java.util.concurrent.TimeUnit)>`__

| These settings are deprecated and are ignored if you set ``timeoutMS``.

Expand Down Expand Up @@ -182,17 +182,15 @@ configuration can override a client-level timeout configuration:
Transactions
~~~~~~~~~~~~

When you create a new `ClientSession
<{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/ClientSession.html>`__
instance to implement a transaction, use
the ``defaultTimeout()`` method when building a ``ClientSessionOptions``
instance. You can use this option to specify the timeout for
the following methods:
When you create a new `ClientSession <{+driver-api+}/ClientSession.html>`__
instance to implement a transaction, use the ``defaultTimeout()`` method
when building a ``ClientSessionOptions`` instance. You can use this
option to specify the timeout for the following methods:

- `commitTransaction() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/ClientSession.html#commitTransaction()>`__
- `abortTransaction() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/ClientSession.html#abortTransaction()>`__
- `withTransaction() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/ClientSession.html#withTransaction(com.mongodb.client.TransactionBody)>`__
- `close() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/session/ClientSession.html#close()>`__
- `commitTransaction() <{+driver-api+}/ClientSession.html#commitTransaction()>`__
- `abortTransaction() <{+driver-api+}/ClientSession.html#abortTransaction()>`__
- `withTransaction() <{+driver-api+}/ClientSession.html#withTransaction(com.mongodb.client.TransactionBody)>`__
- `close() <{+core-api+}/session/ClientSession.html#close()>`__

The following code demonstrates how to set the ``defaultTimeout`` when
instantiating a ``ClientSession``:
Expand Down Expand Up @@ -311,11 +309,11 @@ API Documentation
To learn more about using timeouts with the {+driver-short+}, see the following
API documentation:

- `MongoClientSettings <{+core-api+}/com/mongodb/MongoClientSettings.html>`__
- `MongoClientSettings.Builder.timeout() <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
- `MongoCollection.withTimeout() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#withTimeout(long,java.util.concurrent.TimeUnit)>`__
- `ClientSessionOptions.Builder.defaultTimeout() <{+core-api+}/com/mongodb/ClientSessionOptions.Builder.html#defaultTimeout(long,java.util.concurrent.TimeUnit)>`__
- `TransactionOptions.Builder.timeout() <{+core-api+}/com/mongodb/TransactionOptions.Builder.html#timeout(java.lang.Long,java.util.concurrent.TimeUnit)>`__
- `ClientEncryptionSettings.Builder.timeout() <{+core-api+}/com/mongodb/ClientEncryptionSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
- `FindIterable.timeoutMode() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#timeoutMode(com.mongodb.client.cursor.TimeoutMode)>`__
- `TimeoutMode <{+core-api+}/com/mongodb/client/cursor/TimeoutMode.html>`__
- `MongoClientSettings <{+core-api+}/MongoClientSettings.html>`__
- `MongoClientSettings.Builder.timeout() <{+core-api+}/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
- `MongoCollection.withTimeout() <{+driver-api+}/MongoCollection.html#withTimeout(long,java.util.concurrent.TimeUnit)>`__
- `ClientSessionOptions.Builder.defaultTimeout() <{+core-api+}/ClientSessionOptions.Builder.html#defaultTimeout(long,java.util.concurrent.TimeUnit)>`__
- `TransactionOptions.Builder.timeout() <{+core-api+}/TransactionOptions.Builder.html#timeout(java.lang.Long,java.util.concurrent.TimeUnit)>`__
- `ClientEncryptionSettings.Builder.timeout() <{+core-api+}/ClientEncryptionSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
- `FindIterable.timeoutMode() <{+driver-api+}/FindIterable.html#timeoutMode(com.mongodb.client.cursor.TimeoutMode)>`__
- `TimeoutMode <{+core-api+}/client/cursor/TimeoutMode.html>`__
4 changes: 2 additions & 2 deletions source/connection/specify-connection-options/stable-api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,5 +143,5 @@ of ``ServerApi`` by chaining methods on the ``ServerApi.Builder``:
For more information about the options in this section, see the following
API Documentation:

- `strict() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.Builder.html#strict(boolean)>`__
- `deprecationErrors() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ServerApi.Builder.html#>`__
- `strict() <{+core-api+}/ServerApi.Builder.html#strict(boolean)>`__
- `deprecationErrors() <{+core-api+}/ServerApi.Builder.html#>`__
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.
0