Adiciona uma operação de remoção ao objeto de escrita em massa

# MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::delete — Adiciona uma operação de remoção ao objeto de escrita em massa

### Descrição

public function MongoDB\Driver\BulkWrite::delete(array|object `$filter`, ?array `$deleteOptions` = `null`): void

Adiciona uma operação de remoção ao MongoDB\Driver\BulkWrite.

### Parâmetros

`filter` (array|object)
  O » predicado de consulta. Um predicado vazio corresponderá a todos os documentos da coleção.

  > Nota: Ao avaliar os critérios de consulta, o MongoDB compara os tipos e valores de acordo com suas próprias » regras de comparação para tipos BSON, que diferem das regras de comparação e do malabarismo de tipos do PHP. Ao corresponder a um tipo especial de BSON, os critérios de consulta devem usar a respectiva classe BSON (por exemplo, use MongoDB\BSON\ObjectId para corresponder a um » ObjectId).

`deleteOptions`

  deleteOptions
  Opção | Tipo | Descrição | Padrão
  --- | --- | --- | ---
  collation | array|object | » Collation permite que os usuários especifiquem regras específicas do idioma para comparação de strings, como regras para maiúsculas e minúsculas e acentos. Ao especificar a collation, o campo `"locale"` é obrigatório; todos os outros campos de collation são opcionais. Para obter descrições dos campos, veja o » Documento de Collation. Se a collation não for especificada, mas a coleção tiver uma collation padrão, a operação usará a collation especificada para a coleção. Se nenhuma collation for especificada para a coleção ou para a operação, o MongoDB usará a comparação binária simples usada em versões anteriores para comparações de strings. Esta opção está disponível no MongoDB 3.4+ e resultará em uma exceção em tempo de execução se for especificada para uma versão de servidor mais antiga.
  hint | string|array|object | Especificação do índice. Especifique o nome do índice como uma string ou o padrão de chave do índice. Se especificado, o sistema de consulta considerará apenas os planos usando o índice sugerido. Esta opção está disponível no MongoDB 4.4+ e resultará em uma exceção em tempo de execução se especificada para uma versão mais antiga do servidor.
  limit | bool | Exclui todos os documentos correspondentes (`false`) ou apenas o primeiro documento correspondente (`true`) | `false`

### Valor Retornado

Nenhum valor é retornado.

### Erros/Exceções

- Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.

### Registro de Alterações

Versão | Descrição
--- | ---
PECL mongodb 1.8.0 | Opção `"hint"` adicionada.
PECL mongodb 1.2.0 | Opção `"collation"` adicionada.

### Exemplos

Exemplo #1 Exemplo de MongoDB\Driver\BulkWrite::delete()

    <?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);

    ?>

### Veja Também

- MongoDB\Driver\Manager::executeBulkWrite() - Executa uma ou mais operações de escrita
- MongoDB\Driver\WriteResult

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open