Bulk.toString.txt

===============
Bulk.toString()
===============

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

.. method:: Bulk.toString()

   Returns as a string a JSON document that contains the number of
   operations and batches in the :method:`Bulk()` object.

Compatibility
-------------

This command is available in deployments hosted in the following
environments: 

.. include:: /includes/fact-environments-atlas-only.rst

.. include:: /includes/fact-environments-atlas-support-all.rst

Example
-------

The following initializes a :method:`Bulk()` operations builder on the
``items`` collection, adds a series of write operations, and calls
:method:`Bulk.toString()` 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" } ).deleteOne();
   bulk.toString();
   bulk.execute()

The :method:`Bulk.toString()` returns the following JSON document

.. code-block:: javascript

   {
     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::

   :method:`Bulk()`