(mongodb >=1.0.0)
MongoDB\Driver\BulkWrite::delete — Add a delete operation to the bulk
Adds a delete operation to the MongoDB\Driver\BulkWrite.
filter (array|object)The » query predicate. An empty predicate will match all documents in the collection.
Note: 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 (e.g. use MongoDB\BSON\ObjectId to match an » ObjectId).
deleteOptions
| Option | Type | Description | Default |
|---|---|---|---|
| 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 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. This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version. |
|
| hint | string|array|object |
Index specification. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index. This option is available in MongoDB 4.4+ and will result in an exception at execution time if specified for an older server version. |
|
| limit | bool | Delete all matching documents (false), or only the first matching document (true) |
false |
No value is returned.
| Version | Description |
|---|---|
| PECL mongodb 1.8.0 |
Added the "hint" option.
|
| PECL mongodb 1.2.0 |
Added the "collation" option.
|
Example #1 MongoDB\Driver\BulkWrite::delete() example
<?php
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->delete(['x' => 1], ['limit' => 1]);
$bulk->delete(['x' => 2], ['limit' => 0]);
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$result = $manager->executeBulkWrite('db.collection', $bulk);
?>