================================
MongoDB\\Collection::deleteOne()
================================

.. default-domain:: mongodb

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

Definition
----------

.. phpmethod:: MongoDB\\Collection::deleteOne($filter, $options)

   Deletes at most one document that matches the filter criteria. If
   multiple documents match the filter criteria,
   :phpmethod:`MongoDB\\Collection::deleteOne` deletes the :term:`first
   <natural order>` matching document.

   .. code-block:: php

      function deleteOne($filter, array $options = []): MongoDB\DeleteResult

   :phpmethod:`MongoDB\\Collection::deleteMany` has the following
   parameters:

   .. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-param.rst
   
   :phpmethod:`MongoDB\\Collection::deleteMany` supports the following
   options:

   .. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-option.rst

Output
------

Returns a ``MongoDB\DeleteResult`` object.

Example
-------

The following operation deletes the first documents in the ``users``
collection that has ``ny`` as the value for the ``state`` field:

.. code-block:: php

   <?php

   $collection = (new MongoDB\Client)->demo->users;
   $collection->drop();

   $collection->insertOne(['name' => 'Bob', 'state' => 'ny']);
   $collection->insertOne(['name' => 'Alice', 'state' => 'ny']);
   $deleteResult = $collection->deleteOne(['state' => 'ny']);

   printf("Deleted %d document(s)\n", $deleteResult->getDeletedCount());

The output would then resemble::

   Deleted 1 document(s)

.. seealso::
   
   - :phpmethod:`MongoDB\\Collection::bulkWrite`
   - :phpmethod:`MongoDB\\Collection::deleteMany`
   - :doc:`/tutorial/crud`
   - :manual:`delete command reference </reference/command/delete`
     in the MongoDB manual