Classe: Mongo::Operation::aggregate::Result

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

Visão geral

Define o comportamento personalizado de resultados em um contexto de agregação .

Desde:

  • 2.0.0

Colapsode resumo constante

Explicar =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

O nome do campo para as informações de explicação da aggregation.

Desde:

  • 2.0.5

'estágios'.congelar
EXLAIN_LEGACY =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

O nome do campo legado para as informações de explicação de agregação .

Desde:

  • 2.0.5

'serverPipeline'.congelar

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, namespace, #ok?, #operation_time, #reply, #returned_count, #snapshot_timestamp, #successful?, #topology_version, #validate!, #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 conexão tenha um campo cursor_id para todas as mensagens do tipo resposta, ele é sempre zero ao usar a estrutura de agregação e deve ser recuperado do próprio documento do cursor. Whahnsinn!

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



54
55
56
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/aggregate/result.rb', linha 54

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 0
end

#documents ➤ Array<BSON::Document>

Obtenha os documentos para o resultado da agregação . Este é o campo "resultado" do primeiro documento ou, se uma opção de cursor foi selecionada, é o campo "firstBatch" no campo "cursor" do primeiro documento retornado. Caso contrário, é um documento explicativo.

Exemplos:

Pegue os documentos.

result.documents

Retorna:

  • (Array<BSON::Document>) —

    Os documentos.

Desde:

  • 2.0.0



79
80
81
82
83
84
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/aggregate/result.rb', linha 79

def documentos
  Docs = responder.documentos[0][Resultado]
  Docs ||= cursor_document[FIRST_BATCH] se cursor_document
  Docs ||= explain_document
  Docs
end

#post_batch_resume_token ➤ BSON::Document | nada

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 token de retomada pós- lote para o resultado

Retorna:

  • (BSON::Document | nil) —

    O token de retomada pós- lote

Desde:

  • 2.0.0



63
64
65
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/aggregate/result.rb', linha 63

def post_batch_resume_token
  cursor_document ? cursor_document['postBatchResumeToken'] : nada
end