/ /

Exclua documentos

Visão geral

Neste guia, você pode aprender como remover documentos de suas coleções MongoDB usando operações de exclusão.

Dados de amostra

Os exemplos neste guia utilizam a coleção do restaurants a partir do banco de dados do sample_restaurants. Os documentos nesta coleção usam as seguintes classes Restaurant, Address e GradeEntry como modelos:

public class Restaurant
{
    public ObjectId Id { get; set; }
    public string Name { get; set; }
    [BsonElement("restaurant_id")]
    public string RestaurantId { get; set; }
    public string Cuisine { get; set; }
    public Address Address { get; set; }
    public string Borough { get; set; }
    public List<GradeEntry> Grades { get; set; }
}

public class Address
{
    public string Building { get; set; }
    [BsonElement("coord")]
    public double[] Coordinates { get; set; }
    public string Street { get; set; }
    [BsonElement("zipcode")]
    public string ZipCode { get; set; }
}

public class GradeEntry
{
    public DateTime Date { get; set; }
    public string Grade { get; set; }
    public float? Score { get; set; }
}

Observação

Os documentos na collection restaurants usam a convenção de nomenclatura snake-case. Os exemplos neste guia usam um ConventionPack para desserializar os campos na coleção em maiúsculas e minúsculas Pascal e mapeá-los para as propriedades na classe Restaurant .

Para saber mais sobre serialização personalizada, consulte Serialização personalizada.

Essa collection é dos conjuntos de dados de amostra fornecidos pelo Atlas. Consulte a Introdução ao driver .NET/C# para saber como criar um cluster MongoDB gratuito e carregar esses dados de exemplo.

Excluir operações

Use operações de exclusão para remover documentos que correspondam a um filtro de queries. O filtro de queries determina quais registros são selecionados para exclusão com base nos critérios do documento de filtro de queries. Você pode executar operações de exclusão no MongoDB com os seguintes métodos:

DeleteOne(), que exclui o primeiro documento que corresponde ao filtro de query
DeleteMany(), que exclui todos os documentos que correspondem ao filtro de query

Excluir um documento

O código abaixo mostra como usar o método síncrono DeleteOne() ou o método assíncrono DeleteOneAsync() para excluir um documento.

var result = _restaurantsCollection.DeleteOne(filter);

var result = await _restaurantsCollection.DeleteOneAsync(filter);

Excluir vários documentos

O código abaixo mostra como usar o método síncrono DeleteMany() ou o método assíncrono DeleteManyAsync() para excluir todos os documentos correspondentes.

var result = _restaurantsCollection.DeleteMany(filter);

var result = await _restaurantsCollection.DeleteManyAsync(filter);

Dica

Encontre exemplos executáveis usando esses métodos em informações adicionais.

Parâmetros

Os métodos DeleteOne() e DeleteMany() exigem que você passe um filtro de query especificando quais documentos devem corresponder. Mais informações sobre como construir um filtro de query estão disponíveis no tutorial Documentos de query.

Ambos os métodos recebem opcionalmente um tipo DeleteOptions como parâmetro adicional, que representa opções que você pode usar para configurar a operação de exclusão. Se você não especificar nenhuma propriedade DeleteOptions , o driver não personalizará a operação de exclusão.

O tipo DeleteOptions permite a você configurar opções com as seguintes propriedades:

Propriedade	Descrição
`Collation`	Gets or sets the type of language collation to use when sorting results. See the Collation section of this page for more information.
`Comment`	Obtém ou define o comentário para a operação. Consulte os campos do comando delete para obter mais informações.
`Hint`	Obtém ou define o índice a ser usado para procurar documentos. Consulte as instruções de exclusão para obter mais informações.
`Let`	Obtém ou define o documento de permissão. Consulte os campos do comando delete para obter mais informações.

Agrupamentos

Para configurar o agrupamento para sua operação, crie uma instância da classe Agrupamento.

A tabela seguinte descreve os parâmetros que o construtor do Collation aceita. Ela também lista a propriedade de classe correspondente que você pode usar para ler o valor de cada configuração.

Parâmetro	Descrição	Propriedade de classe
`locale`	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. If you want to use simple binary comparison, use the `Collation.Simple` static property to return a `Collation` object with the `locale` set to `"simple"`. Data Type: `string`	`Locale`
`caseLevel`	(Opcional) Especifica se a comparação de caso deve ser incluída. Quando este argumento é `true`, o comportamento do driver depende do valor do argumento `strength`: - Se `strength` for `CollationStrength.Primary`, o driver compara caracteres básicos e maiúsculas e minúsculas. - Se `strength` for `CollationStrength.Secondary`, o driver compara caracteres básicos, diacríticos, outras diferenças secundárias e maiúsculas e minúsculas. - Se `strength` for qualquer outro valor, este argumento será ignorado. Quando este argumento é `false`, o driver não inclui comparação de maiúsculas e minúsculas no nível de força `Primary` ou `Secondary`. Tipo de dados: `boolean` Padrão: `false`	`CaseLevel`
`caseFirst`	(Optional) Specifies the sort order of case differences during tertiary level comparisons. Data Type: CollationCaseFirst Default: `CollationCaseFirst.Off`	`CaseFirst`
`strength`	(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. Data Type: CollationStrength Default: `CollationStrength.Tertiary`	`Strength`
`numericOrdering`	(Opcional) Especifica se o driver compara strings numéricas como números. Se esse argumento `true` for, o driver compara strings numéricas como números. Por exemplo, ao comparar as strings "10" e "2", o driver trata os valores como 10 2e, e considera 10 maior. Se esse argumento for `false` ou excluído, o driver compara cadeias de caracteres numéricas como cadeias de caracteres. Por exemplo, ao comparar as strings "10" e "2", o driver compara um caractere de cada vez. Porque "1" é inferior a "2", o condutor encontra "10" para ser menor que "2". Para obter mais informações, consulte Restrições de agrupamento no manual do MongoDB Server . Tipo de Dados: `boolean` Padrão: `false`	`NumericOrdering`
`alternate`	(Optional) Specifies whether the driver considers whitespace and punctuation as base characters for purposes of comparison. Data Type: CollationAlternate Default: `CollationAlternate.NonIgnorable` (spaces and punctuation are considered base characters)	`Alternate`
`maxVariable`	(Optional) Specifies which characters the driver considers ignorable when the `alternate` argument is `CollationAlternate.Shifted`. Data Type: CollationMaxVariable Default: `CollationMaxVariable.Punctuation` (the driver ignores punctuation and spaces)	`MaxVariable`
`normalization`	(Optional) Specifies whether the driver normalizes text as needed. Most text doesn't require normalization. For more information about normalization, see the ICU documentation. Data Type: `boolean` Default: `false`	`Normalization`
`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: `boolean` Padrão: `false`	`Backwards`

Para obter mais informações sobre agrupamento, consulte a página Agrupamento no manual do MongoDB Server.

Exemplo

O código a seguir utiliza o método DeleteMany() para pesquisar no índice " borough_1" e excluir todos os documentos em que o valor do campo address.street contenha a frase "Pearl Street":

var filter = Builders<Restaurant>.Filter
    .Regex("address.street", "Pearl Street");
DeleteOptions opts = new DeleteOptions { Hint = "borough_1" };
Console.WriteLine("Deleting documents...");
var result = _restaurantsCollection.DeleteMany(filter, opts);
Console.WriteLine($"Deleted documents: {result.DeletedCount}");
Console.WriteLine($"Result acknowledged? {result.IsAcknowledged}");

Deleting documents...
Deleted documents: 26
Result acknowledged? True

Dica

Se o exemplo anterior usasse o método DeleteOne() em vez de DeleteMany(), o driver excluiria o primeiro dos 26 documentos correspondentes.

Valor de retorno

Os métodos DeleteOne() e DeleteMany() retornam um tipo DeleteResult . Este tipo contém a propriedade DeletedCount , que indica o número de documentos excluídos, e a propriedade IsAcknowledged , que indica se o resultado é reconhecido. Se o filtro de query não corresponder a nenhum documento, nenhum documento será excluído e DeletedCount será 0.

Informações adicionais

Para obter exemplos executáveis das operações de exclusão, consulte os seguintes exemplos de uso:

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