Adiciona uma operação deleteOne

# MongoDB\Driver\BulkWriteCommand::deleteOne

(mongodb >=2.1.0)

MongoDB\Driver\BulkWriteCommand::deleteOne — Adiciona uma operação deleteOne

### Descrição

public function MongoDB\Driver\BulkWriteCommand::deleteOne(string `$namespace`, array|object `$filter`, ?array `$options` = `null`): void

Adiciona uma operação deleteOne ao MongoDB\Driver\BulkWriteCommand. O primeiro documento correspondente a `filter` na coleção identificada por `namespace` será excluído.

### Parâmetros

`namespace` (string)
  Um namespace totalmente qualificado (por exemplo, `"nomeDoBancoDados.nomeDaColecao"`).
`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).

`options`

  Opções
  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 de í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 planos que utilizem o índice sugerido.

### Valor Retornado

Nenhum valor é retornado.

### Erros/Exceções

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

### Exemplos

Exemplo #1 Exemplo de MongoDB\Driver\BulkWriteCommand::deleteOne()

    <?php

    $manager = new MongoDB\Driver\Manager;

    $bulk = new MongoDB\Driver\BulkWriteCommand;
    $bulk->deleteOne('db.coll', ['x' => 1]);

    $result = $manager->executeBulkWriteCommand($bulk);

    ?>

### Veja Também

- MongoDB\Driver\BulkWriteCommand::deleteMany() - Adiciona uma operação deleteMany
- MongoDB\Driver\Manager::executeBulkWriteCommand() - Executa operações de gravação usando o comando bulkWrite
- MongoDB\Driver\BulkWriteCommandResult

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