MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::delete — Add a delete operation to the bulk

Beschreibung

public MongoDB\Driver\BulkWrite::delete ( array|object $filter [, array $deleteOptions ] ) : void

Adds a delete operation to the MongoDB\Driver\BulkWrite.

Parameter-Liste

filter

The search filter.

deleteOptions

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 "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.

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

limit boolean Delete all matching documents (FALSE), or only the first matching document (TRUE) FALSE

Rückgabewerte

Es wird kein Wert zurückgegeben.

Fehler/Exceptions

  • Throws MongoDB\Driver\InvalidArgumentException on argument parsing errors.

Changelog

Version Beschreibung
1.2.0 Added the "collation" option.

Beispiele

Beispiel #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);

?>

Siehe auch