Clase: Mongo::Operation::ListCollections::Result

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

Overview

Define el comportamiento personalizado de los resultados al utilizar el comando listCollections.

Desde:

  • 2.0.0

Resumen constante

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 uno, #error, #¿tiene_id_de_cursor?, #inicializar, #inspeccionar, #etiquetas, #¿ok?, #tiempo_de_operación, #responder, #conteo_devuelto, #marca_de_tiempo_de_instantánea, #¿exitoso?, #versión_de_topología, #¿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, siempre es cero cuando se usa el comando listCollections y se debe recuperar del propio documento del cursor.

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



43
44
45
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 43

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

#documentos ⇒ Array<BSON::Document>

Obtenga los documentos para el resultado de listCollections. Es el ‘firstBatch’

field in the 'cursor' field of the first document returned.

Ejemplos:

Obtenga los documentos.

result.documents

Devuelve:

  • (arreglo<BSON::Document>) —

    Los documentos.

Desde:

  • 2.0.0



70
71
72
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 70

def Documentos
  cursor_document[FIRST_BATCH]
end

# espaciode nombres ⇒ Cadena

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

Obtén el namespace para el cursor.

Ejemplos:

Obtener el namespace.

result.namespace

Devuelve:

  • (string) —

    El namespace.

Desde:

  • 2.0.0



56
57
58
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 56

def namespace
  cursor_document ? cursor_document[namespace] : super
end

#validate! ⇒ Result

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

Valide el resultado. En el caso de que un cliente no autorizado intente ejecutar el comando, necesitamos generar el error adecuado.

Ejemplos:

Validar el resultado.

result.validate!

Devuelve:

Desde:

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 84

def validate!
  si exitoso?
    sí mismo
  else
    propagar operation_failure_class.Nuevo(
      parser.mensaje,
      sí mismo,
      código: parser.Código,
      nombre_código: parser.nombre_clave,
      etiquetas: parser.etiquetas,
      wtimeout: parser.wtimeout,
      documento: parser.Documento,
      server_message: parser.mensaje del servidor,
    )
  end
end