Skip to content

DOCS-14182 clarify retryable writes default #4915

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.

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 1 commit into from
Feb 10, 2021
Merged
Changes from all commits
Commits
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
13 changes: 10 additions & 3 deletions source/core/retryable-writes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,16 @@ For more information on transactions, see :doc:`/core/transactions`.
Enabling Retryable Writes
-------------------------

MongoDB drivers do **not** enable retryable writes by default with the
exception of :ref:`transaction commit and abort operations
<transactions-retry>`.
MongoDB 3.6 introduced support for :ref:`retryable-writes`, but most
official MongoDB 3.6 and 4.0-compatible drivers disable this feature
by default. For such drivers, retryable writes can be enabled per
connection by including the :urioption:`retryWrites=true
<retryWrites>` option in the :ref:`connection string <mongodb-uri>`
for that connection (see below). Refer to the
`MongoDB Driver Documentation
<https://docs.mongodb.com/drivers/?tck=docs_server>`_ to determine
the correct default state of :urioption:`retryWrites` for your
specific driver and version.

MongoDB Drivers
To enable retryable writes in MongoDB drivers, add the
Expand Down