Definição
$matchFiltra documentos com base em umpredicado 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
$matcho mais cedo possível no pipeline de agregação. Como o$matchlimita o número total de documento no pipe de agregação, as operações$matchanteriores minimizam a quantidade de processamento no pipe.Se você colocar
$matchno início de um pipeline, a query poderá aproveitar os índices como qualquer outrodb.collection.find()oudb.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
$matchretorna um valor0,nulloufalsenesse documento.O predicado de query
$matchutiliza um campo ausente desse documento.
Restrições
Você não pode usar
$whereem um estágio$match.Você não pode usar
$nearou$nearSphereem um estágio$match. Como alternativa, você pode:Usar o operador de predicado de query
$geoWithincom$centerou$centerSphereno estágio$match.
Para usar
$textem um estágio$match, o estágio$matchdeve ser o primeiro estágio do pipeline.As visualizações não suportam
$text.Observação
$textfornece recursos de query de texto para sistemas autogerenciados (não Atlas). Para dados hospedados no MongoDB, o MongoDB também oferece uma solução de query de texto completo aprimorada, MongoDB Search.
Filtre dados no Atlas usando o MongoDB Search
Para dados armazenados no MongoDB Atlas, você pode usar a opção filter do MongoDB Search compound Operator para corresponder ou filtrar documentos ao executar $search queries. A execução de $match após $search é menos eficiente que a execução de $search com a opção de operador composto filter.
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 de amostra sample_mflix. Para obter detalhes sobre como carregar esse conjunto de dados em sua implantação autogerenciada do MongoDB , consulte Carregar o conjunto de dados de amostra. Se você fez modificações 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:
[] public class Movie { [] public ObjectId Id { get; set; } [] public string Title { get; set; } = null!; [] public int? Year { get; set; } [] public int? Runtime { get; set; } [] public string? Rated { get; set; } [] public int Metacritic { get; set; } [] public string? Plot { get; set; } [] public string? Type { get; set; } [] public string[]? Cast { get; set; } [] public string[]? Directors { get; set; } [] public string[]? Writers { get; set; } [] public ImdbData? Imdb { get; set; } }
Para usar o driver MongoDB .NET/C# para adicionar um estágio $match a um pipeline de agregação, chame o método Match() 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.