Módulo: Mongo::Colección::Vista::Agregación::Comportamiento

Ampliado por:
Reenviable
Incluye:
Enumerable, Explicable, Inmutable, Iterable, Registrable, Reintentable
Incluido en:
Mongo::Colección::Vista::Agregación, Flujode cambios
Definido en:
lib/mongo/colección/view/agregación/behavior.rb

Overview

Destila el comportamiento común de las clases agregadoras, como View::Aggregator y View::ChangeStream.

Desde:

  • 2.0.0

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 desde Mongo::CursorHost

#cursor, #timeout_mode

Atributos incluidos de Immutable

#options

Colapso del resumen del método de instancia

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 de Iterable

#cerrar_consulta, #cada

Métodos incluidos desde Mongo::CursorHost

#validate_timeout_mode!

Detalles de los atributos de instancia

#vista ⇒ Vista (solo lectura)

Vista de retorno La vista de colección.

Devuelve:

  • (Vista) -

    Ver La vista de colección.

Desde:

  • 2.0.0



19
20
21
 
# Archivo 'lib/mongo/collection/view/aggregation/behavior.rb', línea 19

def vista
  @view
end

Detalles del método de instancia

#allow_disk_use(valor = nulo) ⇒ verdadero,...

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

Ejemplos:

Set disk usage flag.

aggregation.allow_disk_use(true)

Parámetros:

  • valor (verdadero,falso) (predeterminado: nulo) —

    El valor de la bandera.

Devuelve:

  • (verdadero,falso, agregación) —

    La agregación si se estableció un valor o el valor si se utilizó como captador.

Desde:

  • 2.0.0



38
39
40
 
# Archivo 'lib/mongo/collection/view/aggregation/behavior.rb', línea 38

def permitir_uso_de_disco(valor = nulo)
  configurar(:permitir_uso_de_disco, valor)
end

#explicar ⇒ Hash

Obtenga el plan explicativo para la agregación.

Ejemplos:

Obtenga el plan explicativo para la agregación.

aggregation.explain

Devuelve:

  • (Hash) —

    El plan explicativo.

Desde:

  • 2.0.0



50
51
52
 
# Archivo 'lib/mongo/collection/view/aggregation/behavior.rb', línea 50

def explicar
  yo.clase.Nuevo(vista, pipeline, opciones.unir(explicar: true)).primera
end

#timeout_ms ⇒ Integer | nil

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el valor timeout_ms que se pasó como opción a este objeto o que se heredó de la vista.

Devuelve:

  • (Integer | nil) —

    el valor timeout_ms que se pasó como opción a este objeto, o que se heredó de la vista.

Desde:

  • 2.0.0



68
69
70
 
# Archivo 'lib/mongo/collection/view/aggregation/behavior.rb', línea 68

def tiempo de espera_ms
  @timeout_ms || vista.tiempo de espera_ms
end

#escribir? ⇒ Booleano

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Si esta agregación escribirá su resultado en una colección de base de datos.

Devuelve:

  • (Booleano) —

    Si la agregación escribirá su resultado en una colección.

Desde:

  • 2.0.0



60
61
62
 
# Archivo 'lib/mongo/collection/view/aggregation/behavior.rb', línea 60

def ¿escribir?
  pipeline.any? { |op| op.key?('$out') || op.key?(:$fuera) || op.key?('$merge') || op.key?(:$fusionar) }
end