$match (estágio de agregação )

Definição

$match: Filtra documentos com base em um predicado de consulta especificado. Os documentos correspondentes são passados para a próxima etapa do pipeline.

Compatibilidade

Você pode utilizar o $match para implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

{ $match: { <query predicate> } }

A sintaxe do predicado de query $match é idêntica à sintaxe usada no argumento de query de um comando find().

Comportamento

Otimização de pipeline

Coloque $match o mais cedo possível no pipeline de agregação. Como o $match limita o número total de documento no pipe de agregação, as operações $match anteriores minimizam a quantidade de processamento no pipe.
Se você colocar $match no início de um pipeline, a query poderá aproveitar os índices como qualquer outro db.collection.find() ou db.collection.findOne().

Expressões em predicados de query

Para incluir expressões em um predicado de query, use o operador $expr.

0, valores nulos, falsos ou ausentes

Um estágio $match filtra um documento dos resultados do pipeline se uma das seguintes condições se aplicar:

O predicado de query $match retorna um valor 0, null ou false nesse documento.
O predicado de query $match utiliza um campo ausente desse documento.

Restrições

Você não pode usar $where em um estágio $match .
Você não pode usar $near ou $nearSphere em um estágio $match. Como alternativa, você pode:
- Usar o estágio $geoNear em vez do $match.
- Usar o operador de predicado de query $geoWithin com $center ou $centerSphere no estágio $match.
Para usar $text em um estágio $match, o estágio $match deve ser o primeiro estágio do pipeline.

As visualizações não suportam $text.

Observação
$text fornece recursos de query de texto para implantações autogerenciadas (não Atlas). Para dados hospedados no MongoDB Atlas, o MongoDB oferece uma solução aprimorada de query de texto completo, Atlas Search.

Filtrar dados no Atlas usando o Atlas Search

Para dados armazenado no MongoDB Atlas, você pode usar a opção filter do operador composto do Atlas Search para fazer a correspondência ou filtrar documentos ao executar queries $search. A execução de $match após $search tem menos desempenho do que a execução de $search com a opção filter do operador composto.

Para saber mais sobre a opção filter, consulte o operador composto na documentação do Atlas.

Exemplos

Os exemplos nesta página usam dados do conjunto de dados sample_mflix. Para obter detalhes sobre como carregar este conjunto de dados em sua implantação do MongoDB autogerenciado, consulte Carregar o conjunto de dados de amostra. Se você fez alguma modificação nos bancos de dados de amostra, talvez seja necessário descartar e recriar os bancos de dados para executar os exemplos nesta página.

Correspondência de qualidade

A operação a seguir usa $match para realizar uma correspondência de igualdade no campo rated. O filtro runtime limita o resultado a um conjunto pequeno e representativo:

db.movies.aggregate(    [ { $match : { rated : "TV-PG", runtime : { $gt: 1000 } } } ])

O $match seleciona os documentos onde o campo rated é igual a "TV-PG" e runtime é maior que 1000.

Fazer uma contagem

O exemplo a seguir seleciona documentos a serem processados usando o operador de pipeline $match e, em seguida, encaminha os resultados para o operador de pipeline $group para calcular a contagem dos documentos:

db.movies.aggregate( [  { $match: { $or: [      { runtime: { $gt: 1000 } },      { year: { $lt: 1910 } }  ] } },  { $group: { _id: null, count: { $sum: 1 } } }] )

[ { _id: null, count: 6 } ]

No pipeline de agregação, $match seleciona os documents em que runtime é maior que 1000 ou year é anterior a 1910. Esses documentos são então enviados para $group para realizar a contagem.

Elementos da matriz de correspondência

Para filtrar document com base em elementos em um campo de array, use o operador $elemMatch no predicado de query do estágio $match:

db.aggregate( [   {      $documents: [         { student_id: 1, scores: [ 0.75, 0.65, 0.73 ] },         { student_id: 2, scores: [ 0.9, 0.88, 0.98 ] },         { student_id: 3, scores: [ 0.9, 0.84, 0.93 ] }      ]   }, {      $match: {         scores: { $elemMatch: { $gte: 0.9 } }      }   }] )

[  { student_id: 2, scores: [ 0.9, 0.88, 0.98 ] },  { student_id: 3, scores: [ 0.9, 0.84, 0.93 ] }]

Os exemplos de C# nesta página utilizam o banco de dados sample_mflix a partir dos conjuntos de dados de amostra do Atlas. Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de exemplo, consulte Introdução na documentação do driver MongoDB .NET/C#.

A seguinte classe Movie modela os documentos na collection sample_mflix.movies:

[BsonIgnoreExtraElements]public class Movie{    [BsonId]    public ObjectId Id { get; set; }    [BsonElement("title")]    public string Title { get; set; } = null!;    [BsonElement("year")]    public int? Year { get; set; }    [BsonElement("runtime")]    public int? Runtime { get; set; }    [BsonElement("rated")]    public string? Rated { get; set; }    [BsonElement("metacritic")]    public int Metacritic { get; set; }    [BsonElement("plot")]    public string? Plot { get; set; }    [BsonElement("type")]    public string? Type { get; set; }    [BsonElement("cast")]    public string[]? Cast { get; set; }    [BsonElement("directors")]    public string[]? Directors { get; set; }    [BsonElement("writers")]    public string[]? Writers { get; set; }    [BsonElement("imdb")]    public ImdbData? Imdb { get; set; }}

Para usar o driver MongoDB .NET/C# para adicionar um estágio $match a uma agregação pipeline, chame o método UnionWith() em um objeto PipelineDefinition.

O exemplo a seguir cria um estágio de pipeline que corresponde a todos os documentos Movie em que o campo Title é igual a "The Godfather":

var pipeline = new EmptyPipelineDefinition<Movie>()    .Match(m => m.Title == "The Godfather");

{ "_id" : "...", "title" : "The Godfather", "metacritic" : 100, "rated" : "R", "runtime" : 175, "imdb" : "..." }

Os exemplos do Node.js nesta página utilizam o banco de dados do sample_mflix a partir dos conjuntos de dados de amostra do Atlas. Para saber como criar um cluster gratuito do MongoDB Atlas e carregar os conjuntos de dados de exemplo, consulte Introdução na documentação do driver do MongoDB Node.js

Para usar o driver Node.js do MongoDB para adicionar um estágio $match a um pipeline de agregação , use o operador $match em um objeto de pipeline.

O exemplo a seguir cria um estágio de pipeline que corresponde a todos os documentos movie em que o campo title é igual a "The Shawshank Redemption". O exemplo em seguida executa o pipeline de agregação:

const pipeline = [  {    $match: {      title: "The Shawshank Redemption"    }  }];
const cursor = collection.aggregate(pipeline);return cursor;

Saiba mais

Consulte os Tutoriais do pipeline de agregação completo para obter mais informações e casos de uso sobre agregação.

Voltar

$lookup

$merge