DOCSP-49150: bulkWrite docs + api #250

Name	Link
🔨 Latest commit	`7166329`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-php-library/deploys/682e2e177303920008308cc9
😎 Deploy Preview	https://deploy-preview-250--docs-php-library.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 project configuration.

source/reference/class/MongoDBBulkWriteCommandResult.txt

source/write/bulk-write.txt

GromNaN · 2025-05-20T14:38:37Z

source/write/bulk-write.txt

+- :ref:`Collection <php-coll-bulk-write>`: You can use the 
+  ``MongoDB\Collection::bulkWrite()`` method to perform bulk write
+  operations on a single collection. This method makes a database call
+  for each type of write operation. For example, the method can perform
+  multiple update operations in one call, but makes two separate calls to
+  the database for an insert operation and a replace operation.


Today I learned that collection bulk write is a driver implementation only to batch individual commands. Confirmed by the spec.

source/reference/method/MongoDBClient-bulkWrite.txt

source/reference/class/MongoDBClientBulkWrite.txt

source/reference/method/MongoDBClient-bulkWrite.txt

source/reference/method/MongoDBClientBulkWrite-withCollection.txt

composer/composer.json

source/reference/class/MongoDBClientBulkWrite.txt

source/reference/method/MongoDBClientBulkWrite-createWithCollection.txt

source/reference/method/MongoDBClientBulkWrite-updateOne.txt

source/whats-new.txt

source/reference/method/MongoDBClientBulkWrite-withCollection.txt

GromNaN

What a massive piece of work, well done.

norareidy

amazing work!! I mostly suggested small updates but I'll take another look because of the question I left

norareidy · 2025-05-21T17:21:29Z

source/includes/extracts-bulkwriteexception.yaml

+  <mongodb-driver-exception-bulkwritecommandexception>` is thrown, users should call
+  :php:`getWriteErrors() <mongodb-driver-bulkwritecommandexception.getwriteerrors>` and


S: second person / present tense; although it seems like a lot of these use "users" so that change is not necessary

Suggested change

<mongodb-driver-exception-bulkwritecommandexception>` is thrown, users should call

:php:`getWriteErrors() <mongodb-driver-bulkwritecommandexception.getwriteerrors>` and

<mongodb-driver-exception-bulkwritecommandexception>` is thrown, you can call

:php:`getWriteErrors() <mongodb-driver-bulkwritecommandexception.getwriteerrors>` and

Can change in all extracts, nbd

norareidy · 2025-05-21T17:23:22Z

source/reference/class/MongoDBBulkWriteCommandResult.txt

+
+.. phpclass:: MongoDB\BulkWriteCommandResult
+
+   This class contains information about an executed client bulk write operation. It


S: to avoid "execute":

Suggested change

This class contains information about an executed client bulk write operation. It

This class contains information about a completed client bulk write operation. It

norareidy · 2025-05-21T17:26:56Z

source/reference/class/MongoDBBulkWriteCommandResult.txt

+     - | Returns a boolean indicating whether the bulk operation was
+         acknowledged by the server.


s: active voice

Suggested change

- | Returns a boolean indicating whether the bulk operation was

acknowledged by the server.

- | Returns a boolean indicating whether the server acknowledged the bulk operation.

norareidy · 2025-05-21T17:28:59Z

source/reference/method/MongoDBClient-bulkWrite.txt

+
+  Represents the assembled bulk write command or builder.
+  :phpmethod:`MongoDB\Client::bulkWrite()` supports
+  ``deleteMany``, ``deleteOne()``, ``insertOne()``,


S:

Suggested change

``deleteMany``, ``deleteOne()``, ``insertOne()``,

``deleteMany()``, ``deleteOne()``, ``insertOne()``,

norareidy · 2025-05-21T17:39:27Z

source/reference/method/MongoDBClientBulkWrite-createWithCollection.txt

+       - If ``true``, allows the write operation to circumvent document level
+         validation. Defaults to ``false``.


S: to match the format of the other entries

Suggested change

- If ``true``, allows the write operation to circumvent document level

validation. Defaults to ``false``.

- If ``true``: Allows the write operation to circumvent document level

validation.

The default is ``false``.

norareidy · 2025-05-21T18:51:09Z

source/write/bulk-write.txt

+To delete multiple documents, call the ``deleteMany()`` method. The specified
+operation deletes *all documents* that match the query filter.
+
+The following example specifies deletion of all matching documents in the 


S:

Suggested change

The following example specifies deletion of all matching documents in the

The following example specifies a deletion of all matching documents in the

changed to the deletion

norareidy · 2025-05-21T18:51:25Z

source/write/bulk-write.txt

+instance of the ``ClientBulkWrite`` class, then call the ``deleteOne()``
+method.
+
+The following example specifies deletion of a document in the 


S:

Suggested change

The following example specifies deletion of a document in the

The following example specifies a deletion of a document in the

norareidy · 2025-05-21T18:56:09Z

source/write/bulk-write.txt

+operation deletes *all documents* that match the query filter.
+
+The following example specifies deletion of all matching documents in the 
+``sample_restaurants.restaurants`` collection:


S: might be worth explaining which documents this code is actually matching, since it's not immediately clear from the regex what's going on - like "all documents in the collection that have a name value containing at least two 'p' characters"

I'll add descriptions to all of these examples!

norareidy · 2025-05-21T18:58:09Z

source/write/bulk-write.txt

+         performing the remaining writes and throws an exception.
+       | If set to ``false``: when a single write fails, the operation continues to
+         attempt the remaining write operations, if any, then throws an exception.


S: to avoid "throws"

Suggested change

performing the remaining writes and throws an exception.

| If set to ``false``: when a single write fails, the operation continues to

attempt the remaining write operations, if any, then throws an exception.

performing the remaining writes and generates an exception.

| If set to ``false``: when a single write fails, the operation continues to

attempt the remaining write operations, if any, then generates an exception.

"throw" is a PHP keyword. It has a specific meaning in this context.

changed to returns

Just saw this - will revert

norareidy · 2025-05-21T19:01:20Z

source/write/bulk-write.txt

+If the library runs the insert operation first, one document is deleted.
+If it runs the delete operation first, no documents are deleted. 


Q: which insert and delete operation are you referring to here? do you just mean any insert and delete where the delete operation targets that inserted document?

This might be a copypaste issue - I will remove

I changed the note in this section to describe the same situation

norareidy

LGTM!

* DOCSP-44581: v2 release (#234) * DOCSP-44581: v2 release * small fix * Add missing meta descriptions (#235) * Add missing meta descriptions * Apply suggestions from code review --------- Co-authored-by: Rachel Mackintosh <[email protected]> * DOCSP-48761: docker note (#237) * DOCSP-48100: Consolidate minor versions (#240) * DOCSP-48100: Consolidate minor versions * edits * remove old redirects * AB feedback * edit * DOCSP-48718-update-credentials (#247) * update username and password * misspelling * redirects * pre-standardization redirects * upgrade composer package vs * DOCSP-49150: bulkWrite docs + api (#250) * DOCSP-49150: bulkWrite docs + api * first pass fixes * JT PR fixes 1 * upgrade composer package vs * JT PR fixes 2 * small fix * JT PR fixes 3 * remove reference to writeconcern option * add return values sections * object -> instance * NR PR fixes 1 * returns -> throws * DOCSP-50022: remove eol server version mentions (#253) * DOCSP-50022: remove eol server version mentions * consolidate compat table rows * DOCSP-50155 - EOL MongoDB 4.0 (#252) * eol v4.0 * update compat * DOCSP-50294: v2.1 release (#255) --------- Co-authored-by: Nick Larew <[email protected]> Co-authored-by: Rachel Mackintosh <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> Co-authored-by: Mike Woofter <[email protected]>

DOCSP-49150: bulkWrite docs + api

063a59b

first pass fixes

e634bc8

rustagir requested a review from GromNaN May 20, 2025 13:28

GromNaN requested changes May 20, 2025

View reviewed changes

JT PR fixes 1

6a2ab7a

rustagir requested a review from GromNaN May 20, 2025 15:37

GromNaN reviewed May 20, 2025

View reviewed changes

rustagir added 3 commits May 20, 2025 15:41

upgrade composer package vs

5cbb508

JT PR fixes 2

d14ca58

small fix

a29dfde

GromNaN reviewed May 21, 2025

View reviewed changes

rustagir mentioned this pull request May 21, 2025

DOCSP-47058: Shift TOC #251

Merged

7 tasks

rustagir and others added 3 commits May 21, 2025 09:56

JT PR fixes 3

6d3217e

remove reference to writeconcern option

5b07d53

Merge branch 'master' into DOCSP-49150-client-bulk-write

5ae84b8

rustagir requested a review from GromNaN May 21, 2025 14:00

GromNaN reviewed May 21, 2025

View reviewed changes

source/reference/method/MongoDBClientBulkWrite-withCollection.txt Show resolved Hide resolved

rustagir added 2 commits May 21, 2025 10:42

add return values sections

1b2d7e0

object -> instance

b4005d9

rustagir requested a review from GromNaN May 21, 2025 14:44

GromNaN approved these changes May 21, 2025

View reviewed changes

norareidy requested changes May 21, 2025

View reviewed changes

NR PR fixes 1

f25264d

rustagir requested a review from norareidy May 21, 2025 19:46

returns -> throws

7166329

norareidy approved these changes May 21, 2025

View reviewed changes

rustagir merged commit c614e24 into mongodb:master May 21, 2025
6 of 8 checks passed

		<mongodb-driver-exception-bulkwritecommandexception>` is thrown, users should call
		:php:`getWriteErrors() <mongodb-driver-bulkwritecommandexception.getwriteerrors>` and


		.. phpclass:: MongoDB\BulkWriteCommandResult

		This class contains information about an executed client bulk write operation. It

	This class contains information about an executed client bulk write operation. It
	This class contains information about a completed client bulk write operation. It

		- \| Returns a boolean indicating whether the bulk operation was
		acknowledged by the server.

	``deleteMany``, ``deleteOne()``, ``insertOne()``,
	``deleteMany()``, ``deleteOne()``, ``insertOne()``,

		- If ``true``, allows the write operation to circumvent document level
		validation. Defaults to ``false``.

	The following example specifies deletion of all matching documents in the
	The following example specifies a deletion of all matching documents in the

		If the library runs the insert operation first, one document is deleted.
		If it runs the delete operation first, no documents are deleted.

DOCSP-49150: bulkWrite docs + api #250

DOCSP-49150: bulkWrite docs + api #250

Uh oh!

Conversation

rustagir commented May 20, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-php-library ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

rustagir commented May 20, 2025 •

edited by github-actions bot

Loading

netlify bot commented May 20, 2025 •

edited

Loading