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

Hereda:
Resultado
  • Objeto
Mostrar todo
Definido en:
lib/mongo/operación/aggregate/result.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 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 Resultado

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

Resumen del atributo de la instancia

Atributos heredados de Resultado

#connection, #connection_description, #connection_global_id, #context, #replies

Resumen del método de instancia colapsar

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 conexión tiene un campo cursor_id para todos los mensajes de tipo reply, el valor siempre es cero cuando se utiliza el framework de agregación y debe recuperarse del propio documento cursor. ¡Locura!

Obtén la ID del cursor para el resultado.

Ejemplos:

Obtener el id del cursor.

result.cursor_id

Devuelve:

  • (Número entero) —

    El id 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>

Obtén los documentos para el resultado de la agregación. Esto es o bien el campo "resultado" del primer documento, o si se seleccionó una opción de cursor, es el campo "firstBatch" en el campo "cursor" del primer documento devuelto. De lo contrario, es un documento de explicación.

Ejemplos:

Obtenga los documentos.

result.documents

Devuelve:

  • (arreglo<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[FIRST_BATCH] si cursor_document
  docs ||= explicar_documento
  docs
end

#post_batch_resume_token ⇒ BSON::Document | 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.

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

Devuelve:

  • (BSON::Document | nil) —

    El token de reanudación de la publicación del lote

Desde:

  • 2.0.0



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

def token_de_reanudación_de_bloque_de_envíos
  cursor_document ? cursor_document['postBatchResumeToken'] : nulo
end