Navigation

MongoDB\Collection::findOneAndDelete()

Definition

MongoDB\Collection::findOneAndDelete

Finds a single document matching the query and deletes it.

function findOneAndDelete($filter = [], array $options = []): object|null

This method has the following parameters:

Parameter Type Description
$filter array|object The filter criteria that specifies the documents to delete.
$options array Optional. An array specifying the desired options.

The $options parameter supports the following options:

Option Type Description
projection array|object Optional. The projection specification to determine which fields to include in the returned documents. See Project Fields to Return from Query and Projection Operators in the MongoDB manual.
sort array|object Optional. The sort specification for the ordering of the results.
collation array|object

Optional. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the locale field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.

This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.

If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.

maxTimeMS integer Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
session MongoDB\Driver\Session

Optional. Client session to associate with the operation.

Sessions are not supported for server versions prior to 3.6.

New in version 1.3.

typeMap array

Optional. The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the collection’s type map.

This will be used for the returned result document.

writeConcern MongoDB\Driver\WriteConcern

Optional. Write concern to use for the operation. Defaults to the collection’s write concern.

This is not supported for server versions prior to 3.2 and will result in an exception at execution time if used.

Return Values

An array or object for the document that was deleted, or null if no document matched the query. The return type will depend on the typeMap option.

Errors/Exceptions

MongoDB\Exception\UnexpectedValueException if the command response from the server was malformed.

MongoDB\Exception\UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Behavior

When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP’s comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the driver (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).

Examples

The following example finds and deletes the document with restaurant_id of "40375376" from the restaurants collection in the test database:

<?php

$collection = (new MongoDB\Client)->test->restaurants;

$deletedRestaurant = $collection->findOneAndDelete(
    [ 'restaurant_id' => '40375376' ],
    [
        'projection' => [
            'name' => 1,
            'borough' => 1,
            'restaurant_id' => 1,
        ],
    ]
);

var_dump($deletedRestaurant);

The output would then resemble:

object(MongoDB\Model\BSONDocument)#17 (1) {
  ["storage":"ArrayObject":private]=>
  array(4) {
    ["_id"]=>
    object(MongoDB\BSON\ObjectId)#11 (1) {
      ["oid"]=>
      string(24) "594d5ef280a846852a4b3f70"
    }
    ["borough"]=>
    string(9) "Manhattan"
    ["name"]=>
    string(15) "Agra Restaurant"
    ["restaurant_id"]=>
    string(8) "40375376"
  }
}