/ /

Exclua documentos

Visão geral

Neste guia, você pode aprender como usar a Biblioteca MongoDB PHP para remover documentos de uma coleção MongoDB realizando operações de exclusão.

Uma operação de exclusão remove um ou mais documentos de uma collection do MongoDB. Você pode executar uma operação de exclusão utilizando os métodos MongoDB\Collection::deleteOne() ou MongoDB\Collection::deleteMany() .

Dados de amostra

The examples in this guide use the restaurants collection in the sample_restaurants database from the Atlas sample datasets. To access this collection from your PHP application, instantiate a MongoDB\Client that connects to an Atlas cluster and assign the following value to your $collection variable:

$collection = $client->sample_restaurants->restaurants;

Para aprender a criar uma implantação gratuita do MongoDB e carregar os conjuntos de dados de amostra, consulte o guia Começar do MongoDB.

Excluir operações

Você pode executar operações de exclusão usando os seguintes métodos:

MongoDB\Collection::deleteOne(), que exclui o primeiro documento que corresponde aos critérios do Atlas Search
MongoDB\Collection::deleteMany(), que exclui todos os documentos que correspondem aos critérios do Atlas Search

Cada método de exclusão requer um query filtro documento, que especifica os critérios de pesquisa para determinar quais documentos selecionar para remoção. Para obter mais informações sobre filtros de query, consulte a seção Documentos de filtro de query no manual do MongoDB Server .

Excluir um documento

O exemplo a seguir usa o método deleteOne() para remover um documento na collection restaurants que tem um valor name de 'Ready Penny Inn':

$collection->deleteOne(['name' => 'Ready Penny Inn']);

Excluir vários documentos

O exemplo a seguir usa o método deleteMany() para remover todos os documentos na collection restaurants que tenham um valor borough de 'Brooklyn':

$collection->deleteMany(['borough' => 'Brooklyn']);

Modificar a operação de exclusão

Você pode modificar o comportamento dos métodos MongoDB\Collection::deleteOne() e MongoDB\Collection::deleteMany() passando uma array que especifique valores de opção como um parâmetro. A tabela a seguir descreve as opções que você pode definir na array:

Opção	Descrição
`collation`	Especifica o tipo de agrupamento de idiomas a ser usado ao comparar strings. Para saber mais, consulte a seção Agrupamento desta página.
`writeConcern`	Define a preocupação de gravação para a operação. Esta opção tem como padrão a preocupação de gravação da coleção. Para obter mais informações, consulte Write Concern no manual do MongoDB Server .
`hint`	Gets or sets the index to scan for documents. For more information, see the hint statement in the MongoDB Server manual.
`let`	Specifies a document with a list of values to improve operation readability. Values must be constant or closed expressions that don't reference document fields. For more information, see the let statement in the MongoDB Server manual.
`session`	Especifica a sessão do cliente a ser associada à operação. Para obter mais informações, consulte Sessão no manual do MongoDB Server .
`comment`	Attaches a comment to the operation. For more information, see the delete command fields guide in the MongoDB Server manual.

Agrupamentos

Para especificar um agrupamento para sua operação, passe um parâmetro de array $options que defina a opção collation para o método de operação. Atribua a opção collation a uma array que configure as regras de agrupamento.

A tabela a seguir descreve os campos que você pode definir para configurar o agrupamento:

Campo	Descrição
`locale`	(Obrigatório) Especifica a locale { components internacionais para Unicode} (ICU). Para obter uma lista de localidades suportadas, consulte Localidades de Agrupamento e Parâmetros Padrão no manual do MongoDB Server . Tipo de dados: `string`
`caseLevel`	(Opcional) Especifica se a comparação de caso deve ser incluída. Quando definido `true` como, o comportamento de comparação depende do valor do `strength` campo: - Se `strength` `1`for, a biblioteca PHP compara caracteres base e caso. - `strength` Se `2` for, a biblioteca PHP compara caracteres base, diacríticos, outras diferenças secundárias e caso. - Se `strength` for qualquer outro valor, este campo será ignorado. Quando definido como `false`, a biblioteca PHP não inclui comparação de caso no nível de força `1` ou `2`. Tipo de dados: `bool` Padrão: `false`
`caseFirst`	(Opcional) Especifica a ordem de classificação das diferenças de caso durante comparações de nível terciário. Tipo de dados: `string` Padrão: `"off"`
`strength`	(Opcional) Especifica o nível de comparação a ser executado, conforme definido na documentação da ICU. Tipo de dados: `int` Padrão: `3`
`numericOrdering`	(Opcional) Especifica se o driver compara strings numéricas como números. Se definido `true` como, a biblioteca PHP compara strings numéricas como números. Por exemplo, ao comparar as strings "10" e "2", a biblioteca usa os valores numéricos das strings e trata "10" como maior que2 "". Se configurado `false` para, a biblioteca PHP compara strings numéricas como strings. Por exemplo, ao comparar as strings "10" e "2", a biblioteca compara um caractere de cada vez e trata "10" como menor que2 "". Para obter mais informações, consulte Restrições de agrupamento no manual do MongoDB Server . Tipo de dados: `bool` Padrão: `false`
`alternate`	(Opcional) Especifica se a biblioteca considera espaços em branco e pontuação como caracteres base para fins de comparação. Tipo de dados: `string` Padrão: `"non-ignorable"`
`maxVariable`	(Opcional) Especifica quais caracteres a biblioteca considera ignoráveis quando o campo `alternate` é definido como `"shifted"`. Tipo de dados: `string` Padrão: `"punct"`
`backwards`	(Opcional) Especifica se as strings que contêm diacríticos são ordenadas da parte de trás da string para a frente. Tipo de dados: `bool` Padrão: `false`

Para saber mais sobre agrupamento e os possíveis valores para cada campo, consulte a entrada de Agrupamento no manual do MongoDB Server.

Exemplo

O exemplo seguinte chama o método deleteMany() para excluir todos os documentos na coleção restaurants que têm um valor name contendo a string 'Mongo'. Ele também define a opção comment em um parâmetro de array para adicionar um comentário à operação:

$collection->deleteMany(
    ['name' => new MongoDB\BSON\Regex('Mongo')],
    ['comment' => 'Deleting Mongo restaurants'],
);

Observação

Se você substituir o método deleteMany() por deleteOne() no exemplo anterior, a biblioteca excluirá somente o primeiro documento que tiver um valor name contendo 'Mongo'.

Valor de retorno

Os métodos MongoDB\Collection::deleteOne() e MongoDB\Collection::deleteMany() retornam um objeto MongoDB\DeleteResult . Esta classe contém as seguintes funções de membro:

isAcknowledged(), que retorna um booleano indicando se a operação foi reconhecida.
getDeletedCount(), que retorna o número de documentos excluídos. Se a operação de gravação não foi confirmada, este método gerará um erro.

Se o filtro de query não corresponder a nenhum documento, o driver não excluirá nenhum documento e getDeletedCount() retornará 0.

Exemplo

O exemplo a seguir chama o método deleteMany() para excluir documentos que tenham um valor cuisine de 'Greek'. Em seguida, ele chama a função de membro getDeletedCount() para imprimir o número de documentos excluídos:

$result = $collection->deleteMany(['cuisine' => 'Greek']);
echo 'Deleted documents: ', $result->getDeletedCount(), PHP_EOL;

Documentação da API

Para saber mais sobre qualquer um dos métodos ou tipos discutidos neste guia, consulte a seguinte documentação da API:

Voltar

Substituir documentos

Operações de gravação em massa