Classe: Mongo::Collection::View::aggregation

Herda:
Objeto
  • Objeto
mostrar tudo
Estendido por:
Encaminhável
Inclui:
Comportamento
Definido em:
lib/mongo/collection/view/ agregação.rb,
lib/mongo/collection/view/ agregação/behavior.rb

Visão geral

Fornece comportamento em torno de um pipeline de agregação em uma visualização de coleção.

Desde:

  • 2.0.0

Subclasses conhecidas diretas

Change stream

Definido sob namespace

Módulos: Comportamento

Resumo constante

Constantes incluídas do Loggable

Loggable::Prefix

Constantes incluídas de Explainable

Explicável::ALL_PLANS_EXECUTION, Explicável:: EXECUTION_STATS , Explicável::QUERY_PLANNER

Recolhimento do Resumo do atributo de instância

Atributos incluídos de Comportamento

#view

Atributos incluídos do Mongo::CursorHost

#cursor, #timeout_mode

Atributos incluídos no Imutable

#options

Recolhimento do Resumo do método de instância

Métodos incluídos do Behavior

#allow_disk_use, #explain, #timeout_ms, #write?

Métodos incluídos no Retryable

#read_worker, #select_server, #with_overload_retry, #write_worker

Métodos incluídos no Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_WARN, #logger

Métodos incluídos no Explainable

#explain

Métodos incluídos do Iterable

#close_query, #each

Métodos incluídos do Mongo::CursorHost

#validate_timeout_mode!

Detalhes do construtor

#inicializar(visualização, pipeline, opções = {}) ➤ Agregação

Inicialize a aggregation para a visualização, pipeline e opções de collection fornecidas.

Exemplos:

Crie a nova visualização de agregação.

Aggregation.view.new(view, pipeline)

Parâmetros:

  • vista (Collection::View) —

    A visualização da collection.

  • gasoduto (Array<Hash>) —

    O pipeline de operações.

  • opções (Hash) (padrão para: {}) —

    As opções de aggregation.

Hash de opções (opções):

  • :allow_disk_use (verdadeiro, falso) —

    Defina como verdadeiro se o uso do disco for permitido durante a agregação.

  • :batch_size (Inteiro) —

    O número de documentos a serem devolvidos por lote.

  • :bypass_document_validation (verdadeiro, falso) —

    Se deve ou não ignorar a validação em nível de documento .

  • :collation (Hash) —

    O agrupamento a ser usado.

  • :comentário (Objeto) —

    Um comentário fornecido pelo usuário para anexar a este comando.

  • :hint (string) —

    O índice a ser usado para a agregação.

  • :let (Hash) —

    Mapeamento de variáveis a serem usadas no pipeline. Consulte a documentação do servidor para obter detalhes.

  • :max_time_ms (Inteiro) —

    A quantidade máxima de tempo em milissegundos para permitir a execução da agregação . Esta opção está obsoleta, use :timeout_ms em vez disso.

  • :session (Sessão) —

    A sessão a ser usada.

  • :timeout_mode (:cursor_Lifetime |:iteration) —

    Como interpretar :timeout_ms (se ele se aplica à vida útil do cursor ou por iteração).

  • :timeout_ms (Inteiro) —

    O tempo limite da operação em milissegundos. Deve ser um número inteiro não negativo. Um valor explícito de 0 significa infinito. O valor padrão não está definido, o que significa que o valor é herdado da coleção, do banco de dados ou do cliente.

Desde:

  • 2.0.0



69
70
71
72
73
74
 
# File 'lib/mongo/collection/view/ agregação.rb', linha 69

def inicializar(vista, gasoduto, opções = {})
  perform_setup(vista, opções) fazer
    @pipeline = gasoduto.dup
    @pipeline.unshift(:$match => vista.filtro, filtro) a menos que mongo.quebrado_view_aggregate || vista.filtro, filtro.vazio?
  end
end

Detalhes do atributo da instância

#pipeline ➤ Array<Hash> (somente leitura)

Retorna pipeline O aggregation pipeline.

Retorna:

  • (Array<Hash>) —

    pipeline O aggregation pipeline.

Desde:

  • 2.0.0



30
31
32
 
# File 'lib/mongo/collection/view/ agregação.rb', linha 30

def gasoduto
  @pipeline
end