Skip to content

DOCSP-51321: Configure CRUD operations #113

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 3 commits into
base: comp-cov
Choose a base branch
from

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented Jul 9, 2025

Pull Request Info

PR Reviewing Guidelines

Note to reviewers: this page is very similar to the corresponding Java Sync page, which was approved by writing & dbx: mongodb/docs-java#649

JIRA - https://jira.mongodb.org/browse/DOCSP-51321

Staging Links

  • crud/configure
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?
    • Are the page titles greater than 20 characters long and SEO relevant?

    @norareidy norareidy requested a review from a team as a code owner July 9, 2025 18:38
    @norareidy norareidy requested review from stIncMale and removed request for a team July 9, 2025 18:38
    Copy link

    netlify bot commented Jul 9, 2025

    Deploy Preview for docs-kotlin-sync ready!

    Name Link
    🔨 Latest commit 4f146ee
    🔍 Latest deploy log https://app.netlify.com/projects/docs-kotlin-sync/deploys/686eda97e0b0cc000865473c
    😎 Deploy Preview https://deploy-preview-113--docs-kotlin-sync.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify project configuration.

    @docs-builder-bot
    Copy link

    docs-builder-bot commented Jul 9, 2025

    🔄 Deploy Preview for docs-kotlin-sync processing

    Item Details
    🔨 Latest Commit 3d993465fa64106b0415c1494cc68d66c1ea09e3
    😎 Deploy Preview https://deploy-preview-113--docs-kotlin-sync.netlify.app
    🔍 Build Logs View Logs

    Copy link
    Collaborator

    @mongoKart mongoKart left a comment

    Choose a reason for hiding this comment

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

    LGTM w/ some small suggestions

    Comment on lines +73 to +79
    secondary replica set members.
    - ``LOCAL`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``W2`` write concern: The primary replica set member and one secondary member
    must acknowledge the write operation.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    No periods needed

    Suggested change
    - ``secondary`` read preference: Read operations retrieve data from
    secondary replica set members.
    - ``LOCAL`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``W2`` write concern: The primary replica set member and one secondary member
    must acknowledge the write operation.
    - ``secondary`` read preference: Read operations retrieve data from
    secondary replica set members
    - ``LOCAL`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members
    - ``W2`` write concern: The primary replica set member and one secondary member
    must acknowledge the write operation

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    I think since these are full sentences, they should have periods - https://www.mongodb.com/docs/meta/style-guide/style/lists/#list-items

    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    good call

    Comment on lines +115 to +120
    the primary replica set member.
    - ``MAJORITY`` read concern: Read operations return the instance's most recent data
    that has been written to a majority of replica set members.
    - ``W1`` write concern: The primary replica set member must acknowledge the
    write operation.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    No periods needed

    Suggested change
    - ``primary`` read preference: Read operations retrieve data from
    the primary replica set member.
    - ``MAJORITY`` read concern: Read operations return the instance's most recent data
    that has been written to a majority of replica set members.
    - ``W1`` write concern: The primary replica set member must acknowledge the
    write operation.
    - ``primary`` read preference: Read operations retrieve data from
    the primary replica set member
    - ``MAJORITY`` read concern: Read operations return the instance's most recent data
    that has been written to a majority of replica set members
    - ``W1`` write concern: The primary replica set member must acknowledge the
    write operation

    Comment on lines +138 to +144
    the primary replica set member, or secondary members if the primary is unavailable.
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``MAJORITY`` write concern: The majority of all replica set members
    must acknowledge the write operation.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    No periods needed

    Suggested change
    - ``primaryPreferred`` read preference: Read operations retrieve data from
    the primary replica set member, or secondary members if the primary is unavailable.
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``MAJORITY`` write concern: The majority of all replica set members
    must acknowledge the write operation.
    - ``primaryPreferred`` read preference: Read operations retrieve data from
    the primary replica set member, or secondary members if the primary is unavailable
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members
    - ``MAJORITY`` write concern: The majority of all replica set members
    must acknowledge the write operation

    Comment on lines +162 to +169
    secondary replica set members, or the primary members if no secondary members are
    available.
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``UNACKNOWLEDGED`` write concern: Replica set members do not need to acknowledge
    the write operation.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    - ``secondaryPreferred`` read preference: Read operations retrieve data from
    secondary replica set members, or the primary members if no secondary members are
    available.
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members.
    - ``UNACKNOWLEDGED`` write concern: Replica set members do not need to acknowledge
    the write operation.
    - ``secondaryPreferred`` read preference: Read operations retrieve data from
    secondary replica set members, or the primary members if no secondary members are
    available
    - ``AVAILABLE`` read concern: Read operations return the instance's most recent data
    without guaranteeing that the data has been written to a majority of the replica
    set members
    - ``UNACKNOWLEDGED`` write concern: Replica set members do not need to acknowledge
    the write operation

    Comment on lines +195 to +199
    - **Mongos**: A query router that provides an interface between your
    application and the sharded cluster.
    - **Config servers**: Servers that store the cluster's configuration settings
    and metadata.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    - **Shard**: A replica set that contains a subset of the sharded data.
    - **Mongos**: A query router that provides an interface between your
    application and the sharded cluster.
    - **Config servers**: Servers that store the cluster's configuration settings
    and metadata.
    - **Shard**: A replica set that contains a subset of the sharded data
    - **Mongos**: A query router that provides an interface between your
    application and the sharded cluster
    - **Config servers**: Servers that store the cluster's configuration settings
    and metadata

    any one server and ensures optimal performance.

    When connecting to a sharded cluster, the {+driver-short+} determines the closest mongos
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    When connecting to a sharded cluster, the {+driver-short+} determines the closest mongos
    When connecting to a sharded cluster, the {+driver-short+} determines the closest ``mongos``

    When connecting to a sharded cluster, the {+driver-short+} determines the closest mongos
    instance by calculating which one has the lowest network round-trip time. Then, the driver
    determines the latency window by adding this mongos's average round-trip time to the
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    determines the latency window by adding this mongos's average round-trip time to the
    determines the latency window by adding this ``mongos``'s average round-trip time to the

    determines the latency window by adding this mongos's average round-trip time to the
    :ref:`localThresholdMS value <kotlin-sync-local-threshold>`. The driver load balances requests
    across up to two random mongos instances that fall within the latency window. For each request,
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    across up to two random mongos instances that fall within the latency window. For each request,
    across up to two random ``mongos`` instances that fall within the latency window. For each request,

    that are eligible to receive read and write requests.

    By default, the driver uses only mongos instances or replica set members whose
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    By default, the driver uses only mongos instances or replica set members whose
    By default, the driver uses only ``mongos`` instances or replica set members whose

    .. note::

    When selecting replica set members from a single mongos instance, the
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Suggested change
    When selecting replica set members from a single mongos instance, the
    When selecting replica set members from a single ``mongos`` instance, the

    @stIncMale stIncMale requested review from nhachicha and removed request for stIncMale July 17, 2025 15:27
    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.

    3 participants