Operadores pipeline de agregação

O MongoDB 5.0 é o fim da vida útil a partir de de 2024 outubro. Esta versão da documentação não é mais suportada. Para atualizar sua 5.0 implantação do, consulte o MongoDB 6.0 procedimentos de atualização.

Os operadores de pipeline de agregação são compatíveis com o MongoDB Atlas e ambientes locais.

Observação

Para obter detalhes sobre um operador específico, incluindo sintaxe e exemplos, clique no link para a página de referência do operador.

Compatibilidade

Você pode usar os operadores de pipeline de agregação 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

Operadores de Expressão

Esses operadores de expressão estão disponíveis para construir expressões para uso nos estágios do pipeline de agregação.

As expressões de operadores são semelhantes às funções que aceitam argumentos. Em geral, estas expressões tomam uma matriz de argumentos e têm a seguinte forma:

{ <operator>: [ <argument1>, <argument2> ... ] }

Se o operador aceitar um único argumento, você poderá omitir a matriz externa designando a lista de argumentos:

{ <operator>: <argument> }

Para evitar a ambiguidade de análise se o argumento for uma array literal, você deve envolver a array literal em uma expressão $literal ou manter a array externa que designa a lista de argumentos.

Operadores de expressões aritméticas

Expressões aritméticas executam operações matemáticas em números. Algumas expressões aritméticas também podem suportar aritmética de datas.

Nome	Descrição
`$abs`	Retorna o valor absoluto de um número.
`$add`	Adiciona números para retornar a soma ou adiciona números e uma data para retornar uma nova data. Se adicionar números e uma data, trata os números como milissegundos. Aceita qualquer número de expressões de argumentos, mas, no máximo, uma expressão pode ser resolvida para uma data.
`$ceil`	Retorna o menor número inteiro maior ou igual ao número especificado.
`$divide`	Retorna o resultado da divisão do primeiro número pelo segundo. Aceita duas expressões de argumento.
`$exp`	Aumenta e para o expoente especificado.
`$floor`	Retorna o maior número inteiro menor ou igual ao número especificado.
`$ln`	Calcula o registro natural de um número.
`$log`	Calcula o registro de um número na base especificada.
`$log10`	Calcula a base de log 10 de um número.
`$mod`	Retorna o restante do primeiro número dividido pelo segundo. Aceita duas expressões de argumento.
`$multiply`	Multiplica números para devolver o produto. Aceita qualquer número de expressões de argumento.
`$pow`	Cria um número para o expoente especificado.
`$round`	Arredonda um número para um inteiro inteiro ou para uma casa decimal especificada.
`$sqrt`	Calcula a raiz quadrada.
`$subtract`	Retorna o resultado da subtração do segundo valor do primeiro. Se os dois valores forem números, retorne a diferença. Se os dois valores forem datas, retorne a diferença em milissegundos. Se os dois valores forem uma data e um número em milissegundos, retorne a data resultante. Aceita duas expressões de argumentos. Se os dois valores forem uma data e um número, especifique o argumento de data primeiro, pois ele não é significativo para subtrair uma data de um número.
`$trunc`	Trunca um número para um inteiro ou para uma casa decimal especificada.

Operadores de expressão de array

Nome	Descrição
`$arrayElemAt`	Retorna o elemento no índice de array especificado.
`$arrayToObject`	Converte uma array de pares de valores chave em um documento.
`$concatArrays`	Concatena arrays para retornar a array concatenada.
`$filter`	Seleciona um subconjunto da matriz para retornar uma matriz com apenas os elementos que correspondem à condição do filtro.
`$first`	Retorna o primeiro elemento da array. Distinto do acumulador `$first` .
`$in`	Retorna um booleano indicando se um valor especificado está em uma matriz.
`$indexOfArray`	Pesquisa uma matriz para uma ocorrência de um valor especificado e retorna o índice da matriz da primeira ocorrência. Se a substring não for encontrada, retorna `-1`.
`$isArray`	Determina se o operando é um array. Retorna um booleano.
`$last`	Retorna o último elemento da matriz. Distinto do acumulador `$last` .
`$map`	Aplica uma subexpressão a cada elemento de uma matriz e retorna a matriz de valores resultantes em ordem. Aceita parâmetros nomeados.
`$objectToArray`	Converte um documento em uma matriz de documentos representando pares chave/valor.
`$range`	Entrai uma matriz contendo uma sequência de inteiros de acordo com entradas definidas pelo usuário.
`$reduce`	Aplica uma expressão para cada elemento em uma matriz e a combina em um único valor.
`$reverseArray`	Retorna uma array com os elementos em ordem inversa.
`$size`	Retorna o número de elementos na matriz. Aceita uma única expressão como argumento.
`$slice`	Retorna um subconjunto de uma array.
`$zip`	Mesclar dois arrays juntos.

Operadores de expressão booleana

Expressões booleanas avaliam suas expressões argumentais como booleanas e retornam um booleano como resultado.

Além do valor booleano false, a expressão booleana avalia como false os seguintes valores: null, 0 e undefined. A expressão booleana avalia todos os outros valores como true, incluindo valores numéricos diferentes de zero e arrays.

Nome	Descrição
`$and`	Retorna `true` somente quando todas suas expressões avaliam para `true`. Aceita qualquer número de expressões de argumento.
`$not`	Retorna o valor booleano que é o oposto da expressão do seu argumento. Aceita uma única expressão de argumento.
`$or`	Retorna `true` quando qualquer de suas expressões avalia para `true`. Aceita qualquer número de expressões de argumento.

Operadores de expressão de comparação

As expressões de comparação retornam um booleano, exceto para $cmp que retorna um número.

As expressões de comparação usam duas expressões de argumento e comparam valor e tipo, usando a ordem de comparação BSON especificada para valores de tipos diferentes.

Nome	Descrição
`$cmp`	Retorna `0` se os dois valores forem equivalentes, `1` se o primeiro valor for maior que o segundo, e `-1` se o primeiro valor for menor que o segundo.
`$eq`	Retorna `true` se os valores forem equivalentes.
`$gt`	Retorna `true` se o primeiro valor for maior que o segundo.
`$gte`	Retorna `true` se o primeiro valor for maior ou igual ao segundo.
`$lt`	Retorna `true` se o primeiro valor for menor que o segundo.
`$lte`	Retorna `true` se o primeiro valor for menor ou igual ao segundo.
`$ne`	Retorna `true` se os valores não forem equivalentes.

Operadores de Expressão Condicional

Nome	Descrição
`$cond`	Um operador ternário que avalia uma expressão e, dependendo do resultado, retorna o valor de uma das outras duas expressões. Aceita três expressões em uma lista ordenada ou três parâmetros nomeados.
`$ifNull`	Retorna o resultado não nulo da primeira expressão ou o resultado da segunda expressão se a primeira expressão resultar em um resultado nulo. O resultado nulo engloba instâncias de valores indefinidos ou campos ausentes. Aceita duas expressões como argumentos. O resultado da segunda expressão pode ser nulo.
`$switch`	Avalia uma série de expressões de caso. Quando encontra uma expressão que avalia para `true`, o `$switch` executa uma expressão especificada e quebra o fluxo de controle.

Operadores de expressão de agregação personalizada

Nome	Descrição
`$accumulator`	Define uma função de acumulação personalizada.
`$function`	Define uma função personalizada.

Operadores de Tamanho de Dados

Os seguintes operadores retornam o tamanho de um elemento de dados:

Nome	Descrição
`$binarySize`	Retorna o tamanho de uma determinada string ou o conteúdo do valor dos dados binários em bytes.
`$bsonSize`	Retorna o tamanho em bytes de determinado documento (ou seja, bsontype `Object`) quando codificado como BSON.

Operadores de Expressão de Data

Os seguintes operadores retornam objetos de data ou componentes de um objeto de data:

Nome	Descrição
`$dateAdd`	Adiciona uma série de unidades de tempo a um objeto de data.
`$dateDiff`	Retorna a diferença entre duas datas.
`$dateFromParts`	Constrói um objeto BSON Date considerando as peças constituintes da data.
`$dateFromString`	Converte uma string de data/hora em um objeto de data.
`$dateSubtract`	Subtrai uma série de unidades de tempo de um objeto de data.
`$dateToParts`	Retorna um documento contendo as partes constituintes de uma data.
`$dateToString`	Retorna a data como uma string formatada.
`$dateTrunc`	Trunca uma data.
`$dayOfMonth`	Retorna o dia do mês para uma data como um número entre 1 e 31.
`$dayOfWeek`	Retorna o dia da semana para uma data como um número entre 1 (Domingo) e 7 (Sábado).
`$dayOfYear`	Retorna o dia do ano para uma data como um número entre 1 e 366 (ano bissexto).
`$hour`	Retorna a hora para uma data como um número entre 0 e 23.
`$isoDayOfWeek`	Retorna o número do dia da semana no formato ISO 8601, que varia de `1` (para segunda-feira) a `7` (para domingo).
`$isoWeek`	Retorna o número da semana no formato ISO 8601, que varia de `1` a `53`. Os números da semana começam em `1` com a semana (de segunda a domingo) que contém a primeira quinta-feira do ano.
`$isoWeekYear`	Retorna o número do ano no formato ISO 8601. O ano começa com a segunda-feira da semana 1 (ISO 8601) e termina com o domingo da última semana (ISO 8601).
`$millisecond`	Retorna milissegundos de uma data como um número entre 0 e 999.
`$minute`	Retorna o minuto para uma data como um número entre 0 e 59.
`$month`	Retorna o mês para uma data como um número entre 1 (janeiro) e 12 (dezembro).
`$second`	Retorna os segundos para uma data como um número entre 0 e 60 (segundos bissextos).
`$toDate`	Converte o valor para uma data.
`$week`	Retorna o número da semana para uma data como um número entre 0 (a semana parcial que precede o primeiro domingo do ano) e 53 (ano bissexto).
`$year`	Retorna o ano para uma data como um número (por exemplo, 2014).

Os seguintes operadores aritméticos podem tomar operandos de data:

Nome	Descrição
`$add`	Adiciona números e uma data para retornar uma nova data. Se adicionar números e uma data, trata os números como milissegundos. Aceita qualquer número de expressões de argumento, mas, no máximo, uma expressão pode ser resolvida para uma data.
`$subtract`	Retorna o resultado da subtração do segundo valor do primeiro. Se os dois valores forem datas, retorne a diferença em milissegundos. Se os dois valores forem uma data e um número em milissegundos, retorne a data resultante. Aceita duas expressões de argumentos. Se os dois valores forem uma data e um número, especifique o argumento de data primeiro, pois não é significativo subtrair uma data de um número.

Nome

Descrição

$add

Adiciona números e uma data para retornar uma nova data. Se adicionar números e uma data, trata os números como milissegundos. Aceita qualquer número de expressões de argumento, mas, no máximo, uma expressão pode ser resolvida para uma data.

$subtract

Retorna o resultado da subtração do segundo valor do primeiro. Se os dois valores forem datas, retorne a diferença em milissegundos. Se os dois valores forem uma data e um número em milissegundos, retorne a data resultante. Aceita duas expressões de argumentos. Se os dois valores forem uma data e um número, especifique o argumento de data primeiro, pois não é significativo subtrair uma data de um número.

Operador de expressão literal

Nome	Descrição
`$literal`	Devolva um valor sem analisar. Use para valores que o pipeline de agregação pode interpretar como uma expressão. Por exemplo, use uma expressão `$literal` em uma string que comece com um cifrão (`$`) para evitar a análise como um caminho de campo.

Operadores diversos

Nome	Descrição
`$getField`	Retorna o valor de um campo especificado de um documento. Você pode usar `$getField` para recuperar o valor de campos com nomes que contenham pontos (`.`) ou comecem com cifrões (`$`). Novidades na versão 5.0.
`$rand`	Retorna uma flutuação aleatória entre 0 e 1
`$sampleRate`	Selecione documentos aleatoriamente a uma determinada taxa. Embora o exato número de documentos selecionados varie em cada execução, a quantidade escolhida aproxima-se da taxa de amostragem expressa em percentagem do número total de documentos.

Operadores de expressão de objeto

Nome	Descrição
`$mergeObjects`	Combina vários documentos em um único documento. Novidade na versão 3.6.
`$objectToArray`	Converte um documento em uma matriz de documentos representando pares chave/valor. Novidade na versão 3.6.
`$setField`	Adiciona, atualiza ou remove um campo especificado em um documento. Você pode usar `$setField` para adicionar, atualizar ou remover campos com nomes que contenham pontos (`.`) ou começar com cifrões (`$`). Novidades na versão 5.0.

Definir operadores de expressão

Expressões de conjunto executam operações de conjunto em matrizes, tratando matrizes como conjuntos. Definir expressões ignora as entradas duplicadas em cada matriz de entrada e a ordem dos elementos.

Se a operação de definição retornar um conjunto, a operação filtrará duplicatas no resultado para gerar uma matriz que contenha apenas entradas exclusivas. A ordem dos elementos na matriz de saída não é especificada.

Se um conjunto contiver um elemento de array aninhada, a expressão set não desce para a array aninhada, mas avalia a array no nível superior.

Nome	Descrição
`$allElementsTrue`	Retorna `true` se não elemento de um conjunto avaliar para `false`, caso contrário, retorna `false`. Aceita uma única expressão de argumento.
`$anyElementTrue`	Retorna `true` se qualquer elemento de um conjunto avaliar para `true`; caso contrário, retorna `false`. Aceita uma única expressão de argumento.
`$setDifference`	Retorna um conjunto com elementos que aparecem no primeiro conjunto mas não no segundo conjunto; ou seja, executa um complemento relativo do segundo conjunto em relação ao primeiro. Aceita exatamente duas expressões de argumento.
`$setEquals`	Retorna `true` se os conjuntos de entrada tiverem os mesmos elementos distintos. Aceita duas ou mais expressões de argumento.
`$setIntersection`	Retorna um conjunto com elementos que aparecem em todos os conjuntos de entrada. Aceita qualquer número de expressões de argumento.
`$setIsSubset`	Retorna `true` se todos os elementos do primeiro conjunto aparecerem no segundo conjunto, incluindo quando o primeiro for igual ao segundo; ou seja, não é um subconjunto estrito. Aceita exatamente duas expressões de argumento.
`$setUnion`	Retorna um conjunto com elementos que aparecem em qualquer conjunto de entrada.

Operadores de expressão de string

As expressões de string, com exceção de $concat, só têm um comportamento bem definido para string ASCII.

$concat o comportamento é bem definido independentemente dos caracteres usados.

Nome	Descrição
`$concat`	Concatena qualquer número de strings.
`$dateFromString`	Converte uma string de data/hora em um objeto de data.
`$dateToString`	Retorna a data como uma string formatada.
`$indexOfBytes`	Pesquisa uma string para uma ocorrência de uma substring e retorna o índice de bytes UTF-8 da primeira ocorrência. Se a substring não for encontrada, retorna `-1`.
`$indexOfCP`	Procura uma string para uma ocorrência de uma substring e retorna o índice de ponto do código UTF-8 da primeira ocorrência. Se a substring não for encontrada, retorna `-1`
`$ltrim`	Remove o espaço em branco ou os caracteres especificados do início de uma string.
`$regexFind`	Aplica uma expressão regular (regex) a uma string e retorna informações sobre a primeira substring correspondente.
`$regexFindAll`	Aplica uma expressão regular (regex) a uma string e retorna informações sobre todas as substrings correspondentes.
`$regexMatch`	Aplica uma expressão regular (regex) a uma string e retorna um booleano que indica se uma correspondência foi encontrada ou não.
`$replaceOne`	Substitui a primeira instância de uma string correspondente em uma determinada entrada.
`$replaceAll`	Substitui todas as instâncias de uma string correspondente em uma determinada entrada.
`$rtrim`	Remove o espaço em branco ou os caracteres especificados do final de uma string.
`$split`	Divide uma string em substrings com base em um delimitador. Retorna uma matriz de substrings. Se o delimitador não for encontrado dentro da string, retorna uma matriz contendo a string original.
`$strLenBytes`	Retorna o número de bytes codificados UTF-8 em uma string.
`$strLenCP`	Retorna o número de pontos de código UTF-8 em uma string.
`$strcasecmp`	Executa a comparação de string sem distinção de maiúsculas e minúsculas e retorna: `0` se duas strings forem equivalentes, `1` se a primeira string for maior que a segunda e `-1` se a primeira string for menor que a segunda.
`$substr`	Obsoleto. Use `$substrBytes` ou `$substrCP`.
`$substrBytes`	Retorna a substring de uma string. Começa com o caractere no índice de byte UTF-8 especificado (baseado em zero) na string e continua pelo número de bytes especificado.
`$substrCP`	Retorna a substring de uma string. Começa com o caractere no índice (baseado em zero) do ponto de código (code point) UTF-8 especificado na string e continua com o número de pontos de código especificado.
`$toLower`	Converte uma string em minúsculas. Aceita uma única expressão de argumento.
`$toString`	Converte o valor para uma string.
`$trim`	Remove o espaço em branco ou os caracteres especificados do início e fim de uma string.
`$toUpper`	Converte uma string em maiúsculas. Aceita uma única expressão de argumento.

Operador de expressão de texto

Nome	Descrição
`$meta`	Acesse os metadados disponíveis por documento relacionados à operação de agregação.

Operadores de expressão de trigonometria

Expressões de trigonometria executam operações trigonométricas em números. Os valores que representam ângulos são sempre de entrada ou saída em radianos. Use $degreesToRadians e $radiansToDegrees para converter entre medidas de grau e radianos.

Nome	Descrição
`$sin`	Retorna o seno de um valor que é medido em radianos.
`$cos`	Retorna o cosseno de um valor medido em radianos.
`$tan`	Retorna a tangente de um valor que é medido em radianos.
`$asin`	Retorna o seno inverso (arco seno) de um valor em radianos.
`$acos`	Retorna o cosseno inverso (arco cosseno) de um valor em radianos.
`$atan`	Retorna a tangente inversa (arco tangente) de um valor em radianos.
`$atan2`	Retorna a tangente inversa (arco tangente) de `y / x` em radianos, em que `y` e `x` são o primeiro e o segundo valores passados para a expressão, respectivamente.
`$asinh`	Retorna o seno hiperbólico inverso (arco seno hiperbólico) de um valor em radianos.
`$acosh`	Retorna o cosseno hiperbólico inverso (arco cosseno hiperbólico) de um valor em radianos.
`$atanh`	Retorna a tangente hiperbólica inversa (arco tangente hiperbólico) de um valor em radianos.
`$sinh`	Retorna o seno hiperbólico de um valor medido em radianos.
`$cosh`	Retorna o cosseno hiperbólico de um valor medido em radianos.
`$tanh`	Retorna a tangente hiperbólica de um valor medido em radianos.
`$degreesToRadians`	Converte um valor de graus para radianos.
`$radiansToDegrees`	Converte um valor de radianos para graus.

Operadores de expressão de tipo

Nome	Descrição
`$convert`	Converte um valor para um tipo especificado.
`$isNumber`	Retorna booleano `true` se a expressão especificada produzir um `integer`, `decimal`, `double` ou `long`. Retorna o booleano `false` se a expressão produzir qualquer outro tipo BSON, `null` ou um campo ausente.
`$toBool`	Converte o valor em booleano.
`$toDate`	Converte o valor para uma data.
`$toDecimal`	Converte o valor para um Decimal128.
`$toDouble`	Converte o valor em double.
`$toInt`	Converte o valor para um número inteiro.
`$toLong`	Converte o valor para um longo.
`$toObjectId`	Converte o valor para um ObjectId.
`$toString`	Converte o valor para uma string.
`$type`	Retorne o tipo de dados BSON do campo.

Acumuladores (`$group, $bucket, $bucketAuto, $setWindowFields`)

Operadores acumuladores de agregação:

Mantenha seu estado à medida que os documentos progridem no pipeline da agregação.
Retornar totais, maxima, minima e outros valores.
Pode ser usado nestes estágios do pipeline de agregação:
- $bucket
- $bucketAuto
- $group
- $setWindowFields a partir do MongoDB 5.0 (exceto quando você estiver usando os operadores $accumulator ou , que não $mergeObjects $setWindowFields podem ser usados com )

Alterado na versão 5.0.

Nome	Descrição
`$accumulator`	Retorna o resultado de uma função de acumulador definida pelo usuário.
`$addToSet`	Retorna uma array de valores de expressão exclusivos para cada grupo. A ordem dos elementos da array é indefinida. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$avg`	Retorna uma média de valores numéricos. Ignora valores não numéricos. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$count`	Retorna o número de documentos em um grupo. Diferente do estágio `$count` do pipeline. Novidade na versão 5.0: Disponível nos estágios `$group` e `$setWindowFields`.
`$first`	Retorna o resultado de uma expressão para o primeiro documento em um grupo. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$last`	Retorna o resultado de uma expressão para o último documento em um grupo. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$max`	Retorna o valor de expressão mais alto para cada grupo. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$mergeObjects`	Retorna um documento criado combinando os documentos de entrada de cada grupo.
`$min`	Retorna o valor de expressão mais baixo para cada grupo. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$push`	Retorna uma matriz de valores de expressão para documentos em cada grupo. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$stdDevPop`	Retorna o desvio padrão da população dos valores de entrada. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$stdDevSamp`	Retorna o desvio padrão da amostra dos valores de entrada. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$sum`	Retorna uma soma de valores numéricos. Ignora valores não numéricos. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.

Acumuladores (em outras etapas)

Alguns operadores que estão disponíveis como acumuladores para o estágio $group também estão disponíveis para uso em outros estágios, mas não como acumuladores. Quando usados nesses outros estágios, esses operadores não mantêm seu estado e podem receber como entrada um único argumento ou vários argumentos. Para obter detalhes, consulte a página do operador específico.

Alterado na versão 5.0.

Os seguintes operadores acumuladores também estão disponíveis nos estágios $project, $addFields, $set e, começando no MongoDB 5.0, $setWindowFields.

Nome	Descrição
`$avg`	Retorna uma média da expressão especificada ou lista de expressões para cada documento. Ignora valores não numéricos.
`$first`	Retorna o resultado de uma expressão para o primeiro documento em um grupo.
`$last`	Retorna o resultado de uma expressão para o último documento em um grupo.
`$max`	Retorna o máximo da expressão especificada ou lista de expressões para cada documento
`$min`	Retorna o mínimo da expressão especificada ou lista de expressões para cada documento
`$stdDevPop`	Retorna o desvio padrão da população dos valores de entrada.
`$stdDevSamp`	Retorna o desvio padrão da amostra dos valores de entrada.
`$sum`	Retorna uma soma de valores numéricos. Ignora valores não numéricos.

Operadores de expressão variável

Nome	Descrição
`$let`	Define variáveis para uso dentro do escopo de uma subexpressão e retorna o resultado da subexpressão. Aceita parâmetros nomeados. Aceita qualquer número de expressões de argumento.

Operadores de Janela

Novidades na versão 5.0.

Os operadores de janelas retornam valores de uma extensão definida de documentos de uma coleção, conhecida como janela. Uma janela é definida no estágio $setWindowFields, disponível a partir do MongoDB 5.0.

Os seguintes operadores de janela estão disponíveis na etapa $setWindowFields.

Nome	Descrição
`$addToSet`	Retorna uma array de todos os valores únicos que resultam da aplicação de uma expressão a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$avg`	Retorna a média da expressão especificada. Ignora valores não numéricos. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$count`	Retorna o número de documentos no grupo ou janela. Diferente do estágio `$count` do pipeline. Novidades na versão 5.0.
`$covariancePop`	Retorna a covariância populacional de duas expressões numéricas. Novidades na versão 5.0.
`$covarianceSamp`	Retorna a covariância de amostra de duas expressões numéricas. Novidades na versão 5.0.
`$denseRank`	Retorna a posição do documento (conhecida como classificação) relativa a outros documentos na `$setWindowFields` partição de estágio. Não há lacunas nas classificações. Os empates recebem a mesma classificação. Novidades na versão 5.0.
`$derivative`	Retorna a taxa média de alteração dentro da janela especificada. Novidades na versão 5.0.
`$documentNumber`	Retorna a posição de um documento (conhecido como o número do documento) na partição de estágio `$setWindowFields` . Vínculos resultam em diferentes números de documentos adjacentes. Novidades na versão 5.0.
`$expMovingAvg`	Retorna a média móvel exponencial da expressão numérica. Novidades na versão 5.0.
`$first`	Retorna o resultado de uma expressão para o primeiro documento em um grupo ou janela. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$integral`	Retorna a aproximação da área abaixo de uma curva. Novidades na versão 5.0.
`$last`	Retorna o resultado de uma expressão para o último documento em um grupo ou janela. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$max`	Retorna o valor máximo resultante da aplicação de uma expressão a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$min`	Retorna o valor mínimo que resulta da aplicação de uma expressão a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$push`	Retorna uma array de valores que resultam da aplicação de uma expressão a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$rank`	Retorna a posição do documento (conhecida como classificação) em relação a outros documentos na partição `$setWindowFields` de estágio . Novidades na versão 5.0.
`$shift`	Retorna o valor de uma expressão aplicada a um documento em uma posição especificada em relação ao documento atual na `$setWindowFields` partição de estágio . Novidades na versão 5.0.
`$stdDevPop`	Retorna o desvio padrão da população a partir de uma expressão numérica aplicada a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$stdDevSamp`	Retorna o desvio padrão da amostra a partir de uma expressão numérica aplicada a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.
`$sum`	Retorna a soma dos resultados ao aplicar uma expressão numérica a cada documento. Alterado na versão 5.0: Disponível no estágio `$setWindowFields`.

Lista alfabética de operadores de expressão

Nome	Descrição
`$abs`	Retorna o valor absoluto de um número.
`$accumulator`	Retorna o resultado de uma função de acumulador definida pelo usuário.
`$acos`	Retorna o cosseno inverso (arco cosseno) de um valor em radianos.
`$acosh`	Retorna o cosseno hiperbólico inverso (arco cosseno hiperbólico) de um valor em radianos.
`$add`	Adiciona números para retornar a soma ou adiciona números e uma data para retornar uma nova data. Se adicionar números e uma data, trata os números como milissegundos. Aceita qualquer número de expressões de argumentos, mas, no máximo, uma expressão pode ser resolvida para uma data.
`$addToSet`	Retorna uma array de valores de expressão exclusivos para cada grupo. A ordem dos elementos da array é indefinida. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$allElementsTrue`	Retorna `true` se não elemento de um conjunto avaliar para `false`, caso contrário, retorna `false`. Aceita uma única expressão de argumento.
`$and`	Retorna `true` somente quando todas suas expressões avaliam para `true`. Aceita qualquer número de expressões de argumento.
`$anyElementTrue`	Retorna `true` se qualquer elemento de um conjunto avaliar para `true`; caso contrário, retorna `false`. Aceita uma única expressão de argumento.
`$arrayElemAt`	Retorna o elemento no índice de array especificado.
`$arrayToObject`	Converte uma array de pares de valores chave em um documento.
`$asin`	Retorna o seno inverso (arco seno) de um valor em radianos.
`$asinh`	Retorna o seno hiperbólico inverso (seno do arco hiperbólico) de um valor em radianos.
`$atan`	Retorna a tangente inversa (arco tangente) de um valor em radianos.
`$atan2`	Retorna a tangente inversa (arco tangente) de `y / x` em radianos, em que `y` e `x` são o primeiro e o segundo valores passados para a expressão, respectivamente.
`$atanh`	Retorna a tangente hiperbólica inversa (arco tangente hiperbólico) de um valor em radianos.
`$avg`	Retorna uma média de valores numéricos. Ignora valores não numéricos. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$binarySize`	Retorna o tamanho de uma determinada string ou o conteúdo do valor dos dados binários em bytes. Novidades na versão 4.4.
`$bsonSize`	Retorna o tamanho em bytes de determinado documento (ou seja, bsontype `Object`) quando codificado como BSON. Novidades na versão 4.4.
`$ceil`	Retorna o menor número inteiro maior ou igual ao número especificado.
`$cmp`	Retorna: `0` se os dois valores forem equivalentes, `1` se o primeiro valor for maior que o segundo, e `-1` se o primeiro valor for menor que o segundo.
`$concat`	Concatena qualquer número de strings.
`$concatArrays`	Concatena arrays para retornar a array concatenada.
`$cond`	Um operador ternário que avalia uma expressão e, dependendo do resultado, retorna o valor de uma das outras duas expressões. Aceita três expressões em uma lista ordenada ou três parâmetros nomeados.
`$convert`	Converte um valor para um tipo especificado.
`$cos`	Retorna o cosseno de um valor medido em radianos.
`$cosh`	Retorna o cosseno hiperbólico de um valor medido em radianos.
`$count`	Retorna o número de documentos no grupo ou janela. Novidade na versão 5.0: disponível nos estágios `$group` e `$setWindowFields` . Diferente do estágio `$count` do pipeline.
`$covariancePop`	Retorna a covariância populacional de duas expressões numéricas. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$covarianceSamp`	Retorna a covariância de amostra de duas expressões numéricas. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$dateAdd`	Adiciona uma série de unidades de tempo a um objeto de data.
`$dateDiff`	Retorna a diferença entre duas datas.
`$dateFromParts`	Constrói um objeto BSON Date considerando as peças constituintes da data.
`$dateSubtract`	Subtrai uma série de unidades de tempo de um objeto de data.
`$dateTrunc`	Trunca uma data.
`$dateToParts`	Retorna um documento contendo as partes constituintes de uma data.
`$dateFromString`	Retorna uma data/hora como um objeto de data.
`$dateToString`	Retorna a data como uma string formatada.
`$dayOfMonth`	Retorna o dia do mês para uma data como um número entre 1 e 31.
`$dayOfWeek`	Retorna o dia da semana para uma data como um número entre 1 (Domingo) e 7 (Sábado).
`$dayOfYear`	Retorna o dia do ano para uma data como um número entre 1 e 366 (ano bissexto).
`$degreesToRadians`	Converte um valor de graus para radianos.
`$denseRank`	Retorna a posição relativa de um documento classificado. Não há lacunas nas posições. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$derivative`	Retorna a taxa média de alteração dentro da janela especificada. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$divide`	Retorna o resultado da divisão do primeiro número pelo segundo. Aceita duas expressões de argumento.
`$documentNumber`	Retorna a posição de um documento (conhecido como o número do documento) na partição. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$eq`	Retorna `true` se os valores forem equivalentes.
`$exp`	Aumenta e para o expoente especificado.
`$expMovingAvg`	Retorna a média móvel exponencial da expressão numérica. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$filter`	Seleciona um subconjunto da matriz para retornar uma matriz com apenas os elementos que correspondem à condição do filtro.
`$first`	Retorna um valor do primeiro documento para cada grupo. A ordem só é definida se os documentos estiverem ordenados. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$floor`	Retorna o maior número inteiro menor ou igual ao número especificado.
`$function`	Define uma função de agregação personalizada. Novidades na versão 4.4.
`$getField`	Retorna o valor de um campo especificado de um documento. Você pode usar `$getField` para recuperar o valor de campos com nomes que contenham pontos (`.`) ou comecem com cifrões (`$`).
`$gt`	Retorna `true` se o primeiro valor for maior que o segundo.
`$gte`	Retorna `true` se o primeiro valor for maior ou igual ao segundo.
`$hour`	Retorna a hora para uma data como um número entre 0 e 23.
`$ifNull`	Retorna o resultado não nulo da primeira expressão ou o resultado da segunda expressão se a primeira expressão resultar em um resultado nulo. O resultado nulo engloba instâncias de valores indefinidos ou campos ausentes. Aceita duas expressões como argumentos. O resultado da segunda expressão pode ser nulo.
`$in`	Retorna um booleano indicando se um valor especificado está em uma matriz.
`$indexOfArray`	Pesquisa uma matriz para uma ocorrência de um valor especificado e retorna o índice da matriz da primeira ocorrência. Se a substring não for encontrada, retorna `-1`.
`$indexOfBytes`	Pesquisa uma string para uma ocorrência de uma substring e retorna o índice de bytes UTF-8 da primeira ocorrência. Se a substring não for encontrada, retorna `-1`.
`$indexOfCP`	Pesquisa uma string para uma ocorrência de uma substring e retorna o índice de ponto do código UTF-8 da primeira ocorrência. Se a substring não for encontrada, retorna `-1`.
`$integral`	Retorna a aproximação da área abaixo de uma curva. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$isArray`	Determina se o operando é um array. Retorna um booleano.
`$isNumber`	Determina se a expressão é resolvida para um número inteiro, duplo, decimal ou longo.
`$isoDayOfWeek`	Retorna o número do dia da semana no formato ISO 8601, que varia de `1` (para segunda-feira) a `7` (para domingo).
`$isoWeek`	Retorna o número da semana no formato ISO 8601, que varia de `1` a `53`. Os números da semana começam em `1` com a semana (de segunda a domingo) que contém a primeira quinta-feira do ano.
`$isoWeekYear`	Retorna o número do ano no formato ISO 8601. O ano começa com a segunda-feira da semana 1 (ISO 8601) e termina com o domingo da última semana (ISO 8601).
`$last`	Retorna um valor do último documento para cada grupo. A ordem só é definida se os documentos estiverem ordenados. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$let`	Define variáveis para uso dentro do escopo de uma subexpressão e retorna o resultado da subexpressão. Aceita parâmetros nomeados. Aceita qualquer número de expressões de argumento.
`$literal`	Devolva um valor sem analisar. Use para valores que o aggregation pipeline pode interpretar como uma expressão. Por exemplo, use uma expressão `$literal` em uma string que comece com um `$` para evitar a análise como um caminho do campo.
`$ln`	Calcula o registro natural de um número.
`$log`	Calcula o registro de um número na base especificada.
`$log10`	Calcula a base de log 10 de um número.
`$lt`	Retorna `true` se o primeiro valor for menor que o segundo.
`$lte`	Retorna `true` se o primeiro valor for menor ou igual ao segundo.
`$ltrim`	Remove o espaço em branco ou os caracteres especificados do início de uma string.
`$map`	Aplica uma subexpressão a cada elemento de uma matriz e retorna a matriz de valores resultantes em ordem. Aceita parâmetros nomeados.
`$max`	Retorna o valor de expressão mais alto para cada grupo. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$mergeObjects`	Combina vários documentos em um único documento.
`$meta`	Acesse os metadados disponíveis por documento relacionados à operação de agregação.
`$min`	Retorna o valor de expressão mais baixo para cada grupo. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$millisecond`	Retorna milissegundos de uma data como um número entre 0 e 999.
`$minute`	Retorna o minuto para uma data como um número entre 0 e 59.
`$mod`	Retorna o restante do primeiro número dividido pelo segundo. Aceita duas expressões de argumento.
`$month`	Retorna o mês para uma data como um número entre 1 (janeiro) e 12 (dezembro).
`$multiply`	Multiplica números para devolver o produto. Aceita qualquer número de expressões de argumento.
`$ne`	Retorna `true` se os valores não forem equivalentes.
`$not`	Retorna o valor booleano que é o oposto da expressão do seu argumento. Aceita uma única expressão de argumento.
`$objectToArray`	Converte um documento em uma matriz de documentos representando pares chave/valor.
`$or`	Retorna `true` quando qualquer de suas expressões avalia para `true`. Aceita qualquer número de expressões de argumento.
`$pow`	Cria um número para o expoente especificado.
`$push`	Retorna uma matriz de valores de expressão para documentos em cada grupo. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$radiansToDegrees`	Converte um valor de radianos para graus.
`$rand`	gera uma flutuação aleatória entre 0 e 1.
`$range`	Entrai uma matriz contendo uma sequência de inteiros de acordo com entradas definidas pelo usuário.
`$rank`	Retorna a posição do documento (conhecida como classificação) em relação a outros documentos classificados. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$reduce`	Aplica uma expressão para cada elemento em uma matriz e a combina em um único valor.
`$regexFind`	Aplica uma expressão regular (regex) a uma string e retorna informações sobre a primeira substring correspondente.
`$regexFindAll`	Aplica uma expressão regular (regex) a uma string e retorna informações sobre todas as substrings correspondentes.
`$regexMatch`	Aplica uma expressão regular (regex) a uma string e retorna um booleano que indica se uma correspondência foi encontrada ou não.
`$replaceOne`	Substitui a primeira instância de uma string correspondente em uma determinada entrada. Novidades na versão 4.4.
`$replaceAll`	Substitui todas as instâncias de uma string correspondente em uma determinada entrada. Novidades na versão 4.4.
`$reverseArray`	Retorna uma array com os elementos em ordem inversa.
`$round`	Arredonda um número para um inteiro ou para uma casa decimal especificada.
`$rtrim`	Remove o espaço em branco ou os caracteres especificados do final de uma string.
`$sampleRate`	Selecione documentos aleatoriamente a uma determinada taxa. Embora o exato número de documentos selecionados varie em cada execução, a quantidade escolhida aproxima-se da taxa de amostragem expressa em percentagem do número total de documentos.
`$second`	Retorna os segundos para uma data como um número entre 0 e 60 (segundos bissextos).
`$setDifference`	Retorna um conjunto com elementos que aparecem no primeiro conjunto, mas não no segundo conjunto; isto é, executa um complemento relativo do segundo conjunto relativo ao primeiro. Aceita exatamente duas expressões de argumento.
`$setEquals`	Retorna `true` se os conjuntos de entrada tiverem os mesmos elementos distintos. Aceita duas ou mais expressões de argumento.
`$setField`	Adiciona, atualiza ou remove um campo especificado em um documento. Você pode usar `$setField` para adicionar, atualizar ou remover campos com nomes que contenham pontos (`.`) ou começar com cifrões (`$`). Novidades na versão 5.0.
`$setIntersection`	Retorna um conjunto com elementos que aparecem em todos os conjuntos de entrada. Aceita qualquer número de expressões de argumento.
`$setIsSubset`	Retorna `true` se todos os elementos do primeiro conjunto aparecerem no segundo conjunto, incluindo quando o primeiro for igual ao segundo; ou seja, não é um subconjunto estrito. Aceita exatamente duas expressões de argumento.
`$setUnion`	Retorna um conjunto com elementos que aparecem em qualquer conjunto de entrada.
`$shift`	Retorna o valor de uma expressão aplicada a um documento em uma posição especificada em relação ao documento atual na saída. Novidade na versão 5.0: disponível no estágio `$setWindowFields` .
`$size`	Retorna o número de elementos na matriz. Aceita uma única expressão como argumento.
`$sin`	Retorna o seno de um valor que é medido em radianos.
`$sinh`	Retorna o seno hiperbólico de um valor medido em radianos.
`$slice`	Retorna um subconjunto de uma array.
`$split`	Divide uma string em substrings com base em um delimitador. Retorna uma matriz de substrings. Se o delimitador não for encontrado dentro da string, retorna uma matriz contendo a string original.
`$sqrt`	Calcula a raiz quadrada.
`$stdDevPop`	Retorna o desvio padrão da população dos valores de entrada. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$stdDevSamp`	Retorna o desvio padrão da amostra dos valores de entrada. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$strcasecmp`	Executa a comparação de string sem distinção de maiúsculas e minúsculas e retorna: `0` se duas strings forem equivalentes, `1` se a primeira string for maior que a segunda e `-1` se a primeira string for menor que a segunda.
`$strLenBytes`	Retorna o número de bytes codificados UTF-8 em uma string.
`$strLenCP`	Retorna o número de pontos de código UTF-8 em uma string.
`$substr`	Obsoleto. Use `$substrBytes` ou `$substrCP`.
`$substrBytes`	Retorna a substring de uma string. Começa com o caractere no índice de byte UTF-8 especificado (baseado em zero) na string e continua pelo número de bytes especificado.
`$substrCP`	Retorna a substring de uma string. Começa com o caractere no índice (baseado em zero) do ponto de código (code point) UTF-8 especificado na string e continua com o número de pontos de código especificado.
`$subtract`	Retorna o resultado da subtração do segundo valor do primeiro. Se os dois valores forem números, retorne a diferença. Se os dois valores forem datas, retorne a diferença em milissegundos. Se os dois valores forem uma data e um número em milissegundos, retorne a data resultante. Aceita duas expressões de argumentos. Se os dois valores forem uma data e um número, especifique o argumento de data primeiro, pois ele não é significativo para subtrair uma data de um número.
`$sum`	Retorna uma soma de valores numéricos. Ignora valores não numéricos. Alterado na versão 5.0: disponível no estágio `$setWindowFields` .
`$switch`	Avalia uma série de expressões de caso. Quando encontra uma expressão que avalia para `true`, o `$switch` executa uma expressão especificada e quebra o fluxo de controle.
`$tan`	Retorna a tangente de um valor que é medido em radianos.
`$tanh`	Retorna a tangente hiperbólica de um valor medido em radianos.
`$toBool`	Converte o valor em booleano.
`$toDate`	Converte o valor para uma data.
`$toDecimal`	Converte o valor para um Decimal128.
`$toDouble`	Converte o valor em double.
`$toInt`	Converte o valor para um número inteiro.
`$toLong`	Converte o valor para um longo.
`$toObjectId`	Converte o valor para um ObjectId.
`$toString`	Converte o valor para uma string.
`$toLower`	Converte uma string em minúsculas. Aceita uma única expressão de argumento.
`$toUpper`	Converte uma string em maiúsculas. Aceita uma única expressão de argumento.
`$trim`	Remove o espaço em branco ou os caracteres especificados do início e fim de uma string.
`$trunc`	Trunca um número para um inteiro ou para uma casa decimal especificada.
`$type`	Retorne o tipo de dados BSON do campo.
`$unsetField`	Remove um campo especificado de um documento. Um alias para `$setField` remover campos com nomes que contêm pontos ( `.` ) ou que começam com sinais de dólar ( `$` ). Novidades na versão 5.0.
`$week`	Retorna o número da semana para uma data como um número entre 0 (a semana parcial que precede o primeiro domingo do ano) e 53 (ano bissexto).
`$year`	Retorna o ano para uma data como um número (por exemplo, 2014).
`$zip`	Mesclar dois arrays juntos.

Para os estágios do pipeline, consulte Estágios do pipeline de agregação.

Voltar

$unwind

$abs