MongoDB\Driver\BulkWrite::delete

Add a delete operation to the bulk

&reftitle.description; public `void` `MongoDB\Driver\BulkWrite::delete` ``array``object```filter` ``array``null```deleteOptions`&null;

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

&reftitle.parameters;
&mongodb.parameter.filter;

`deleteOptions`

- ## deleteOptions

  Option | Type | Description | Default
  &mongodb.option.collation;
  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;

&reftitle.returnvalues;

&return.void;

&reftitle.errors;

&mongodb.throws.argumentparsing;

&reftitle.changelog;

&Version; | &Description;
PECL mongodb 1.8.0 | Added the `"hint"` option.
PECL mongodb 1.2.0 | Added the `"collation"` option.

&reftitle.examples;

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

    ?>

&reftitle.seealso;

- `MongoDB\Driver\Manager::executeBulkWrite`
- `MongoDB\Driver\WriteResult`