agregado (comando de banco de dados)

aggregate

string

O nome da collection ou visualização que atua como entrada para o aggregation pipeline. Use 1 para comandos independentes de collection.

pipeline

array

Uma array de estágios aggregation pipeline que processam e transformam o fluxo de documentos como parte do aggregation pipeline.

explain

booleano

Opcional. Especifica para devolver as informações sobre o processamento do pipeline.

Não disponível em transações com vários documentos.

allowDiskUse

booleano

Opcional.

Utilize esta opção para substituir o allowDiskUseByDefault para uma query específica. Você pode usar esta opção para:

• Proibir o uso do disco em um sistema onde o uso do disco é permitido por padrão.

• Permitir o uso do disco em um sistema onde o uso do disco é proibido por padrão.

A partir do MongoDB 6.0, se allowDiskUseByDefault estiver configurado como true e o servidor exigir mais de 100 megabytes de memória para um estágio de execução do pipeline, o MongoDB gravará automaticamente arquivos temporários em disco, a menos que a consulta especifique { allowDiskUse: false }.

Para detalhes, consulte allowDiskUseByDefault.

As mensagens de registro do criador de perfil e as mensagens de registro de diagnóstico incluem um indicador usedDisk se algum estágio de agregação gravou dados em arquivos temporários devido a restrições de memória.

allowPartialResults

booleano

Opcional. Para aggregations executadas por meio de um mongos em uma collection fragmentada, o comando pode retornar resultados parciais em vez de um erro quando um ou mais shards consultados não estão disponíveis. Os comandos getMore subsequentes também podem retornar resultados parciais. O padrão é false, que retorna um erro se um shard consultado não estiver disponível.

Defina allowPartialResults somente no comando aggregate inicial. Você não pode defini-lo em getMore, mas cada getMore herda a configuração do cursor.

Como um shard pode ficar indisponível a qualquer ponto, resultados parciais podem aparecer na resposta aggregate inicial, em uma resposta getMore posterior ou em ambas. Quando um lote omite resultados de shards indisponíveis, a resposta desse lote inclui um campopartialResultsReturned: true . Quando todos os fragmentos consultados estão disponíveis para um lote, a resposta omite partialResultsReturned. partialResultsReturned pode conter somente documentos de shards disponíveis. Não pressupõe que o conjunto de resultados esteja completo quando partialResultsReturned for verdadeiro.

O comando retorna um erro InvalidOptions se o pipeline:

• Termina em um estágio de gravação, como $out ou $merge.

• É uma agregação de fluxo de mudança.

• Contém um estágio do Atlas Search , como $search, $vectorSearch, $rankFusion ou $scoreFusion.

cursor

documento

Especifique um documento que contenha opções que controlem a criação do objeto cursor.

Você deve usar o comando aggregate com cursor a explain opção, a menos que o comando inclua a opção.

• Para indicar um cursor com o tamanho de lote padrão, especifique cursor: {}.

• Para indicar um cursor com um tamanho de lote não padrão, use cursor: { batchSize: <num> }.

maxTimeMS

non-negative integer

Opcional.

Especifica um limite de tempo em milissegundos. Se você não especificar um valor para maxTimeMS, as operações não atingirão o tempo limite. Um valor 0 especifica explicitamente o comportamento ilimitado padrão.

O MongoDB encerra as operações que excedem o limite de tempo alocado usando o mesmo mecanismo de db.killOp(). O MongoDB só encerra uma operação em um de seus pontos de interrupção designados.

bypassDocumentValidation

booleano

Opcional. Aplicável somente se você especificar as etapas de aggregation do $out ou $merge.

Habilita o para ignorar a validação de esquema durante a operação. Isso permite inserir documentos que não atendam aos requisitos de aggregate validação.

readConcern

documento

Opcional. Especifica a read concern.

A opção readConcern tem a seguinte sintaxe: readConcern: { level: <value> }

Os possíveis níveis de read concern são:

• "local". Esse é o read concern padrão para operações de leitura em relação ao primário e secundários.

• "available". Disponível para operações de leitura em relação às primárias e secundárias. "available" se comporta da mesma forma que "local" em relação aos secundários primários e não fragmentados. A query retorna os dados mais recentes da instância.

• "majority". Disponível para conjuntos de réplica que usam o mecanismo de armazenamento WiredTiger.

• "linearizable". Disponível apenas para operações de leitura no primary.

• "snapshot". Disponível para transações multidocumento e determinadas operações de leitura fora das transações multidocumento.

Para obter mais informações sobre os read concern, consulte Níveis de read concern.

O estágio $out não pode ser usado em conjunto com preocupação de leitura "linearizable". Se você especificar a preocupação de leitura "linearizable" para db.collection.aggregate(), não poderá incluir o estágio $out no pipeline.

O estágio $merge não pode ser usado em conjunto com a read concern "linearizable". Ou seja, se você especificar "linearizable" read concern para db.collection.aggregate(), não poderá incluir o estágio $merge no pipeline.

collation

documento

Opcional.

Opcional. Especifica a agrupamento para utilizar para a operação.

A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de strings, como regras para letras maiúsculas e marcas de acento.

A opção de agrupamento tem a seguinte sintaxe:

collation: {
    locale: <string>,
    caseLevel: <boolean>,
    caseFirst: <string>,
    strength: <int>,
    numericOrdering: <boolean>,
    alternate: <string>,
    maxVariable: <string>,
    backwards: <boolean>
 }

Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento.

Se o agrupamento não for especificado, mas a coleção tiver um agrupamento padrão (consulte db.createCollection()), a operação usará o agrupamento especificado para a coleção.

Se nenhum agrupamento for especificado para a coleção ou para as operações, o MongoDB usa a comparação binária simples usada nas versões anteriores para comparações de strings.

Você não pode especificar vários agrupamentos para uma operação. Por exemplo, você não pode especificar agrupamentos diferentes por campo ou, se estiver realizando uma busca com uma classificação, não poderá usar um agrupamento para a busca e outro para a classificação.

hint

string ou documento

opcional. O índice a ser usado para a agregação. O índice está na coleção ou visualização inicial em relação à qual a agregação é executada.

Especifique o índice pelo nome do índice ou pelo documento de especificação do índice.

O hint não se aplica aos estágios $lookup e $graphLookup.

comment

any

Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:

• mensagens de log do mongod, no campo attr.command.cursor.comment.

• Saída do perfil do banco de dados, no campo command.comment.

• Saída de currentOp, no campo command.comment.

Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

Qualquer comentário definido em um comando aggregate é herdado por todos os comandos getMore subsequentes executados no cursor aggregate.

writeConcern

documento

Opcional. Um documento que expressa a write concern a ser usado com o estágio $out ou $merge.

$outOmitir para usar a write concern padrão com o estágio $out ou $merge.

let

documento

Opcional.

Especifica um documento com uma lista de variáveis. Isso permite que você melhore a legibilidade do comando separando as variáveis do texto da query.

A sintaxe do documento é:

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

A variável é definida para o valor retornado pela expressão e não pode ser alterada posteriormente.

Para acessar o valor de uma variável no comando, use o prefixo de dois cifrões ($$) junto com o nome da variável no formato $$<variable_name>. Por exemplo: $$targetTotal.

Para usar uma variável para filtrar resultados em um estágio $match do pipeline, é necessário acessar a variável dentro do operador $expr.

Para um exemplo completo utilizando let e variáveis, consulte Utilizar Variáveis let no.

querySettings

documento

Opcional. Configurações de query que se aplicam somente a esta execução do comando. O documento querySettings aceita os seguintes campos:

• indexHints

• queryFramework

• reject

• comment

• queryKnobs

• maxTimeMS

Para obter descrições desses campos, consulte Campos de comando.

O MongoDB não armazena essas configurações no cluster e elas não se aplicam a outras queries com a mesma forma de query. Para definir configurações de query que persistem para uma forma de query, utilize setQuerySettings.

O MongoDB combina as configurações que você passa no comando com quaisquer configurações de query armazenadas no cluster para a mesma forma de query. Se ambas as configurações especificarem o mesmo campo, a configuração do cluster armazenado terá precedência.