Clase: Mongo::Colección::Vista::Agregación

Hereda:
Objeto
  • Objeto
Mostrar todo
Incluye:
Comportamiento
Definido en:
lib/mongo/collection/view/aggregation.rb,
lib/mongo/collection/view/aggregation/behavior.rb

Overview

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

Desde:

  • 2.0.0

Subclases conocidas directas

ChangeStream

Definido en el espacio de nombres

Modules: Comportamiento

Resumen constante

Constantes incluidas desde Loggable

Registrable::PREFIX

Constantes incluidas de Explainable

Explicable::TODOS_LOS_PLANES_EJECUCIÓN, Explicable::ESTADÍSTICAS_DE_EJECUCIÓN, Explicable::PLANIFICADOR_DE_CONSULTAS

Colapso delresumen de atributos de instancia

Atributos incluidos de Comportamiento

#view

Atributos incluidos desde Mongo::CursorHost

#cursor, #timeout_mode

Atributos incluidos de Immutable

#options

Colapso del resumen del método de instancia

Métodos incluidos en Comportamiento

#permitir_uso_de_disco, #explicar, #tiempo_de_espera_ms, #¿escribir?

Métodos incluidos en Retryable

#trabajador_de_lectura, #servidor_de_selección, #trabajador_de_escritura

Métodos incluidos en Loggable

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

Métodos incluidos en Explainable

#explicar

Métodos incluidos de Iterable

#cerrar_consulta, #cada

Métodos incluidos desde Mongo::CursorHost

#validate_timeout_mode!

Detalles del constructor

#inicializar(vista, canalización, opciones = {}) ⇒ Agregación

Inicialice la agregación para la vista de colección, la canalización y las opciones proporcionadas.

Ejemplos:

Crear la nueva vista de agregación.

Aggregation.view.new(view, pipeline)

Parámetros:

  • vista (Colección:: Ver) —

    La vista de la colección.

  • pipeline (Matriz<Hash>) —

    La tubería de operaciones.

  • opciones (Hash) (predeterminado: {}) —

    Las opciones de agregación.

Opciones Hash(opciones):

  • :permitir_uso_de_disco (verdadero,falso) —

    Establezca como verdadero si se permite el uso del disco durante la agregación.

  • :tamaño_del_lote (Entero) —

    El número de documentos a devolver por agrupar.

  • :omitir validación de documento (verdadero,falso) —

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

  • :colación (Hash) —

    La intercalación a utilizar.

  • :comment (Objeto) —

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

  • :hint (Cadena) —

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

  • :dejar (Hash) —

    Asignación de variables para usar en la canalización. Consulte la documentación del servidor para obtener más información.

  • :tiempo máximo_ms (Entero) —

    El tiempo máximo en milisegundos que permite que se ejecute la agregación. Esta opción está obsoleta; utilice :timeout_ms en su lugar.

  • :sesión (Sesión) —

    La sesión a utilizar.

  • :timeout_mode (:tiempo de vida del cursor |:iteración) —

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

  • :tiempo de espera_ms (Entero) —

    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



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

def inicializar(vista, pipeline, opciones = {})
  realizar_configuración(vista, opciones) hacer
    @pipeline = pipeline.dup
    a no ser que Mongo.agregado de vista rota || vista.filtro.¿vacío?
      @pipeline.unshift(:$coincidencia => vista.filtro)
    end
  end
end

Detalles de los atributos de instancia

#pipeline ⇒ Array<Hash> (solo lectura)

Devuelve la canalización La canalización de agregación.

Devuelve:

  • (Matriz<Hash>) —

    pipeline El pipeline de agregación.

Desde:

  • 2.0.0



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

def pipeline
  @pipeline
end