Skip to content

docs: update read preference values to match connection string syntax #293

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pmclain
Copy link

@pmclain pmclain commented Jul 14, 2025

Updated the list of available read preferences in the documentation from SDK-style constants (e.g., PRIMARY, PRIMARY_PREFERRED) to the actual connection string values (primary, primaryPreferred, etc.) for clarity and consistency with MongoDB's documented behavior: https://www.mongodb.com/docs/manual/core/read-preference-mechanics/#replica-set-read-preference-behavior

This ensures the documentation accurately reflects the expected values users must provide in connection strings.

Updated the list of available read preferences in the documentation from 
SDK-style constants (e.g., `PRIMARY`, `PRIMARY_PREFERRED`) to the actual 
connection string values (`primary`, `primaryPreferred`, etc.) for clarity 
and consistency with MongoDB's documented behavior: 
https://www.mongodb.com/docs/manual/core/read-preference-mechanics/#replica-set-read-preference-behavior

This ensures the documentation accurately reflects the expected values 
users must provide in connection strings.
Copy link
Contributor

@pmclain : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 09327f8:

✅ Validation status: passed

File Status Preview URL Details
articles/cosmos-db/mongodb/readpreference-global-distribution.md ✅Succeeded

For more details, please refer to the build report.

@v-dirichards
Copy link
Contributor

@gahl-levy

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged C+L Pull Request Review Team label label Jul 14, 2025
@seesharprun
Copy link
Contributor

#assign-reviewer:seesharprun

@prmerger-automator prmerger-automator bot requested a review from seesharprun July 17, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants