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

Os exemplos neste guia utilizam a coleção do restaurants no banco de dados de dados do sample_restaurants a partir dos conjuntos de dados de amostra do Atlas. Para acessar essa coleção a partir do seu aplicação PHP , instancie um MongoDB\Client que se conecte a um Atlas cluster e atribua o seguinte valor à sua variável $collection :

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

Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o guia Iniciar com Atlas .

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`	Specifies the kind of language collation to use when comparing strings. To learn more, see the Collation section of this page.
`writeConcern`	Sets the write concern for the operation. This option defaults to the collection's write concern. For more information, see Write Concern in the MongoDB Server manual.
`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`	Specifies the client session to associate with the operation. For more information, see Session in the MongoDB Server manual.
`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`	(Required) Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server manual. Data Type: `string`
`caseLevel`	(Optional) Specifies whether to include case comparison. When set to `true`, the comparison behavior depends on the value of the `strength` field: - If `strength` is `1`, the PHP library compares base characters and case. - If `strength` is `2`, the PHP library compares base characters, diacritics, other secondary differences, and case. - If `strength` is any other value, this field is ignored. When set to `false`, the PHP library doesn't include case comparison at strength level `1` or `2`. Data Type: `bool` Default: `false`
`caseFirst`	(Optional) Specifies the sort order of case differences during tertiary level comparisons. Data Type: `string` Default: `"off"`
`strength`	(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. Data Type: `int` Default: `3`
`numericOrdering`	(Optional) Specifies whether the driver compares numeric strings as numbers. If set to `true`, the PHP library compares numeric strings as numbers. For example, when comparing the strings "10" and "2", the library uses the strings' numeric values and treats "10" as greater than "2". If set to `false`, the PHP library compares numeric strings as strings. For example, when comparing the strings "10" and "2", the library compares one character at a time and treats "10" as less than "2". For more information, see Collation Restrictions in the MongoDB Server manual. Data Type: `bool` Default: `false`
`alternate`	(Optional) Specifies whether the library considers whitespace and punctuation as base characters for comparison purposes. Data Type: `string` Default: `"non-ignorable"`
`maxVariable`	(Optional) Specifies which characters the library considers ignorable when the `alternate` field is set to `"shifted"`. Data Type: `string` Default: `"punct"`
`backwards`	(Optional) Specifies whether strings containing diacritics sort from the back of the string to the front. Data Type: `bool` Default: `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;

Deleted documents: 111

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