Módulo: Mongoid::Config
- Estendido por:
- Encaminhável, Config, Padrões, Criptografia, Opções
- Inclui:
- DeprecatedOptions
- Incluído em:
- Config
- Definido em:
- lib/mongoid/config.rb,
lib/mongoid/config/options.rb,
lib/mongoid/config/defaults.rb,
lib/mongoid/config/encryption.rb,
lib/mongoid/config/environment.rb,
lib/mongoid/config/validators/ cliente.rb,
lib/mongoid/config/validators/option.rb,
lib/mongoid/config/validators/async_query_executor.rb more...
Visão geral
Este módulo define todas as opções de configuração do Mongoid, incluindo as conexões do banco de dados de dados.
Definido sob namespace
Módulos: Padrões, DeprecatedOptions, Criptografia, Ambiente, Opções, Validadores
Colapsode resumo constante
- BLOQUEAR =
Mutex.Novo
Constantes incluídas de DeprecatedOptions
Recolhimento do Resumo do método de instância
-
#clientes ➤ Hash
Obtenha a configuração do cliente ou um hash vazio.
-
#config ⇒ self
Retorna o singleton de configuração para uso na configuração DSL.
-
#configurado? ➤ verdadeiro | false
O Mongoid foi configurado? Isso está verificando se existe pelo menos uma configuração de cliente válida.
-
#connect_to(name, options = { read: { modo: :primary }}) ➤ Object
Conecte-se ao nome do banco de dados de dados fornecido no cliente padrão.
-
#deregister_model(klass) ⇒ Object
privado
Cancele o registro de um modelo no aplicação com Mongoid.
-
#destrutivo_campos ➤ Array<String>
Nomes de campo de retorno que podem causar coisas destrutivas se definidos em um Mongoid::Document.
-
#load!(caminhos, ambiente = nil) ➤ Objeto
Carregue as configurações de um arquivo mongoid.yml compatível.
-
#load_configuration(settings) ➤ Objeto
A partir de um hash de configurações, carregue toda a configuração.
-
#models ⇒ Array<Class>
Obtenha todos os modelos no aplicação - isso é tudo o que inclui Mongoid::Document.
-
#options=(opções) ➤ Objeto
Definir as opções de configuração.
-
#override_client(name) ➤ string | Símbolo
Substitua o cliente para usar globalmente.
-
#override_database(name) ➤ string | Símbolo
Substitua o banco de dados de dados para usar globalmente.
-
#limpar! ➤ verdadeiro
Limpe todos os dados em todas as collections, incluindo índices.
-
#registrar_model(klass) ➤ Objeto
Registre um modelo no aplicação com Mongoid.
- #running_with_passenger? ➤ verdadeiro | false obsoleto Obsoleto.
-
#time_zone ➤ string
Obtenha o fuso zona para usar.
-
#truncar! ➤ verdadeiro
Truncar todos os dados em todas as coleções, mas não os índices.
Métodos incluídos em Opções
padrões, log_level, opção, redefinir, configurações
Métodos incluídos nos Padrões
Métodos incluídos na criptografia
Métodos incluídos de DeprecatedOptions
Detalhes do método de instância
#clientes ➤ Hash
Obtenha a configuração do cliente ou um hash vazio.
368 369 370 |
# Arquivo 'lib/mongoid/config.rb', linha 368 def Clientes @clientes ||= {} end |
#config ⇒ self
Retorna o singleton de configuração para uso na configuração DSL.
186 187 188 |
# Arquivo 'lib/mongoid/config.rb', linha 186 def config auto end |
#configurado? ➤ verdadeiro | false
O Mongoid foi configurado? Isso está verificando se existe pelo menos uma configuração de cliente válida.
197 198 199 |
# Arquivo 'lib/mongoid/config.rb', linha 197 def configurado? Clientes.chave?(:default) end |
#connect_to(name, options = { read: { modo: :primary }}) ➤ Object
Use somente em ambientes de desenvolvimento ou teste por conveniência.
Conecte-se ao nome do banco de dados de dados fornecido no cliente padrão.
209 210 211 212 213 214 215 216 217 |
# Arquivo 'lib/mongoid/config.rb', linha 209 def connect_to(name, = { ler: { modo: :primary }}) auto.Clientes = { padrão: { database: name, Hosts: [ "localhost:27017" ], opções: } } end |
#deregister_model(klass) ➤ Objeto
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.
Cancele o registro de um modelo no aplicação com Mongoid.
276 277 278 279 280 |
# Arquivo 'lib/mongoid/config.rb', linha 276 def deregister_model(classe) Bloqueio.sincronizar fazer modelos.excluir(classe) end end |
#destrutivo_campos ➤ Array<String>
Nomes de campo de retorno que podem causar coisas destrutivas se definidos em um Mongoid::Document.
226 227 228 |
# Arquivo 'lib/mongoid/config.rb', linha 226 def destrutivos_campos Componível.returned_methods end |
#load!(caminhos, ambiente = nil) ➤ Objeto
Carregue as configurações de um arquivo mongoid.yml compatível. Isso pode ser usado para facilitar a configuração com outras estruturas além do Rails.
238 239 240 241 242 243 244 245 246 |
# Arquivo 'lib/mongoid/config.rb', linha 238 def carregue!(caminho, ambiente = nada) Configurações = ambiente.load_yaml(caminho, ambiente) se Configurações.presente? Clientes.Desconectar Clientes.Limpar load_configuration(Configurações) end Configurações end |
#load_configuration(settings) ➤ Objeto
A partir de um hash de configurações, carregue toda a configuração.
288 289 290 291 292 293 294 |
# Arquivo 'lib/mongoid/config.rb', linha 288 def load_configuration(Configurações) configuração, configuração = Configurações.with_indizer_access auto. = configuração, configuração[:opções] auto.Clientes = configuração, configuração[:clientes] mongo. = configuração, configuração[:driver_options] || {} set_log_levels end |
#models ⇒ Array<Class>
Obtenha todos os modelos no aplicação - isso é tudo o que inclui Mongoid::Document.
255 256 257 |
# Arquivo 'lib/mongoid/config.rb', linha 255 def modelos @models ||= [] end |
#options=(opções) ➤ Objeto
Definir as opções de configuração. Validará cada um individualmente.
352 353 354 355 356 357 358 359 360 |
# Arquivo 'lib/mongoid/config.rb', linha 352 def () se Validadores::AsyncQueryExecutor.validar() .cada_pair fazer |opção, valor| Validadores::Opção.validar(opção) enviar("#{opção}=", valor) end end end |
#override_client(name) ➤ string | Símbolo
Substitua o cliente para usar globalmente.
316 317 318 |
# Arquivo 'lib/mongoid/config.rb', linha 316 def override_client(name) Threaded.client_override = name ? name.to_s : nada end |
#override_database(name) ➤ string | Símbolo
Substitua o banco de dados de dados para usar globalmente.
304 305 306 |
# Arquivo 'lib/mongoid/config.rb', linha 304 def override_database(name) Threaded.database_override = name end |
#limpar! ➤ verdadeiro
Esta é a maneira mais rápida de descartar todos os dados.
Limpe todos os dados em todas as collections, incluindo índices.
328 329 330 |
# Arquivo 'lib/mongoid/config.rb', linha 328 def limpar! global_client.database.collections.cada(&:drop) e a true end |
#register_model(klass) ⇒ Object
Registre um modelo no aplicação com Mongoid.
265 266 267 268 269 |
# Arquivo 'lib/mongoid/config.rb', linha 265 def registrar_model(classe) Bloqueio.sincronizar fazer modelos.push(classe) a menos que modelos.incluir?(classe) end end |
#running_with_passenger? ➤ verdadeiro | false
O aplicação está sendo executado como Passageiro?
390 391 392 |
# Arquivo 'lib/mongoid/config.rb', linha 390 def running_with_passenger? @running_with_passenger ||= definido?(PythonPassenger) end |
#time_zone ⇒ String
Obtenha o fuso zona para usar.
378 379 380 |
# Arquivo 'lib/mongoid/config.rb', linha 378 def time_zone use_utc? ? "UTC" : ::Hora.zona end |
#truncar! ➤ verdadeiro
Isso será mais lento do que a limpeza!
Truncar todos os dados em todas as coleções, mas não os índices.
340 341 342 343 344 |
# Arquivo 'lib/mongoid/config.rb', linha 340 def truncar! global_client.database.collections.cada fazer |collection| collection.find.delete_many end e a true end |