Clase: Mongo::Operación::Agregado::Resultado

Hereda:
Resultado
  • Objeto
Mostrar todo
Definido en:
lib/mongo/operación/agregado/resultado.rb

Overview

Define el comportamiento personalizado de los resultados en un contexto de agregación.

Desde:

  • 2.0.0

Colapso delresumen constante

EXPLICAR =

Esta constante forma parte de una API privada. Debe evitar usarla siempre que sea posible, ya que podría eliminarse o modificarse en el futuro.

El nombre del campo para la información de explicación de la agregación.

Desde:

  • 2.0.5

'etapas'.freeze
EXPLICAR_LEGADO =

Esta constante forma parte de una API privada. Debe evitar usarla siempre que sea posible, ya que podría eliminarse o modificarse en el futuro.

El nombre del campo heredado para la información de explicación de agregación.

Desde:

  • 2.0.5

'servidorPipeline'.freeze

Constantes heredadas de Result

Resultado::CURSOR, Resultado::CURSOR_ID, Resultado::PRIMER_LOTE, Resultado::N, Resultado::ESPACIO_DE_NOMBRES, Resultado::SIGUIENTE_LOTE, Resultado::OK, Resultado::RESULTADO

Resumen de atributos de instancia

Atributos heredados de Result

#conexión, #descripción_de_conexión, #id_global_de_conexión, #contexto, #respuestas

Colapso del resumen del método de instancia

Métodos heredados de Result

#¿reconocido?, #tiempo_de_clúster, #cada, #error, #¿tiene_id_de_cursor?, #inicializar, #inspeccionar, #etiquetas, #espacio_de_nombres, #¿ok?, #tiempo_de_operación, #responder, #conteo_de_retornos, #marca_de_tiempo_de_instantánea, #¿exitoso?, #versión_de_topología, #¡validar!, #¿error_de_preocupación_de_escritura?, #conteo_escrito

Detalles del constructor

Esta clase hereda un constructor de Mongo::Operation::Result

Detalles del método de instancia

#cursor_id ⇒ Integer

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

Nota:

Aunque el protocolo de cable tiene un campo cursor_id para todos los mensajes de tipo respuesta, siempre es cero al usar el marco de agregación y debe recuperarse del propio documento del cursor. ¡Wahnsinn!

Obtenga el identificador del cursor para el resultado.

Ejemplos:

Obtener el id del cursor.

result.cursor_id

Devuelve:

  • (Entero) —

    El identificador del cursor.

Desde:

  • 2.0.0



54
55
56
 
# Archivo 'lib/mongo/operation/aggregate/result.rb', línea 54

def cursor_id
  cursor_document ? cursor_document[ID DEL CURSOR] : 0
end

#documentos ⇒ Array<BSON::Document>

Obtener los documentos para el resultado de la agregación. Este es el campo "result" del primer documento o, si se seleccionó una opción de cursor, el campo "firstBatch" del campo "cursor" del primer documento devuelto. De lo contrario, es un documento explicativo.

Ejemplos:

Obtenga los documentos.

result.documents

Devuelve:

  • (Matriz<BSON::Document>) —

    Los documentos.

Desde:

  • 2.0.0



79
80
81
82
83
84
 
# Archivo 'lib/mongo/operation/aggregate/result.rb', línea 79

def Documentos
  docs = respuesta.Documentos[0][RESULTADO]
  docs ||= cursor_document[PRIMER LOTE] Si cursor_document
  docs ||= explicar_documento
  docs
end

#post_batch_resume_token ⇒ BSON::Documento | nulo

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

Obtenga el token de reanudación del lote posterior para el resultado

Devuelve:

  • (BSON::Document | nil) —

    El token de reanudación del lote posterior

Desde:

  • 2.0.0



63
64
65
 
# Archivo 'lib/mongo/operation/aggregate/result.rb', línea 63

def token de reanudación de post_batch
  cursor_document ? cursor_document['postBatchResumeToken'] : nulo
end