Classe: Mongo::Operation::ListCollections::Result

Herda:
Resultado
  • Objeto
mostrar tudo
Definido em:
build/ruby-driver-v2.19/lib/mongo/operation/list_collections/result.rb

Visão geral

Define o comportamento personalizado dos resultados ao usar o comando listCollections.

Desde:

  • 2.0.0

Resumo constante

Constantes herdadas do resultado

Resultado::CURSOR, Resultado::CURSOR_ID, Resultado::FIRST_BATCH, Resultado::N, Resultado::NAMESPACE, Resultado::NEXT_BATCH, Resultado::OK, Resultado::RESULT

Resumo do atributo de instância

Atributos herdados do Resultado

#connection_description, #connection_global_id, #replies

Recolhimento do Resumo do método de instância

Métodos herdados do Resultado

#reconhecido?, #cluster_time, #each, #error, #has_cursor_id?, #initialize, #inspect, #labels, #ok?, #operation_time, #reply, #returned_count, #snapshot_timestamp, #successful?, #topology_version, #write_concern_error?, #written_count

Detalhes do construtor

Esta classe herda um construtor de Mongo::Operation::Result

Detalhes do método de instância

#cursor_id ➤ Inteiro

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Observação:

Embora o protocolo de fio tenha um campo cursor_id para todas as mensagens do tipo resposta, ele é sempre zero ao usar o comando listCollections e deve ser recuperado do próprio documento do cursor.

Obtenha o ID do cursor para o resultado.

Exemplos:

Obtenha o ID do cursor.

result.cursor_id

Retorna:

  • (Inteiro) —

    O ID do cursor.

Desde:

  • 2.0.0



43
44
45
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/list_collections/result.rb', linha 43

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : super
end

#documents ➤ Array<BSON::Document>

Obtenha os documentos para o resultado listCollections. É o 'firstBatch'

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

Exemplos:

Pegue os documentos.

result.documents

Retorna:

  • (Array<BSON::Document>) —

    Os documentos.

Desde:

  • 2.0.0



70
71
72
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/list_collections/result.rb', linha 70

def documentos
  cursor_document[FIRST_BATCH]
end

#namespace ➤ string

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Obtenha o namespace do cursor.

Exemplos:

Obtenha o namespace.

result.namespace

Retorna:

  • (string) —

    O namespace.

Desde:

  • 2.0.0



56
57
58
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/list_collections/result.rb', linha 56

def namespace
  cursor_document ? cursor_document[namespace] : super
end

#validar! ➤ Resultado

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Valide o resultado. Caso um cliente não autorizado tente executar o comando, precisamos gerar o erro apropriado.

Exemplos:

Valide o resultado.

result.validate!

Retorna:

Desde:

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/list_collections/result.rb', linha 84

def validar!
  se bem-sucedido?
    auto
  mais
    aumentar Erro::Falha de operação.Novo(
      parser.mensagem,
      auto,
      código: parser.código,
      code_name: parser.code_name,
      rótulos: parser.rótulos,
      wtimeout: parser.tempo esgotado,
      Documento: parser.documento,
      server_message: parser.server_message,
    )
  end
end