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

Hereda:
Operación::Resultado
  • Objeto
Mostrar todo
Definido en:
lib/mongo/operation/list_collections/result.rb

Overview

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

Desde:

  • 2.0.0

Resumen del método de instancia colapsar

Detalles del método de instancia

#cursor_id ⇒ Integer

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.

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



40
41
42
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 40

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : super
end

#documentos ⇒ Array<BSON::Document>

Obtén los documentos para el resultado de listCollections. Es el campo "firstBatch" en el campo "cursor" del primer documento devuelto.

Ejemplos:

Obtén los documentos.

result.documents

Devuelve:

  • (arreglo<BSON::Document>) —

    Los documentos.

Desde:

  • 2.0.0



67
68
69
 
# Archivo 'lib/mongo/operation/list_collections/result.rb', línea 67

def Documentos
  cursor_document[FIRST_BATCH]
end

#namespace ⇒ String

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.

Obtén el namespace para el cursor.

Ejemplos:

Obtener el namespace.

result.namespace

Devuelve:

  • (string) —

    El namespace.

Desde:

  • 2.0.0



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

def namespace
  cursor_document ? cursor_document[namespace] : super
end

#validate! ⇒ Result

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.

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

Ejemplos:

Valida el resultado.

result.validate!

Devuelve:

Desde:

  • 2.0.0



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

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