DOCSP-41769: Improved bulk write API #590
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-java ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rustagir
requested changes
Nov 12, 2024
rustagir
requested changes
Nov 14, 2024
…CSP-41769-improved-bulk-write
rustagir
approved these changes
Nov 14, 2024
mayaraman19
requested review from
a team and
katcharov
and removed request for
a team
stIncMale
reviewed
Nov 26, 2024
stIncMale
requested changes
Nov 26, 2024
|
Note that I have neither compiled nor run the examples. |
|
@mayaraman19 could you please not resolve discussions started by a reviewer, as it complicates the review process: the list of unresolved discussions represent the items the reviewer has to re-review, and by resolving them the PR author hides those items from the reviewer. It should be up to the reviewer to decide whether a concern raised by him is resolved. |
stIncMale
requested changes
Dec 6, 2024
|
@stIncMale Thanks for the feedback. I have unresolved comments that I initially resolved, if you want to take another look at those. |
|
😭 This resulted in even more confusion, because I have reviewed all of them, including the resolved ones. But now I will have to re-review them again.
stIncMale
reviewed
Dec 11, 2024
stIncMale
requested changes
Dec 11, 2024
stIncMale
approved these changes
Dec 12, 2024
mayaraman19
commented
Dec 13, 2024
Comment on lines
+22
to
+40
| To perform a single create, replace, update, or delete operation, you can use | ||
| the corresponding method. For example, to insert one document and replace one | ||
| document, you can use the ``insertOne()`` and ``replaceOne()`` methods. In this | ||
| case, the ``MongoClient`` makes a call to the database for each operation. | ||
|
|
||
| Generally, you can reduce the number of calls to the database by using bulk write | ||
| operations. You can perform bulk write operations at the following levels: | ||
|
|
||
| - :ref:`Collection Level <java-sync-coll-bulk-write>`: You can use the | ||
| ``MongoCollection.bulkWrite()`` method to perform bulk write operations on a | ||
| single collection. This method groups write operations together by the kind | ||
| of operation. For example, ``MongoCollection.bulkWrite()`` puts multiple update | ||
| operations in the same call, but makes two calls to the database for an insert | ||
| operation and a replace operation. | ||
|
|
||
| - :ref:`Client Level <java-sync-client-bulk-write>`: When running {+mdb-server+} | ||
| version 8.0 or later, you can use the ``MongoClient.bulkWrite()`` method to perform | ||
| bulk write operations on multiple collections and databases in the same cluster. | ||
| This method groups multiple kinds of write operations into one call. |
There was a problem hiding this comment.
Re-review here
mayaraman19
commented
Dec 13, 2024
Comment on lines
+47
to
+57
| Bulk operations consist of many write operations. To perform a bulk operation | ||
| at the collection level, pass a ``List`` of ``WriteModel`` documents to the | ||
| ``MongoCollection.bulkWrite()`` method. A ``WriteModel`` is a model that | ||
| represents any of the write operations. | ||
|
|
||
| The ``MongoCollection.bulkWrite()`` method splits operations of different kinds into | ||
| different batches. For example, when you pass ``DeleteOneModel``, | ||
| ``DeleteManyModel``, and ``ReplaceOneModel`` operations to the method, the method | ||
| splits the delete operations into one batch and the replace operation | ||
| into another. During this process, the client might reorder operations for | ||
| efficiency if the bulk operation is not ordered. |
There was a problem hiding this comment.
Re-review here
mayaraman19
commented
Dec 13, 2024
Comment on lines
+324
to
+366
| When connecting to a deployment running {+mdb-server+} 8.0 or later, | ||
| you can use the ``MongoClient.bulkWrite()`` method to write | ||
| to multiple databases and collections in the same cluster. The ``MongoClient.bulkWrite()`` | ||
| method does not split different kinds of operations into different batches. | ||
|
|
||
| In the examples in preceding sections of this page, the ``MongoCollection.bulkWrite()`` method | ||
| takes a list of ``WriteModel`` instances in which the specified subclass of | ||
| ``WriteModel`` represents the corresponding write operation. For example, an | ||
| instance of ``InsertOneModel`` represents an operation to insert one document. | ||
|
|
||
| Similarly, the ``MongoClient.bulkWrite()`` method takes a | ||
| list of ``ClientNamespacedWriteModel`` instances to represent different write operations. | ||
| For example, an instance of ``ClientNamespacedInsertOneModel`` represents an | ||
| operation to insert one document. | ||
|
|
||
| You can construct instances of ``ClientNamespacedWriteModel`` using the following | ||
| methods: | ||
|
|
||
| - ``insertOne()`` | ||
|
|
||
| - ``updateOne()`` | ||
|
|
||
| - ``updateMany()`` | ||
|
|
||
| - ``replaceOne()`` | ||
|
|
||
| - ``deleteOne()`` | ||
|
|
||
| - ``deleteMany()`` | ||
|
|
||
| These methods are used to construct corresponding write models. | ||
| For example, ``ClientNamespacedWriteModel.updateOne()`` is used to | ||
| construct a ``ClientNamespacedUpdateOneModel`` instance, which represents an | ||
| update operation. | ||
|
|
||
| These methods take a ``MongoNamespace`` object that defines which | ||
| database and collection to write to. Some, such as ``insertOne()``, can take a | ||
| ``Document`` instance that defines information about the write operation. | ||
| Some other methods, such as ``updateOne()`` and ``replaceOne()``, take a filter | ||
| object that defines the subset of documents to be updated or replaced. | ||
|
|
||
| The following sections provide examples of how to use the client ``bulkWrite()`` | ||
| method. |
There was a problem hiding this comment.
Re-review here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - DOCSP-41769
Staging:
Self-Review Checklist