DOCSP-15952 BACKPORT (#1117)

Author: Dave Cuthbert

source/core/bulk-write-operations.txt

@@ -21,9 +21,10 @@ acknowledgement required for bulk write operations.
 .. versionadded:: 3.2
 
 The :method:`db.collection.bulkWrite()` method provides the ability to 
-perform bulk insert, update, and remove operations.
-MongoDB also supports bulk insert
-through the :method:`db.collection.insertMany()`.
+perform bulk insert, update, and delete operations.
+
+MongoDB also supports bulk insert through the 
+:method:`db.collection.insertMany()` method.
 
 Ordered vs Unordered Operations
 -------------------------------

source/reference/method.txt

@@ -656,17 +656,21 @@ Bulk Write Operation
 
      - Specifies the :ref:`collation <collation>` for the query condition.
 
+   * - :method:`Bulk.find.delete()`
+     - Adds a multiple document delete operation to a list of operations.
+
+   * - :method:`Bulk.find.deleteOne()`
+     - Adds a single document delete operation to a list of operations.
+
    * - :method:`Bulk.find.hint()`
 
      - Specifies the index to use for the update/replace operation.
 
    * - :method:`Bulk.find.remove()`
-
-     - Adds a multiple document remove operation to a list of operations.
+     - An alias for ``Bulk.find.delete()``.
 
    * - :method:`Bulk.find.removeOne()`
-
-     - Adds a single document remove operation to a list of operations.
+     - An alias for ``Bulk.find.deleteOne()``.
 
    * - :method:`Bulk.find.replaceOne()`
 
@@ -692,13 +696,11 @@ Bulk Write Operation
 
      - Adds an insert operation to a list of operations.
 
-   * - :method:`Bulk.tojson()`
-
+   * - :method:`Bulk.toJSON()`
      - Returns a JSON document that contains the number of operations and batches in the :method:`Bulk()` operations object.
 
    * - :method:`Bulk.toString()`
-
-     - Returns the :method:`Bulk.tojson()` results as a string.
+     - Returns the :method:`Bulk.toJSON()` results as a string.
 
 
 .. toctree::

source/reference/method/Bulk.find.delete.txt

@@ -0,0 +1,64 @@
+==================
+Bulk.find.delete()
+==================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+-----------
+
+.. method:: Bulk.find.delete()
+
+   Adds a multiple document delete operation to a bulk operations list.
+   Use the :method:`Bulk.find()` method to specify the condition that
+   determines which documents to remove. 
+   
+   ``Bulk.find.delete()`` deletes all matching documents. To remove the
+   first matching document, see :method:`Bulk.find.deleteOne()`.
+
+Syntax
+------
+
+The command has the following syntax:
+
+.. code-block:: javascript
+
+   Bulk.find( <filter document> ).delete()
+
+For details on the ``find()`` method see: :method:`Bulk.find()`
+
+Example
+-------
+
+Create the ``music`` collection:
+
+.. code-block:: javascript
+
+   db.music.insertMany( [
+      { artist: "DOA", genre: "punk" },
+      { artist: "Rick Astley", genre: "pop" },
+      { artist: "Black Flag", genre: "punk" },
+      { artist: "Justin Bieber", genre: "pop" }
+   ] )
+
+The following example:
+
+- Initializes a :method:`Bulk()` operations builder.
+- Searches for the genre ``pop``.
+- Deletes ``pop`` music from the collection. 
+
+.. code-block:: javascript
+
+   var bulk = db.music.initializeOrderedBulkOp();
+   bulk.find( { "genre": "pop" } ).delete();
+   bulk.execute()
+
+To delete only the first matching document, use
+:method:`Bulk.find.deleteOne()` instead.
+

source/reference/method/Bulk.find.deleteOne.txt

@@ -0,0 +1,64 @@
+=====================
+Bulk.find.deleteOne()
+=====================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+-----------
+
+.. method:: Bulk.find.deleteOne()
+
+   Adds a single document remove operation to a bulk operations list.
+   Use the :method:`Bulk.find()` method to specify the condition that
+   determines which document to remove. 
+   
+   ``Bulk.find.deleteOne()`` only deletes the first matching document.
+   To remove multiple documents, see :method:`Bulk.find.delete()`.
+
+Syntax
+------
+
+The command has the following syntax:
+
+.. code-block:: javascript
+
+   Bulk.find( <filter document> ).deleteOne()
+
+For details on the ``find()`` method see: :method:`Bulk.find()`
+
+Example
+-------
+
+Create the ``music`` collection:
+
+.. code-block:: javascript
+
+   db.music.insertMany( [
+      { artist: "DOA", genre: "punk" },
+      { artist: "Rick Astley", genre: "pop" },
+      { artist: "Black Flag", genre: "punk" },
+      { artist: "Justin Bieber", genre: "pop" }
+   ] )
+
+The following example:
+
+- Initializes a :method:`Bulk()` operations builder.
+- Searches for the genre ``pop``.
+- Deletes ``Rick Astley``, the first matching pop artist, from the
+  collection. 
+
+.. code-block:: javascript
+
+   var bulk = db.music.initializeOrderedBulkOp();
+   bulk.find( { "genre": "pop" } ).deleteOne();
+   bulk.execute()
+
+To delete all ``"pop"`` music, use :method:`Bulk.find.delete()` instead.
+

source/reference/method/Bulk.find.remove.txt

@@ -17,31 +17,35 @@ Description
 
 .. method:: Bulk.find.remove()
 
-   Adds a remove operation to a bulk operations list. Use the
-   :method:`Bulk.find()` method to specify the condition that
-   determines which documents to remove. The
-   :method:`Bulk.find.remove()` method removes all matching documents
-   in the collection. To limit the remove to a single document, see
-   :method:`Bulk.find.removeOne()`.
+   Starting in ``mongosh`` 0.12.2, ``Bulk.find.remove()`` is an alias
+   for :method:`Bulk.find.delete()`.
+
+   In new code, use ``Bulk.find.delete()`` instead of
+   ``Bulk.find.remove()``.
 
 Example
 -------
 
-The following example initializes a :method:`Bulk()` operations builder
-for the ``items`` collection and adds a remove operation to the list of
-operations. The remove operation removes all documents in the
-collection where the ``status`` equals ``"D"``:
+Create the ``music`` collection:
 
 .. code-block:: javascript
 
-   var bulk = db.items.initializeUnorderedBulkOp();
-   bulk.find( { status: "D" } ).remove();
-   bulk.execute();
+   db.music.insertMany( [
+      { artist: "DOA", genre: "punk" },
+      { artist: "Rick Astley", genre: "pop" },
+      { artist: "Black Flag", genre: "punk" },
+      { artist: "Justin Bieber", genre: "pop" }
+   ] )
+
+The following example:
+
+- Initializes a :method:`Bulk()` operations builder.
+- Searches for the genre ``pop``.
+- Deletes ``pop`` music from the collection. 
+
+.. code-block:: javascript
 
-.. seealso::
+   var bulk = db.music.initializeOrderedBulkOp();
+   bulk.find( { "genre": "pop" } ).remove();
+   bulk.execute()
 
-   - :method:`db.collection.initializeUnorderedBulkOp()`
-   - :method:`db.collection.initializeOrderedBulkOp()`
-   - :method:`Bulk.find()`
-   - :method:`Bulk.find.removeOne()`
-   - :method:`Bulk.execute()`

source/reference/method/Bulk.find.removeOne.txt

@@ -17,35 +17,37 @@ Description
 
 .. method:: Bulk.find.removeOne()
 
-   Adds a single document remove operation to a bulk operations list.
-   Use the :method:`Bulk.find()` method to specify the condition that
-   determines which document to remove. The
-   :method:`Bulk.find.removeOne()` limits the removal to one document.
-   To remove multiple documents, see :method:`Bulk.find.remove()`.
+ 
+   Starting in ``mongosh`` 0.12.2, ``Bulk.find.removeOne()`` is an alias
+   for :method:`Bulk.find.deleteOne()`.
+
+   In new code, use ``Bulk.find.deleteOne()`` instead of
+   ``Bulk.find.removeOne()``.
 
 Example
 -------
 
-The following example initializes a :method:`Bulk()` operations builder
-for the ``items`` collection and adds two
-:method:`Bulk.find.removeOne()` operations to the list of operations.
-
-Each remove operation removes just one document: one document with the
-``status`` equal to ``"D"`` and another document with the ``status``
-equal to ``"P"``.
+Create the ``music`` collection:
 
 .. code-block:: javascript
 
-   var bulk = db.items.initializeUnorderedBulkOp();
-   bulk.find( { status: "D" } ).removeOne();
-   bulk.find( { status: "P" } ).removeOne();
-   bulk.execute();
+   db.music.insertMany( [
+      { artist: "DOA", genre: "punk" },
+      { artist: "Rick Astley", genre: "pop" },
+      { artist: "Black Flag", genre: "punk" },
+      { artist: "Justin Bieber", genre: "pop" }
+   ] )
+
+The following example:
+
+- Initializes a :method:`Bulk()` operations builder.
+- Searches for the genre ``pop``.
+- Deletes ``Rick Astley``, the first matching pop artist, from the
+  collection. 
+
+.. code-block:: javascript
 
-.. seealso::
+   var bulk = db.music.initializeOrderedBulkOp();
+   bulk.find( { "genre": "pop" } ).removeOne();
+   bulk.execute()
 
-   - :method:`db.collection.initializeUnorderedBulkOp()`
-   - :method:`db.collection.initializeOrderedBulkOp()`
-   - :method:`Bulk.find()`
-   - :method:`Bulk.find.remove()`
-   - :method:`Bulk.execute()`
-   - :ref:`All Bulk Methods <bulk-methods>`

source/reference/method/Bulk.find.txt

@@ -75,7 +75,7 @@ condition for their respective actions:
 .. code-block:: javascript
 
    var bulk = db.items.initializeUnorderedBulkOp();
-   bulk.find( { status: "D" } ).remove();
+   bulk.find( { status: "D" } ).delete();
    bulk.find( { status: "P" } ).update( { $set: { points: 0 } } )
    bulk.execute();
 

source/reference/method/Bulk.toString.txt

@@ -27,14 +27,27 @@ The following initializes a :method:`Bulk()` operations builder on the
    var bulk = db.items.initializeOrderedBulkOp();
    bulk.insert( { item: "abc123", status: "A", defaultQty: 500, points: 5 } );
    bulk.insert( { item: "ijk123", status: "A", defaultQty: 100, points: 10 } );
-   bulk.find( { status: "D" } ).removeOne();
+   bulk.find( { status: "D" } ).deleteOne();
    bulk.toString();
+   bulk.execute()
 
 The :method:`Bulk.toString()` returns the following JSON document
 
 .. code-block:: javascript
-   
-   { "nInsertOps" : 2, "nUpdateOps" : 0, "nRemoveOps" : 1, "nBatches" : 2 }
+
+   {
+     acknowledged: true,
+     insertedCount: 2,
+     insertedIds: [
+       { index: 0, _id: ObjectId("627bf4f95e19ff3518448883") },
+       { index: 1, _id: ObjectId("627bf4f95e19ff3518448884") }
+     ],
+     matchedCount: 0,
+     modifiedCount: 0,
+     deletedCount: 0,
+     upsertedCount: 0,
+     upsertedIds: []
+   }
 
 .. seealso::
 

source/reference/method/Bulk.tojson.txt

@@ -1,5 +1,5 @@
 =============
-Bulk.tojson()
+Bulk.toJSON()
 =============
 
 .. default-domain:: mongodb
@@ -10,7 +10,7 @@ Bulk.tojson()
    :depth: 1
    :class: singlecol
 
-.. method:: Bulk.tojson()
+.. method:: Bulk.toJSON()
 
    Returns a JSON document that contains the number of operations and
    batches in the :method:`Bulk()` object.
@@ -20,21 +20,33 @@ Example
 
 The following initializes a :method:`Bulk()` operations builder on the
 ``items`` collection, adds a series of write operations, and calls
-:method:`Bulk.tojson()` on the ``bulk`` builder object.
+:method:`Bulk.toJSON()` on the ``bulk`` builder object.
 
 .. code-block:: javascript
 
    var bulk = db.items.initializeOrderedBulkOp();
    bulk.insert( { item: "abc123", status: "A", defaultQty: 500, points: 5 } );
    bulk.insert( { item: "ijk123", status: "A", defaultQty: 100, points: 10 } );
-   bulk.find( { status: "D" } ).removeOne();
-   bulk.tojson();
+   bulk.find( { status: "D" } ).deleteOne();
+   bulk.toJSON();
 
-The :method:`Bulk.tojson()` returns the following JSON document
+The :method:`Bulk.toJSON()` returns the following JSON document
 
 .. code-block:: javascript
 
-   { "nInsertOps" : 2, "nUpdateOps" : 0, "nRemoveOps" : 1, "nBatches" : 2 }
+   {
+     acknowledged: true,
+     insertedCount: 2,
+     insertedIds: [
+       { index: 0, _id: ObjectId("627bf77e5e19ff3518448887") },
+       { index: 1, _id: ObjectId("627bf77e5e19ff3518448888") }
+     ],
+     matchedCount: 0,
+     modifiedCount: 0,
+     deletedCount: 0,
+     upsertedCount: 0,
+     upsertedIds: []
+   }
 
 .. seealso::