Estágios de aggregation

$addFields

Adiciona novos campos aos documentos. Semelhante ao $project, $addFields remodela cada documento no fluxo; especificamente, adicionando novos campos aos documentos de saída que contêm os campos existentes dos documentos de entrada e os campos recém-adicionados.

$set é um alias para $addFields.

$bucket

Categoriza documentos recebidos em grupos, chamados blocos, com base em uma expressão especificada e limites de blocos.

$bucketAuto

Categoriza documentos recebidos em um número específico de grupos, chamados blocos, com base em uma expressão especificada. Os limites dos compartimentos são determinados automaticamente em uma tentativa de distribuir uniformemente os documentos no número especificado de compartimentos.

$count

Retorna uma contagem do número de documentos nesta etapa do pipeline de agregação.

Distinto do acumulador de agregação do $count.

$densify

Cria novos documentos em uma sequência de documentos onde determinados valores em um campo estão faltando.

$documents

Retorna documentos literais de expressões de entrada.

$facet

Processa vários aggregation pipelines em um único estágio no mesmo conjunto de documentos de entrada. Permite a criação de agregações multifacetadas capazes de caracterizar dados em várias dimensões, ou facets, em um único estágio.

$fill

Preenche null e os valores de campo ausentes nos documentos.

$geoNear

Retorna um fluxo ordenado de documentos baseado na proximidade de um ponto geoespacial. Incorpora a funcionalidade do $match, $sort e $limit para dados geoespaciais. Os documentos de saída incluem um campo de distância adicional e podem incluir um campo de identificador de local.

$graphLookup

Executa uma pesquisa recursiva em uma coleção. Para cada documento de saída, adiciona um novo campo de matriz que contém resultados transversais da busca recursiva por esse documento.

$group

Agrupa documentos de entrada por uma expressão de identificador especificada e aplica a(s) expressão(ões) acumuladora(s), se especificada(s), para cada grupo. Consome todos os documentos de entrada e gera um documento por cada grupo distinto. Os documentos de saída só contêm o campo identificador e, se especificado, campos acumulados.

$limit

Passa os primeiros n documentos não modificados para o pipeline onde n é o limite especificado. Para cada documento de entrada, gera um documento (para os primeiros n documentos) ou zero documentos (após os primeiros n documentos).

$lookup

Executa uma junção externa esquerda a outra collection ou visualização no mesmo banco de dados para filtrar documentos da collection "associada" ou visualização para processamento.

$match

Filtra o fluxo de documentos para permitir que apenas documentos correspondentes passem sem modificações para o próximo estágio do pipeline. O $match utiliza consultas MongoDB padrão. Para cada documento de entrada, gera um documento (uma correspondência) ou zero documentos (nenhuma correspondência).

$merge

Escreve os documentos resultantes do aggregation pipeline em uma coleção. O estágio pode incorporar (inserir novos documentos, mesclar documentos, substituir documentos, manter documentos existentes, falhar na operação, processar documentos com um pipeline de atualização personalizado) os resultados em uma coleção de saída. Para usar o estágio $merge , ele deve ser o último estágio do pipeline.

$out

Escreve os documentos resultantes do aggregation pipeline em uma coleção. Para usar o estágio $out, ele deve ser o último estágio no pipeline.

$project

Remodela cada documento no fluxo, adicionando novos campos ou removendo campos existentes. Para cada documento de entrada, gera um documento.

Consulte também $unset para remover campos existentes.

$redact

Remodela cada documento no fluxo restringindo o conteúdo de cada documento com base nas informações armazenadas nos próprios documentos. Incorpora a funcionalidade do $project e $match. Pode ser usado para implementar a redação em nível de campo. Para cada documento de entrada, gera um ou zero documentos.

$replaceRoot

Substitui um documento pelo documento incorporado especificado. A operação substitui todos os campos existentes no documento de entrada, incluindo o campo _id. Especifique um documento incorporado no documento de entrada para promover o documento incorporado ao nível superior.

$replaceWith é um alias para o estágio $replaceRoot.

$replaceWith

Substitui um documento pelo documento incorporado especificado. A operação substitui todos os campos existentes no documento de entrada, incluindo o campo _id. Especifique um documento incorporado no documento de entrada para promover o documento incorporado ao nível superior.

$replaceWith é um alias para o estágio $replaceRoot.

$sample

Seleciona aleatoriamente o número especificado de documentos de sua entrada.

$set

Adiciona novos campos aos documentos. Semelhante ao $project, $set remodela cada documento no fluxo; especificamente, adicionando novos campos aos documentos de saída que contêm os campos existentes dos documentos de entrada e os campos recém-adicionados.

$set é um alias para o estágio $addFields.

$setWindowFields

Agrupa documentos em janelas e aplica um ou mais operadores aos documentos em cada janela.

$skip

Ignora os primeiros n documentos, em que n é o número de pulos especificado, e passa os documentos restantes sem modificações para o pipeline. Para cada documento de entrada, produz zero documentos (para os primeiros n documentos) ou um documento (se após os primeiros n documentos).

$sort

Reordena o fluxo de documentos por uma chave de classificação especificada. Apenas a ordem muda; os documentos permanecem inalterados. Para cada documento de entrada, gera um documento.

$sortByCount

Agrupa documentos recebidos com base no valor de uma expressão especificada e, em seguida, calcula a contagem de documentos em cada grupo distinto.

$unionWith

Realiza uma união de duas collections; ou seja, combina os resultados do pipeline de duas collections ou visualizações em um único conjunto de resultados.

$unset

Remove/exclui campos dos documentos.

$unset é um alias para o estágio $project que remove campos.

$unwind

Desconstrói um campo de array a partir dos documentos de entrada para gerar um documento para cada elemento. Cada documento de saída substitui a array por um valor de elemento. Para cada documento de entrada, produz n documentos onde n é o número de elementos de array e pode ser zero para uma array vazia.

$changeStream

Retorna um cursor Alterar coluna para a coleção. Esse estágio só pode ocorrer uma vez em um pipeline de agregação e deve ocorrer como o primeiro estágio.

$changeStreamSplitLargeEvent

Divide change stream grandes que excedem 16 MB em fragmentos menores retornados em um cursor de change stream de alterações.

Você só pode usar $changeStreamSplitLargeEvent em um pipeline $changeStream e ele deve ser o estágio final no pipeline.

$rankFusion

Combina os resultados de pipelines de entrada que classificam documentos. $rankFusion elimina a duplicação dos resultados do pipeline de entrada e usa o algoritmo Reciprocal Rank Fusion para criar uma classificação final do documento.

$search

Realiza uma procurar de texto completo do campo ou campos em uma coleção.

Para saber mais, consulte Estágios de aggregation pipeline do MongoDB Search.

$searchMeta

Retorna diferentes tipos de documentos de resultado de metadados para a query de pesquisa do MongoDB Search em relação a uma coleção do Atlas. Para saber mais, consulte Estágios de aggregation pipeline do MongoDB Search.

$vectorSearch

Executa uma procurar ANN ou ENN em um vetor no campo especificado de uma collection do Atlas .

$vectorSearch está disponível apenas para clusters do MongoDB Atlas que executam o MongoDB v6.0.11 ou superior e não está disponível para implantações autogerenciadas.

$collStats

Retorna estatísticas sobre uma coleção ou visualização.

$currentOp

Retorna informações sobre operações ativas e/ou dormentes para a implementação do MongoDB.

Uses the db.aggregate() method instead of the db.collection.aggregate() method.

$indexStats

Retorna estatísticas sobre o uso de cada índice para a coleção.

$listClusterCatalog

Recupera informações para collections em um cluster, incluindo nomes e opções de criação.

$listLocalSessions

Lista todas as sessões ativas recentemente em uso na mongos ou instânciamongod conectada no momento. Essas sessões podem ainda não ter sido propagadas para a coleção system.sessions.

Uses the db.aggregate() method instead of the db.collection.aggregate() method.

$listSampledQueries

Lista queries de amostra para todas as collections ou para uma collection específica.

$listSearchIndexes

Retorna informações sobre índices de pesquisa MongoDB existentes em uma coleção ou visualização especificada.

$listSessions

Lista todas as sessões que estão ativas há muito tempo para propagar para a coleção system.sessions.

$planCacheStats

Retorna informações de cache do plano para uma coleção.

$querySettings

Retorna as configurações de query adicionadas anteriormente com setQuerySettings.

$queryStats

Retorna estatísticas de tempo de execução para query registradas.

AVISO: o $queryStats estágio de agregação não é suportado e não é garantido que será estável em uma versão futura. Não crie uma funcionalidade que dependa de um formato de saída específico deste estágio, pois a saída pode mudar em uma versão futura.

$shardedDataDistribution

Retorna informações sobre a distribuição de dados em coleções fragmentadas.

Uses the db.aggregate() method instead of the db.collection.aggregate() method.