Classe: Mongo::Database::CursorCommandView Private

Herda:
Objeto
  • Objeto
mostrar tudo
Definido em:
lib/mongo/banco de dados/cursor_command_view.rb

Visão geral

Esta classe faz parte de uma API privada. Evite usar essa classe, se possível, pois ela pode ser removida ou alterada no futuro.

A visualização mínima que um cursor precisa quando é criado a partir de uma resposta de comando arbitrária em vez de uma query de coleção.

Ele carrega as opções específicas do getMore (batchSize, maxTimeMS, comment) e o tipo de cursor e o modo de tempo limite, e dá respostas aos poucos métodos que o Cursor lê de sua visualização.

Desde:

  • 2.0.0

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de instância

Detalhes do construtor

#initialize(database, options = {}) ⇒ CursorCommandView

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.

Retorna uma nova instância de CursorCommandView.

Parâmetros:

  • database (Mongo::Database) —

    O banco de dados em que o comando foi executado.

  • opções (Hash) (padrão para: {}) —

    As opções getMore e timeout.

Hash de opções (opções):

  • :batch_size (Inteiro) —

    O batchSize para getMores.

  • :max_time_ms (Inteiro) —

    O maxTimeMS para getMores.

  • :comentário (Objeto) —

    O comentário para getMores.

  • :cursor_type (Símbolo) —

    :tailable ou :tailable_await.

  • :timeout_mode (Símbolo) —

    :cursor_lifetime ou :iteration.

Desde:

  • 2.0.0



36
37
38
39
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 36

def inicializar(database, opções = {})
  @database = database
  @opções = opções
end

Detalhes do atributo da instância

#database ➤ Mongo::Database (readonly)

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.

Retorna O banco de dados no qual o comando foi executado.

Retorna:

Desde:

  • 2.0.0



42
43
44
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 42

def database
  @database
end

#opções ➤ Hash (somente leitura)

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.

Retorna As opções de visualização. Usado pelo cursor para ler o comentário getMore.

Retorna:

  • (Hash) —

    As opções de visualização. Usado pelo cursor para ler o comentário getMore.

Desde:

  • 2.0.0



46
47
48
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 46

def opções
  @opções
end

Detalhes do método de instância

#batch_size ⇒ Integer | nil

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.

Retorna O batchSize enviado nos comandos getMore.

Retorna:

  • (Inteiro | nil) —

    O batchSize enviado nos comandos getMore.

Desde:

  • 2.0.0



63
64
65
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 63

def batch_size
  opções[:batch_size]
end

#cliente ⇒ Mongo::Client

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.

Retorna O cliente.

Retorna:

Desde:

  • 2.0.0



49
50
51
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 49

def Cliente
  database.Cliente
end

#coleção ⇒ Mongo::Collection

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.

Uma coleção de espaço reservado usada apenas para que o Cursor possa alcançar o cliente e o banco de dados. O namespace real para getMore e killCursors é retirado da resposta do comando, não desta coleção.

Retorna:

Desde:

  • 2.0.0



58
59
60
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 58

def collection
  @collection ||= collection.Novo(database, '$cmd')
end

#cursor_type ⇒ Symbol | nil

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.

Retorna O tipo de cursor.

Retorna:

  • (Symbol | nil) —

    O tipo de cursor.

Desde:

  • 2.0.0



73
74
75
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 73

def cursor_type
  opções[:cursor_type]
end

#limit ⇒ Object

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.

Os cursores não suportam um limite quando criados a partir de uma resposta de comando.

Desde:

  • 2.0.0



90
91
92
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 90

def limit
  nada
end

#max_time_ms_for_get_more ⇒ Integer | nil

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.

Retorna o maxTimeMS enviado em comandos getMore.

Retorna:

  • (Inteiro | nil) —

    O maxTimeMS enviado em comandos getMore.

Desde:

  • 2.0.0



68
69
70
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 68

def max_time_ms_for_get_more
  opções[:max_time_ms]
end

#operation_timeouts(opts = {}) ➤ Hash

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.

Retorna valores de tempo limite para o contexto da operação.

Retorna:

  • (Hash) —

    valores de tempo limite para o contexto da operação.

Desde:

  • 2.0.0



83
84
85
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 83

def operation_timeouts(opciona = {})
  database.operation_timeouts(opciona)
end

#timeout_mode ⇒ Symbol | nil

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.

Retorna o modo de tempo limite.

Retorna:

  • (Symbol | nil) —

    O modo de tempo limite.

Desde:

  • 2.0.0



78
79
80
 
# Arquivo 'lib/mongo/banco de dados/cursor_command_view.rb', linha 78

def timeout_mode
  opções[:timeout_mode]
end