Clase: Mongo::Collection::View::Aggregation

Hereda:
Objeto
  • Objeto
Mostrar todo
Ampliado por:
Reenviable
Incluye:
Comportamiento
Definido en:
lib/mongo/colección/view/agregación.rb,
lib/mongo/colección/view/agregación/behavior.rb

Overview

Proporciona comportamiento alrededor de una canalización de agregación en una vista de colección.

Desde:

  • 2.0.0

Subclases conocidas directas

ChangeStream

Definido bajo Namespace

Modules: Comportamiento

Resumen constante

Constantes incluidas desde Loggable

Loggable::PREFIX

Constantes incluidas de Explicable

Explainable::ALL_PLANS_EXECUTION, Explainable::EXECUTION_STATS, Explainable::QUERY_PLANNER

Resumen de atributos de la instancia colapsar

Atributos incluidos de Comportamiento

#view

Atributos incluidos de Mongo::CursorHost

#cursor, #timeout_mode

Atributos incluidos de Inmutable

#options

Resumen del método de instancia colapsar

Métodos incluidos de Comportamiento

#allow_disk_use, #explain, #timeout_ms, #guardar?

Métodos incluidos de Retryable

#read_worker, #select_server, #with_overload_retry, #write_worker

Métodos incluidos desde Registrable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Métodos incluidos en Explicable

#explain

Métodos incluidos desde Iterable

#close_query, #each

Métodos incluidos de Mongo::CursorHost

#validate_timeout_mode!

Detalles del Constructor

#initializar(vista, pipeline, opciones = {}) ⇒ Agregación

Inicializar la agregación para la vista de colección, el pipeline y las opciones proporcionadas.

Ejemplos:

Crea la nueva vista de agregación.

Aggregation.view.new(view, pipeline)

Parámetros:

  • vista (Collection::View) —

    La vista de colección.

  • pipeline (arreglo<Hash>) —

    El pipeline de operaciones.

  • opciones (encriptada) (por defecto: {}) —

    Las opciones de agregación.

Opciones Hash (options):

  • permite_uso_de_disco (verdadero, falso) —

    Establece en "true" si se permite el uso del disco durante la agregación.

  • :batch_size (Integer) —

    El número de documentos a devolver por agrupar.

  • :evitar_validación_del_documento (verdadero, falso) —

    Decidir si omitir o no la validación a nivel de documento.

  • intercalación (encriptada) —

    La intercalación para usar.

  • :comment (objeto) —

    Un comentario proporcionado por el usuario para adjuntar a este comando.

  • :hint (string) —

    El índice que se utilizará para la agregación.

  • :let (encriptada) —

    Asignación de variables para usar en el pipeline. Consulta la documentación del servidor para más detalles.

  • max_time_ms (Integer) —

    La cantidad máxima de tiempo en milisegundos para permitir que la agregación se ejecute. Esta opción está obsoleta, utiliza :timeout_ms en su lugar.

  • :: sesión (Sesión) —

    La sesión para usar.

  • :timeout_mode (:cursor_lifetime | :iteration) —

    Cómo interpretar :timeout_ms (si se aplica a la vida útil del cursor o a cada iteración).

  • :timeout_ms (Integer) —

    El tiempo de espera de la operación en milisegundos. Debe ser un número entero no negativo. Un valor explícito de 0 significa infinito. El valor por defecto no está establecido, lo que significa que se hereda de la colección, la base de datos o el cliente.

Desde:

  • 2.0.0



69
70
71
72
73
74
 
# Archivo 'lib/mongo/collection/view/aggregation.rb', línea 69

def inicializar(vista, pipeline, opciones = {})
  performar_setup(vista, opciones) hacer
    @pipeline = pipeline.dup
    @pipeline.unshift(:$match => vista.filtro) a menos que mongo.broken_view_aggregate || vista.filtro.¿vacío?
  end
end

Detalles de atributo de instancias

#pipeline ⇒ arreglo<Hash> (solo lectura)

Devuelve el pipeline el pipeline de agregación.

Devuelve:

  • (arreglo<Hash>) —

    pipeline El pipeline de agregación.

Desde:

  • 2.0.0



30
31
32
 
# Archivo 'lib/mongo/collection/view/aggregation.rb', línea 30

def pipeline
  @pipeline
end