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

DOCSP-47834 clarify batch size #524

Merged
merged 6 commits into from
Mar 25, 2025

Conversation

shuangela
Copy link
Collaborator

@shuangela shuangela commented Mar 17, 2025

Pull Request Info

PR Reviewing Guidelines

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

Staging Links

  • fundamentals/crud/read-operations/change-streams
  • fundamentals/crud/read-operations/retrieve
  • 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?

    Copy link

    netlify bot commented Mar 17, 2025

    Deploy Preview for docs-csharp ready!

    Name Link
    🔨 Latest commit bd6f958
    🔍 Latest deploy log https://app.netlify.com/sites/docs-csharp/deploys/67e1ac58dbcaa30008fab554
    😎 Deploy Preview https://deploy-preview-524--docs-csharp.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 site configuration.

    Copy link
    Collaborator

    @jordan-smith721 jordan-smith721 left a comment

    Choose a reason for hiding this comment

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

    LGTM!

    batch size of ``101`` documents and a maximum size of 16
    mebibytes (MiB) for each subsequent batch. This option can
    enforce a smaller limit than 16 MiB, but not a larger one. If
    you set ``batchSize`` to a limit that results in batches
    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
    you set ``batchSize`` to a limit that results in batches
    you set ``batchSize`` to a limit that results in batches

    @shuangela shuangela requested review from a team and JamesKovacs and removed request for a team March 17, 2025 17:20
    * - ``batchSize``
    - | Specifies the maximum number of documents that a change
    stream can return in each batch, which applies to ``Watch()`` or
    ``WatchAsync()``. By default, watch functions have an initial
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    We should clarify what "By default" means: that batchSize is optional and if batchSize parameter is not set watch function have...
    Otherwise it might sound like the default is batchSize == 101 in the option objects.

    Copy link
    Collaborator Author

    Choose a reason for hiding this comment

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

    The lead in text to the table states that all these options are optional, and I added a clarification on what "by default" means on both this page and the other page I edited!

    @shuangela shuangela requested a review from BorisDog March 24, 2025 19:02
    Copy link
    Collaborator

    @BorisDog BorisDog left a comment

    Choose a reason for hiding this comment

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

    LGTM!

    @shuangela shuangela merged commit 9d38c02 into mongodb:master Mar 25, 2025
    6 checks passed
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    shuangela added a commit that referenced this pull request Mar 25, 2025
    * clarify batch size
    
    * change find
    
    * clarify no effect
    
    * fix wrapping
    
    * remove extra space
    
    * review
    
    (cherry picked from commit 9d38c02)
    
    Co-authored-by: shuangela <[email protected]>
    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.

    3 participants