Módulo: Mongo::Collection::View::Aggregation::Behavior

Ampliado por:
Reenviable
Incluye:
Enumerables, Explicables, Inmutables, Iterables, Registrables, Reintentables
Incluido en:
Mongo::colección::View::agregación, ChangeStream
Definido en:
lib/mongo/colección/view/agregación/behavior.rb

Overview

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

Desde:

  • 2.0.0

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

#cursor, #timeout_mode

Atributos incluidos de Inmutable

#options

Resumen del método de instancia colapsar

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

#close_query, #each

Métodos incluidos de Mongo::CursorHost

#validate_timeout_mode!

Detalles de atributo de instancias

#vista ⇒ Ver (solo lectura)

Devuelve vista La vista de la colección.

Devuelve:

  • (Ver) —

    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(value = nil) ⇒ true, ...

Establece en "true" 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) (valor por defecto: nil) —

    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 getter.

Desde:

  • 2.0.0



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

def allow_disk_use(Valor = nulo)
  Configurar(permite_uso_de_disco, Valor)
end

#explicar ⇒ Hash

Obtén el plan de explicación para la agregación.

Ejemplos:

Obtén el plan de explicación para la agregación.

aggregation.explain

Devuelve:

  • (encriptada) —

    El plan de explicación.

Desde:

  • 2.0.0



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

def explicar
  sí mismo.clase.Nuevo(vista, pipeline, opciones.fusionar(explicar: true)).primero
end

#timeout_ms ⇒ Integer | nil

Este método es parte de una API privada. Se debe evitar el uso de este método 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 de timeout_ms que se pasó como una 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 timeout_ms
  @timeout_ms || vista.timeout_ms
end

#guardar? ⇒ Booleano

Este método es parte de una API privada. Se debe evitar el uso de este método 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 la base de datos.

Devuelve:

  • (booleano) —

    Si la agregación guardará 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 guardar?
  pipeline.any? { |op| op.key?('$out') || op.key?(:$out) || op.key?('$merge') || op.key?(:$merge) }
end