Added WriteConcern as a param for dataset

[korbit-ai]

What changes are proposed in this pull request?

For Mongo write operations, WriteConcern is an argument that controls the process of write operations from the client side. Setting the value of w=0 for WriteConcern allows the client to terminate early without waiting for the rest of the clusters to confirm write operations.

For more information on WriteConcern: https://www.mongodb.com/docs/manual/reference/write-concern/

Similarly related, ReadConcern: https://www.mongodb.com/docs/manual/reference/read-concern/

How is this patch tested? If it is not, please explain why.

• Manual test (✅ )

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release
  notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

• App: FiftyOne application changes
• Build: Build and test infrastructure changes
• Core: Core fiftyone Python library changes
• Documentation: FiftyOne documentation changes
• Other

Summary by CodeRabbit

• New Features

  • Enhanced index creation with options for acknowledgment and completion wait, allowing users more control during index creation.
  • Improved handling of MongoDB write operations, providing greater flexibility in dataset management through customizable write concerns.

• Bug Fixes

  • Resolved issues related to collection statistics retrieval by ensuring consistent application of write concerns.

• Documentation

  • Updated method documentation to clarify the new parameters and their intended use.

Description by Korbit AI

What change is being made?

Added WriteConcern as a parameter to dataset collection methods to allow control over acknowledgment of write operations.

Why are these changes being made?

This change provides flexibility in managing write operations by allowing users to specify whether they want to wait for acknowledgment from the database, which can be useful for optimizing performance in scenarios where immediate acknowledgment is not necessary.

[korbit-ai]

Clone of the PR voxel51/fiftyone#4696

[korbit-ai]

My review is in progress 📖 - I will have feedback for you in a few minutes!

[coderabbitai]

Warning

Rate limit exceeded

@codiumai-pr-agent[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 27 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between da22e0f and 2eb4cb7.

Walkthrough

The changes introduce enhancements to the create_index method in fiftyone/core/collections.py by adding an acknowledged parameter for index creation acknowledgment. In fiftyone/core/dataset.py, a _write_concern attribute is added to the Dataset class, allowing for configurable write operations. Collection access methods are updated to support this new parameter, improving flexibility in database interactions.

Changes

File	Change Summary
fiftyone/core/collections.py	Added acknowledged parameter to create_index method, modifying its signature and documentation.
fiftyone/core/dataset.py	Introduced _write_concern attribute, updated collection-related methods to utilize this parameter for write operations.

Poem

In fields of data, hops so bright,
With changes spry, we take flight.
Acknowledge this, our new delight,
Write concerns in view, a joyful sight!
So gather ‘round, let’s celebrate,
A rabbit's leap to a better state! 🐰✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[korbit-ai]

I have reviewed your code and did not find any issues!

---

Please note that I can make mistakes, and you should still encourage your team to review your code as well.

[furwellness]

@coderabbitai full review

[coderabbitai]

Actions performed

Full review triggered.

[furwellness]

/review

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Potential Performance Impact The new acknowledged parameter in the create_index method allows for unacknowledged write operations when set to False. This could lead to potential data consistency issues if not used carefully. Code Duplication The _get_sample_collection and _get_frame_collection methods have very similar implementations. Consider refactoring to reduce duplication.