MongoDB\Collection::deleteMany() (original) (raw)

MongoDB\Collection::deleteMany()

Deletes all documents that match the filter criteria.


function deleteMany(

    array|object $filter,

    array $options = []

): MongoDB\DeleteResult

$filter : array|object

The filter criteria that specifies the documents to delete.

$options : array

An array specifying the desired options.

Name Type Description
collation array|object 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.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.
comment mixed Enables users to specify an arbitrary comment to help trace the operation through the database profiler,currentOp output, andlogs.To use this option, you must connect to MongoDB 6.0 or later. If you are connected to an earlier version, the server returns an exception at execution time.New in version 1.13.
hint string|array object
let array|object Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. var).This feature is not supported for MongoDB server versions 6.0 and earlier. If used, the server returns an exception at execution time.New in version 1.13.
session MongoDB\Driver\Session Client session to associate with the operation.New in version 1.3.
writeConcern MongoDB\Driver\WriteConcern Write concern to use for the operation. Defaults to the collection's write concern.It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the writeConcern option whenstarting the transaction.

A MongoDB\DeleteResult object, which encapsulates aMongoDB\Driver\WriteResult object.

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\BulkWriteException for errors related to the write operation. You can inspect the value returned by getWriteResult() to determine the nature of the error.

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

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

If a MongoDB\Driver\Exception\BulkWriteException is thrown, you can callgetWriteResult() and inspect the returned MongoDB\Driver\WriteResult object to determine the nature of the error.

For example, a write operation may have been successfully applied to the primary server but failed to satisfy the write concern (e.g. replication took too long). Alternatively, a write operation may have failed outright (e.g. unique key violation).

The following example deletes all of the documents in the users collection that have "ny" as the value for the state field:


<?php

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

$collection->drop();

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

$collection->insertOne(['name' => 'Alice', 'state' => 'ny']);
 <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>d</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>t</mi><mi>e</mi><mi>R</mi><mi>e</mi><mi>s</mi><mi>u</mi><mi>l</mi><mi>t</mi><mo>=</mo></mrow><annotation encoding="application/x-tex">deleteResult = </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord mathnormal">d</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right:0.00773em;">R</span><span class="mord mathnormal">es</span><span class="mord mathnormal">u</span><span class="mord mathnormal">lt</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span></span></span></span>collection->deleteMany(['state' => 'ny']);

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

The output would then resemble: