Skip to content

DOCSP-46772: sort option for client bw - updateone & replaceone #621

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Mar 3, 2025
Merged

DOCSP-46772: sort option for client bw - updateone & replaceone #621

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
344eb73
DOCSP-46772: sort option for client bw - updateone & replaceone
rustagir Feb 20, 2025
6818060
MW PR fixes 1
rustagir Feb 21, 2025
0aa6107
move into sharedinclude
rustagir Feb 26, 2025
95e1427
small fix
rustagir Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 66 additions & 78 deletions source/crud/write-operations/bulk.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Example
The following example creates an ``InsertOneModel`` for two documents
describing people:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin insertDocumentsExample
Expand All @@ -111,7 +111,7 @@ describing people:
The following example tries to insert two documents where the ``_id`` is
``1`` and ``3``:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin insertExceptionExample
Expand Down Expand Up @@ -156,7 +156,7 @@ The following example creates a ``ReplaceOneModel`` to
replace a document where the ``_id`` is ``1`` with a document that
contains an added ``location`` field:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin replaceDocumentsExample
Expand Down Expand Up @@ -207,7 +207,7 @@ Example
The following example creates an ``UpdateOneModel`` to update
the ``age`` field in a document where the ``_id`` is ``2``:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin updateDocumentsExample
Expand Down Expand Up @@ -260,7 +260,7 @@ Example
The following example creates a ``DeleteOneModel`` to delete
a document where the ``_id`` is ``1``:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin deleteDocumentsExample
Expand Down Expand Up @@ -301,7 +301,7 @@ The following example performs these bulk operations:
changes the ``name`` to ``"Zaynab Hassan"``
- An operation that deletes all documents where the ``age`` value is greater than ``50``

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin bulkWriteExample
Expand All @@ -328,7 +328,7 @@ the bulk operation reports them at the end.
Adding to the preceding example, including the following specifies the bulk
operations to execute in any order:

.. literalinclude:: /includes/fundamentals/code-snippets/BulkWrite.java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/BulkWrite.java
:language: java
:dedent:
:start-after: begin bulkWriteNotOrderedExample
Expand Down Expand Up @@ -479,6 +479,8 @@ see the following API documentation:
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/bulk/ClientNamespacedWriteModel.html>`__
- `MongoNamespace <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoNamespace.html>`__

.. _java-sync-client-bulk-write-insert:

Insert Example
~~~~~~~~~~~~~~

Expand All @@ -488,63 +490,77 @@ the other document is inserted into the ``db.things`` collection.
The ``MongoNamespace`` instance defines the databases and collections that
each write operation applies to.

.. code-block:: java
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/ClientBulkWrite.java
:language: java
:dedent:
:start-after: start-insert-models
:end-before: end-insert-models

MongoNamespace peopleNamespace = new MongoNamespace("db", "people");
MongoNamespace thingsNamespace = new MongoNamespace("db", "things");
.. _java-sync-client-bulk-write-update:

List<ClientNamespacedWriteModel> bulkOperations = new ArrayList<>();
Update Example
~~~~~~~~~~~~~~

bulkOperations.add(ClientNamespacedWriteModel
.insertOne(
peopleNamespace,
new Document("name", "Julia Smith")
)
);
The following example shows how to use the ``bulkWrite()`` method to update
existing documents in the ``db.people`` and ``db.things`` collections:

bulkOperations.add(ClientNamespacedWriteModel
.insertOne(
thingsNamespace,
new Document("object", "washing machine")
)
);
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/ClientBulkWrite.java
:language: java
:dedent:
:start-after: start-update-models
:end-before: end-update-models

ClientBulkWriteResult result = mongoClient.bulkWrite(bulkOperations);
This example increments the value of the ``age`` field by ``1`` in the
document that has a ``name`` value of ``"Freya Polk"`` in the ``people``
collection. It also sets the value of the ``manufacturer`` field to
``"Premium Technologies"`` in all documents that have a ``category``
value of ``"electronic"`` in the ``things`` collection.

Replace Example
~~~~~~~~~~~~~~~

The following example shows how to use the ``bulkWrite()`` method to replace
existing documents in the ``db.people`` and ``db.things`` collections.
If multiple documents match the query filter specified in
a ``ClientNamespacedUpdateOneModel`` instance, the operation updates the
first result. You can specify a sort order in a `ClientUpdateOneOptions
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/bulk/ClientUpdateOneOptions.html>`__
instance to apply an order to matched documents before the driver
performs the update operation, as shown in the following code:

.. code-block:: java

MongoNamespace peopleNamespace = new MongoNamespace("db", "people");
MongoNamespace thingsNamespace = new MongoNamespace("db", "things");
ClientUpdateOneOptions options = ClientUpdateOneOptions
.clientUpdateOneOptions()
.sort(Sorts.ascending("_id"));

List<ClientNamespacedWriteModel> bulkOperations = new ArrayList<>();
.. _java-sync-client-bulk-write-replace:

bulkOperations.add(ClientNamespacedWriteModel.replaceOne(
peopleNamespace,
Filters.eq("_id", 1),
new Document("name", "Frederic Hilbert")
)
);
Replace Example
~~~~~~~~~~~~~~~

bulkOperations.add(ClientNamespacedWriteModel.replaceOne(
thingsNamespace,
Filters.eq("_id", 1),
new Document("object", "potato")
)
);
The following example shows how to use the ``bulkWrite()`` method to replace
existing documents in the ``db.people`` and ``db.things`` collections:

ClientBulkWriteResult result = mongoClient.bulkWrite(bulkOperations);
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/ClientBulkWrite.java
:language: java
:dedent:
:start-after: start-replace-models
:end-before: end-replace-models

After this example runs successfully, the document that has an ``_id`` value of ``1``
in the ``people`` collection is replaced with a new document. The document in
the ``things`` collection that has an ``_id`` value of ``1``
is replaced with a new document.

If multiple documents match the query filter specified in
a ``ClientNamespacedReplaceOneModel`` instance, the operation replaces the
first result. You can specify a sort order in a `ClientReplaceOneOptions
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/bulk/ClientReplaceOneOptions.html>`__
instance to apply an order to matched documents before the driver
performs the replace operation, as shown in the following code:

.. code-block:: java

ClientReplaceOneOptions options = ClientReplaceOneOptions
.clientReplaceOneOptions()
.sort(Sorts.ascending("_id"));

.. _java-sync-client-bulk-write-options:

Bulk Write Options
Expand All @@ -568,39 +584,11 @@ The following code sets the ``ordered()`` method on an
instance of ``ClientBulkWriteOptions`` and performs a bulk write operation to
insert multiple documents.

.. code-block:: java

MongoNamespace namespace = new MongoNamespace("db", "people");

ClientBulkWriteOptions options = ClientBulkWriteOptions
.clientBulkWriteOptions()
.ordered(false);

List<ClientNamespacedWriteModel> bulkOperations = new ArrayList<>();

bulkOperations.add(
ClientNamespacedWriteModel.insertOne(
namespace,
new Document("_id", 1).append("name", "Rudra Suraj")
)
);

// Causes a duplicate key error
bulkOperations.add(
ClientNamespacedWriteModel.insertOne(
namespace,
new Document("_id", 1).append("name", "Mario Bianchi")
)
);

bulkOperations.add(
ClientNamespacedWriteModel.insertOne(
namespace,
new Document("name", "Wendy Zhang")
)
);

ClientBulkWriteResult result = mongoClient.bulkWrite(bulkOperations, options);
.. literalinclude:: /includes/fundamentals/code-snippets/bulk-write/ClientBulkWrite.java
:language: java
:dedent:
:start-after: start-order-exec
:end-before: end-order-exec

Even though the write operation inserting a document with a duplicate key results
in an error, the other operations are executed because the write operation is
Expand Down
0 ...fundamentals/code-snippets/BulkWrite.java → ...s/code-snippets/bulk-write/BulkWrite.java
View file
Open in desktop
File renamed without changes.
Loading
Loading