Skip to content
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

DOCS-14433 config.transactions read concern disallowed #5783

Conversation

ianf-mongodb
Copy link
Contributor

No description provided.

@@ -0,0 +1,10 @@
Starting in MongoDB 5.0, non-transaction reads are not allowed on
:ref:`config.transactions<config.transactions>`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two things:

  1. Please use
:data:`config.transactions`

for this link instead of a ref link.

  1. I think we should say:
not allowed on the :data:`config.transactions` collection with the following...

Comment on lines 5 to 10
- :ref:`read concern "snapshot"<readconcern-snapshot>`
- :ref:`read concern "majority"<readconcern-majority>` and the
:ref:`afterClusterTime<afterClusterTime>` option is set
- When using a `MongoDB Driver <https://docs.mongodb.com/drivers/?tck=docs_server>`_
and :ref:`read concern "majority"<readconcern-majority>`
within a :ref:`causally consistent session<sessions>`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update these to use the :readconcern: links instead of refs

@@ -10,6 +10,8 @@ Read Concern ``"majority"``
:depth: 1
:class: singlecol

.. _readconcern-majority:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to add these refs. .. readconcern:: "majority" you can already point to this place in the docs by using:

:readconcern:`"majority"`

- :ref:`read concern "snapshot"<readconcern-snapshot>`
- :ref:`read concern "majority"<readconcern-majority>` and the
:ref:`afterClusterTime<afterClusterTime>` option is set
- When using a `MongoDB Driver <https://docs.mongodb.com/drivers/?tck=docs_server>`_
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can do:

:driver:`MongoDB Driver </>`

This is defined in the snooty rst spec: https://github.com/mongodb/snooty-parser/blob/master/snooty/rstspec.toml

@@ -0,0 +1,10 @@
Starting in MongoDB 5.0, non-transaction reads are not allowed on
:ref:`config.transactions<config.transactions>`
with the following read concerns and considerations:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[minor] "options" may be better than "considerations" here

@ianf-mongodb ianf-mongodb force-pushed the DOCS-14433-Non-transactional-reads-on-config-transaction-collection branch 3 times, most recently from 00e54e4 to be8a379 Compare September 2, 2021 13:09
@@ -524,6 +526,8 @@ instance.
the ``system.sessions`` collection into at least 1024 chunks and
distributes the chunks uniformly across shards in the cluster.

.. _config.transactions:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed on latest commit.

@ianf-mongodb ianf-mongodb force-pushed the DOCS-14433-Non-transactional-reads-on-config-transaction-collection branch from be8a379 to 1bb91a0 Compare September 2, 2021 14:49
@jeff-allen-mongo jeff-allen-mongo merged commit 635b322 into mongodb:master Sep 2, 2021
mongo-cr-bot pushed a commit that referenced this pull request Jan 9, 2024
* DOCSP-35317 5.0.24 Release Notes

* *

* fix affected versions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants