Módulo: Mongo::Collection::View::aggregation::Behavior

Estendido por:
Encaminhável
Inclui:
Enumerável, Explicável, Imutável, Iterável, Registável, Repetível
Incluído em:
Mongo::Collection::View::aggregation, ChangeStream
Definido em:
lib/mongo/collection/view/ agregação/behavior.rb

Visão geral

Descreve o comportamento comum às classes agregadoras, como View::aggregator e View::ChangeStream.

Desde:

  • 2.0.0

Resumo constante

Constantes incluídas do Loggable

Loggable::Prefix

Constantes incluídas de Explainable

Explicável::ALL_PLANS_EXECUTION, Explicável:: EXECUTION_STATS , Explicável::QUERY_PLANNER

Recolhimento do Resumo do atributo de instância

Atributos incluídos do Mongo::CursorHost

#cursor, #timeout_mode

Atributos incluídos no Imutable

#options

Recolhimento do Resumo do método de instância

Métodos incluídos no Retryable

#read_worker, #select_server, #write_worker

Métodos incluídos no Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_WARN, #logger

Métodos incluídos do Iterable

#close_query, #each

Métodos incluídos do Mongo::CursorHost

#validate_timeout_mode!

Detalhes do atributo da instância

#view ➤ Visualizar (somente leitura)

Retorna a visualização A visualização da collection.

Retorna:

  • (Visualizar) —

    visualização A visualização da collection.

Desde:

  • 2.0.0



19
20
21
 
# File 'lib/mongo/collection/view/ agregação/behavior.rb', linha 19

def vista
  @view
end

Detalhes do método de instância

#allow_disk_use(value = nil) ➤ true, ...

Defina como verdadeiro se o uso do disco for permitido durante a agregação.

Exemplos:

Definir sinalizador de uso de disco.

aggregation.allow_disk_use(true)

Parâmetros:

  • valor (verdadeiro, falso) (padrão para: nil) —

    O valor do sinalizador.

Retorna:

  • (true, false, Aggregation) —

    A agregação se um valor foi definido ou o valor se usado como getter.

Desde:

  • 2.0.0



38
39
40
 
# File 'lib/mongo/collection/view/ agregação/behavior.rb', linha 38

def allow_disk_use(valor = nada)
  configure(:allow_disk_use, valor)
end

#explain ➤ Hash

Obtenha o plano de explicação para a aggregation.

Exemplos:

Obtenha o plano de explicação para a aggregation.

aggregation.explain

Retorna:

  • (Hash) —

    O plano de explicação.

Desde:

  • 2.0.0



50
51
52
 
# File 'lib/mongo/collection/view/ agregação/behavior.rb', linha 50

def explicar
  auto.classe.Novo(vista, gasoduto, opções.mesclar(explicar: true)).primeiro
end

#timeout_ms ⇒ 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 valor de timeout_ms que foi passado como uma opção para esse objeto ou que foi herdado da visualização.

Retorna:

  • (Inteiro | nil) —

    o valor de timeout_ms que foi passado como uma opção para esse objeto ou que foi herdado da visualização.

Desde:

  • 2.0.0



68
69
70
 
# File 'lib/mongo/collection/view/ agregação/behavior.rb', linha 68

def timeout_ms
  @timeout_ms || vista.timeout_ms
end

#escrever? ➤ Booleano

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.

Se esta agregação escreverá seu resultado em uma coleção do banco de dados.

Retorna:

  • (Booleano) —

    Se a aggregation escreverá seu resultado em uma collection.

Desde:

  • 2.0.0



60
61
62
 
# File 'lib/mongo/collection/view/ agregação/behavior.rb', linha 60

def escrever?
  gasoduto.algum? { |op| op.chave?('$out') || op.chave?(:$out) || op.chave?('$merge') || op.chave?(:$merge) }
end