DOCSP-46818: Client bulk write #474

norareidy · 2025-03-11T21:18:16Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-46818
Staging - https://deploy-preview-474--docs-golang.netlify.app/fundamentals/crud/write-operations/bulk/

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 the facets and meta keywords accurate?
Are all the links working?

netlify · 2025-03-11T21:18:33Z

✅ Deploy Preview for docs-golang ready!

Name	Link
🔨 Latest commit	`c9e1022`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-golang/deploys/67ea9cd7c7fc3700084ce20d
😎 Deploy Preview	https://deploy-preview-474--docs-golang.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

rustagir

As I was reviewing I noticed that you have organized this page into functions instead of APIs. Personally, I found it more difficult to move through sections, then find my specific API of interest as opposed to organizing them into two separate sections as we do here . Happy to talk more about how to best organize the page but I think it is confusing to stack the collection/client info in each section

rustagir · 2025-03-13T14:22:07Z

source/fundamentals/crud/write-operations/bulk.txt

+multiple namespaces. In MongoDB, a namespace consists of the database name and the collection
+name in the format ``<database>.<collection>``. 
+
+.. important::


S: add a title
"Client Bulk Write Compatibility"

rustagir

A few things but great work fixing up this page!

rustagir · 2025-03-14T14:00:56Z

source/fundamentals/crud/write-operations/bulk.txt

+method. When calling ``BulkWrite()`` on a ``Collection`` instance, you can
+perform multiple write operations on a single collection. When calling
+``BulkWrite()`` on a ``Client`` instance, you can perform bulk writes across
+multiple namespaces. In MongoDB, a namespace consists of the database name and the collection
+name in the format ``<database>.<collection>``. 


S: in the bulk write method the namespaces are not given in that format so I recommend removing to avoid confusion

Suggested change

method. When calling ``BulkWrite()`` on a ``Collection`` instance, you can

perform multiple write operations on a single collection. When calling

``BulkWrite()`` on a ``Client`` instance, you can perform bulk writes across

multiple namespaces. In MongoDB, a namespace consists of the database name and the collection

name in the format ``<database>.<collection>``.

method. You can use the ``Collection.BulkWrite()`` method to

perform multiple write operations on a single collection. When calling

the ``Collection.BulkWrite()`` method, you can perform bulk writes across

multiple namespaces. In MongoDB, a namespace consists of a database name and a collection name.

rustagir · 2025-03-14T14:02:00Z

source/fundamentals/crud/write-operations/bulk.txt

+   ensure that your application meets the following
+   requirements:
+
+   - Uses {+driver-short+} v2.1 or later 


S: remove this first pooint and combine into a sentence. This change will only be on the v2.1+ branch anyways so no need to explicitly include

rustagir · 2025-03-14T14:03:11Z

source/fundamentals/crud/write-operations/bulk.txt

-type, which represents options you can use to modify its behavior. If
-you don't specify a ``BulkWriteOptions``, the driver uses the default
-values for each option.
+Modify Collection-Level Behavior


S suggest moving the options and return value sections to the end of this section after the define write models section (applies to collection and client)

rustagir · 2025-03-14T14:03:49Z

source/fundamentals/crud/write-operations/bulk.txt

@@ -226,33 +248,36 @@ their behavior with the following methods:
   * - ``SetHint()`` 
     - | The index to use to scan for documents.

+   * - ``SetSort()`` 
+     - | The criteria to use when ordering matching documents.
+         This method is not available for the ``UpdateMnyModel``


Suggested change

This method is not available for the ``UpdateMnyModel``

This method is only available for the ``UpdateOneModel``

rustagir · 2025-03-14T14:05:15Z

source/fundamentals/crud/write-operations/bulk.txt

+
+To specify the write operations for your bulk operation on multiple
+namespaces, create a ``ClientWriteModel`` for each insert,
+replace, update, or delete.


S: add a sentence describing how the first two parameters for each model supply the target namespace

rustagir · 2025-03-14T14:05:57Z

source/fundamentals/crud/write-operations/bulk.txt

+   :dedent:
+   :start-after: begin bulk update model client
+   :end-before: end bulk update model client
+


S: add a note that describes updatemany model as an option to update all matching documents

rustagir · 2025-03-14T14:06:19Z

source/fundamentals/crud/write-operations/bulk.txt

@@ -390,13 +734,21 @@ API Documentation
 To learn more about any of the methods or types discussed in this
 guide, see the following API Documentation:

- `BulkWrite() <{+api+}/mongo#Collection.BulkWrite>`__


S: consider sorting this into two lists as done on the kotlin sync page

…t-bulk-write

rustagir

great work! just left a comment about a bug but lgtm

rustagir · 2025-03-17T16:55:59Z

source/whats-new.txt

+<<<<<<< HEAD
+* :ref:`Version 2.1 <golang-version-2.0>`
+=======
 * :ref:`Version 2.1 <golang-version-2.1>`
+>>>>>>> upstream/master


S: I believe there's a merge error still in the PR

qingyang-hu · 2025-03-17T20:03:55Z

source/fundamentals/crud/write-operations/bulk.txt

+To modify the behavior of your bulk write operation, pass a ``BulkWriteOptions``
+instance to the ``BulkWrite()`` method.
+
+The ``BulkWriteOptions`` type allows you to configure options by using the


Do we need to add SetComment() and SetLet()?

qingyang-hu · 2025-03-17T20:03:59Z

source/fundamentals/crud/write-operations/bulk.txt

-``BulkWriteResult`` type contains the following properties:
+includes information about the bulk operation.
+
+The ``BulkWriteResult`` type contains the following properties:


Do we need to add the Acknowledged property?

jtazin · 2025-03-17T20:39:07Z

source/fundamentals/crud/write-operations/bulk.txt

@@ -15,54 +15,243 @@ Bulk Operations
 Overview
 --------

-In this guide, you can learn how to use **bulk operations**.
+In this guide, you can learn how to use {+driver-short+} to


Suggested change

In this guide, you can learn how to use {+driver-short+} to

In this guide, you can learn how to use {+driver-long+} to

Probably best to use the full name (MongoDB Go Driver) since this is the first occurrence

qingyang-hu · 2025-03-18T13:47:23Z

source/fundamentals/crud/write-operations/bulk.txt

+     - | Specifies a document with a list of values to improve operation readability. Values
+         must be constant or closed expressions that don't reference document fields. For more
+         information, see the :manual:`let statement
+         </reference/command/delete/#std-label-delete-let-syntax>` in the {+mdb-server+} manual.


Do we need to mention the </reference/command/update/#std-label-update-let-syntax> as well?
Also, do we need to somehow align this section with the SetLet in the "Client-Level Behavior" underneath?

Since the description of the let statement is the same on the delete and update page, I don't think we need to link to both. I can remove the link if you think that's confusing. And yes I'll make sure the two definitions align, thanks for catching that.

👍 IMO, a link to a generic reference is not necessary for the Golang-specific doc, neither the delete nor the update. Moreover, listing the delete syntax alone causes a feeling like it's for the delete operation only. However, I'm OK with either keeping the "delete-let-syntax" link or removing it. @jtazin, what are your thoughts?

Yeah, I agree that it could be confusing to link to one and not the other. It sounds like it would be best to either have both or none.
I do like having links for more information, especially since "let" doesn't seem obvious to me.
The Server bulk write documentation includes both. To bad there isn't a way to link directly to the "let" on this page. Perhaps we can copy what we do?
Either way, I don't feel too strongly about this one.
@norareidy and @qingyang-hu let me know if you have additional thoughts.

Okay, I added links to both the delete and update pages.

* DOCSP-46818: Client bulk write * rest of page * edits * RR feedback * edit * fix * edits * RR feedback 2 * edits * whats new * link * wording * fix merge error * tech review * QH feedback 2 * let links (cherry picked from commit e8c6de2)

DOCSP-46818: Client bulk write

dc573ed

norareidy added 2 commits March 12, 2025 17:17

rest of page

3ab04cc

edits

8356d31

rustagir requested changes Mar 13, 2025

View reviewed changes

norareidy added 4 commits March 13, 2025 15:29

RR feedback

0166114

edit

e9583f6

fix

5dd570e

edits

10b2565

norareidy requested a review from rustagir March 13, 2025 20:01

rustagir requested changes Mar 14, 2025

View reviewed changes

norareidy added 6 commits March 14, 2025 15:32

RR feedback 2

559fef2

edits

ff3c3e2

whats new

51a35d1

Merge remote-tracking branch 'upstream/master' into DOCSP-46818-clien…

a18e014

…t-bulk-write

link

0b8a0e8

wording

fd73034

norareidy requested a review from rustagir March 14, 2025 19:56

rustagir approved these changes Mar 17, 2025

View reviewed changes

fix merge error

ffa48a0

norareidy requested review from a team and qingyang-hu and removed request for a team March 17, 2025 17:14

qingyang-hu reviewed Mar 17, 2025

View reviewed changes

jtazin reviewed Mar 17, 2025

View reviewed changes

tech review

c4b0bed

qingyang-hu reviewed Mar 18, 2025

View reviewed changes

norareidy requested a review from qingyang-hu March 18, 2025 13:50

QH feedback 2

7cb6502

norareidy requested a review from jtazin March 20, 2025 14:55

qingyang-hu approved these changes Mar 28, 2025

View reviewed changes

let links

c9e1022

norareidy merged commit e8c6de2 into mongodb:master Mar 31, 2025
5 checks passed

norareidy deleted the DOCSP-46818-client-bulk-write branch March 31, 2025 14:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-46818: Client bulk write #474

DOCSP-46818: Client bulk write #474

norareidy commented Mar 11, 2025 •

edited

Loading

netlify bot commented Mar 11, 2025 •

edited

Loading

rustagir left a comment

rustagir Mar 13, 2025

rustagir left a comment

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir Mar 14, 2025

rustagir left a comment

rustagir Mar 17, 2025

qingyang-hu Mar 17, 2025

qingyang-hu Mar 17, 2025

norareidy Mar 17, 2025

jtazin Mar 17, 2025

qingyang-hu Mar 18, 2025

norareidy Mar 18, 2025

qingyang-hu Mar 18, 2025

jtazin Mar 30, 2025

norareidy Mar 31, 2025

	This method is not available for the ``UpdateMnyModel``
	This method is only available for the ``UpdateOneModel``

	In this guide, you can learn how to use {+driver-short+} to
	In this guide, you can learn how to use {+driver-long+} to

DOCSP-46818: Client bulk write #474

DOCSP-46818: Client bulk write #474

Conversation

norareidy commented Mar 11, 2025 • edited Loading

Pull Request Info

Self-Review Checklist

netlify bot commented Mar 11, 2025 • edited Loading

✅ Deploy Preview for docs-golang ready!

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

norareidy commented Mar 11, 2025 •

edited

Loading

netlify bot commented Mar 11, 2025 •

edited

Loading