Módulo: Mongoid::Config

Ampliado por:
Transferible, Configuración, Valores predeterminados, Cifrado, Opciones
Incluye:
DeprecatedOptions
Incluido en:
Config
Definido en:
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/client.rb,
lib/mongoid/config/validators/option.rb,
lib/mongoid/config/validators/async_query_executor.rb

Overview

Este módulo define todas las opciones de configuración para Mongoid, incluidas las conexiones a la base de datos.

Definido en el espacio de nombres

Modules: Predeterminados, Opciones obsoletas, cifrado, Entorno, Opciones, Validadores

Colapso delresumen constante

BLOQUEAR = 
Mutex.Nuevo

Constantes incluidas de DeprecatedOptions

Opciones obsoletas::OPCIONES

Colapso del resumen del método de instancia

Métodos incluidos en Opciones

valorespredeterminados, nivel deregistro, opción,restablecer, configuración

Métodos incluidos en Valores predeterminados

valores predeterminados de carga

Métodos incluidos en Cifrado

mapa de esquema de cifrado

Métodos incluidos en DeprecatedOptions

antepuesto

Detalles del método de instancia

#clientes ⇒ Hash

Obtenga la configuración del cliente o un hash vacío.

Ejemplos:

Obtenga la configuración de los clientes.

config.clients

Devuelve:

  • (Hash) —

    La configuración del cliente.



368
369
370
 
# Archivo 'lib/mongoid/config.rb', línea 368

def clientes
  @clientela ||= {}
end

#config ⇒ self

Devuelve el singleton de configuración para su uso en el DSL de configuración.

Devuelve:

  • (ser) -

    El singleton de configuración.



186
187
188
 
# Archivo 'lib/mongoid/config.rb', línea 186

def config
  yo
end

#configurado? ⇒ verdadero | falso

¿Se ha configurado Mongoid? Esto comprueba que exista al menos una configuración de cliente válida.

Ejemplos:

¿Está configurado Mongoid?

config.configured?

Devuelve:

  • (verdadero | falso) —

    Si Mongoid está configurado.



197
198
199
 
# Archivo 'lib/mongoid/config.rb', línea 197

def ¿configurado?
  clientes.key?(:por defecto)
end

#connect_to(nombre,opciones = { lectura: { modo::primario }}) ⇒ Objeto

Nota:

Úselo sólo en entornos de desarrollo o prueba para mayor comodidad.

Conéctese al nombre de base de datos proporcionado en el cliente predeterminado.

Ejemplos:

Establezca la base de datos a la que conectarse.

config.connect_to("mongoid_test")

Parámetros:

  • Nombre (Cadena) -

    El nombre de la base de datos.



209
210
211
212
213
214
215
216
217
 
# Archivo 'lib/mongoid/config.rb', línea 209

def connect_to(Nombre, opciones = { leer: { modo: :primario }})
  yo.clientes = {
    por defecto: {
      database: Nombre,
      anfitriones: [ "localhost:27017" ],
      opciones: opciones
    }
  }
end

#deregister_model(klass) ⇒ Object

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Dar de baja un modelo en la aplicación con Mongoid.

Parámetros:

  • klass (Clase) -

    El modelo a dar de baja.



276
277
278
279
280
 
# Archivo 'lib/mongoid/config.rb', línea 276

def cancelar_registro_modelo(klass)
  CERRAR.sincronizar hacer
    modelos.borrar(klass)
  end
end

#destructive_fields ⇒ arreglo<String>

Devuelve los nombres de campos que podrían causar cosas destructivas si se definen en un Mongoid::Document.

Ejemplos:

Consigue los campos destructivos.

config.destructive_fields

Devuelve:

  • (Matriz<String>) —

    Una serie de nombres de campos incorrectos.



226
227
228
 
# Archivo 'lib/mongoid/config.rb', línea 226

def campos destructivos
  Componible.métodos prohibidos
end

#¡cargar!(ruta, entorno = nulo) ⇒ Objeto

Carga la configuración desde un archivo mongoid.yml compatible. Esto facilita la configuración con frameworks distintos a Rails.

Ejemplos:

Configurar Mongoid.

Mongoid.load!("/path/to/mongoid.yml")

Parámetros:

  • ruta (Cadena) -

    La ruta al archivo.

  • medio ambiente (Cadena | Símbolo) (predeterminado: nulo) —

    El entorno a cargar.



238
239
240
241
242
243
244
245
246
 
# Archivo 'lib/mongoid/config.rb', línea 238

def ¡carga!(ruta, medio ambiente = nulo)
  ajustes = Entorno.cargar_yaml(ruta, medio ambiente)
  Si ajustes.¿presente?
    Clientes.desconectar
    Clientes.borrar
    load_configuration(ajustes)
  end
  ajustes
end

#load_configuration(configuraciones) ⇒ Objeto

A partir de un hash de configuraciones, cargue toda la configuración.

Ejemplos:

Cargar la configuración.

config.load_configuration(settings)

Parámetros:

  • ajustes (Hash) —

    Los ajustes de configuración.



288
289
290
291
292
293
294
 
# Archivo 'lib/mongoid/config.rb', línea 288

def load_configuration(ajustes)
  configuración = ajustes.con_acceso_indiferente
  yo.opciones = configuración[:opciones]
  yo.clientes = configuración[:clientela]
  Mongo.opciones = configuración[:opciones_del_controlador] || {}
  establecer_niveles_de_registro
end

#models ⇒ Array<Class>

Obtenga todos los modelos en la aplicación: esto es todo lo que incluye Mongoid::Document.

Ejemplos:

Consigue todos los modelos.

config.models

Devuelve:

  • (Matriz<Class>) —

    Todos los modelos de la aplicación.



255
256
257
 
# Archivo 'lib/mongoid/config.rb', línea 255

def modelos
  @models ||= []
end

#opciones=(opciones) ⇒ Objeto

Establezca las opciones de configuración. Se validará cada una individualmente.

Ejemplos:

Establecer las opciones.

config.options = { raise_not_found_error: true }

Parámetros:

  • opciones (Hash) —

    Las opciones de configuración.



352
353
354
355
356
357
358
359
360
 
# Archivo 'lib/mongoid/config.rb', línea 352

def opciones=(opciones)
  Si opciones
    Validadores::Ejecutor de consultas asíncronas.validar(opciones)
    opciones.each_pair hacer |opción, valor|
      Validadores::Opción.validar(opción)
      Enviar("#{opción}=", valor)
    end
  end
end

#override_client(nombre) ⇒ Cadena | Símbolo

Anular el cliente para utilizarlo globalmente.

Ejemplos:

Anular el cliente globalmente.

config.override_client(:optional)

Parámetros:

  • Nombre (Cadena | Símbolo) —

    El nombre del cliente.

Devuelve:

  • (Cadena | Símbolo) —

    La anulación global.



316
317
318
 
# Archivo 'lib/mongoid/config.rb', línea 316

def anular_cliente(Nombre)
  Compacto.anulación del cliente = Nombre ? Nombre.a_s : nulo
end

#override_database(nombre) ⇒ Cadena | Símbolo

Anular la base de datos para utilizarla globalmente.

Ejemplos:

Anular la base de datos globalmente.

config.override_database(:optional)

Parámetros:

  • Nombre (Cadena | Símbolo) —

    El nombre de la base de datos.

Devuelve:

  • (Cadena | Símbolo) —

    La anulación global.



304
305
306
 
# Archivo 'lib/mongoid/config.rb', línea 304

def override_database(Nombre)
  Compacto.database_override = Nombre
end

#purge! ⇒ true

Nota:

Esta es la manera más rápida de descartar todos los datos.

Purgar todos los datos de todas las colecciones, incluidos los índices.

Ejemplos:

Purgar todos los datos.

Mongoid::Config.purge!

Devuelve:

  • (verdadero) -

    verdadero.



328
329
330
 
# Archivo 'lib/mongoid/config.rb', línea 328

def ¡purga!
  cliente_global.database.collections.cada(Y:gota) y  true
end

#register_model(klass) ⇒ Object

Registrar un modelo en la aplicación con Mongoid.

Ejemplos:

Registrar un modelo.

config.register_model(Band)

Parámetros:

  • klass (Clase) -

    El modelo a registrar.



265
266
267
268
269
 
# Archivo 'lib/mongoid/config.rb', línea 265

def modelo de registro(klass)
  CERRAR.sincronizar hacer
    modelos.Push(klass) a no ser que modelos.¿incluir?(klass)
  end
end

#¿corriendo_con_pasajero? ⇒ verdadero | falso

Obsoleto.

¿La aplicación se está ejecutando en modo pasajero?

Ejemplos:

¿La aplicación está usando pasajeros?

config.running_with_passenger?

Devuelve:

  • (verdadero | falso) —

    Si la aplicación está implementada en Passenger.



390
391
392
 
# Archivo 'lib/mongoid/config.rb', línea 390

def ¿corriendo_con_pasajero?
  @running_with_passenger ||= ¿definido?(PhusionPassenger)
end

#time_zone ⇒ String

Obtenga la zona horaria a utilizar.

Ejemplos:

Obtenga la zona horaria.

Config.time_zone

Devuelve:

  • (Cadena) -

    La zona horaria.



378
379
380
 
# Archivo 'lib/mongoid/config.rb', línea 378

def time_zone
  ¿usar_utc? ? "UTC" : ::Tiempo.zona
end

#¡truncar! ⇒ verdadero

Nota:

¡Esto será más lento que la purga!

Trunca todos los datos en todas las colecciones, pero no los índices.

Ejemplos:

Truncar todos los datos de la colección.

Mongoid::Config.truncate!

Devuelve:

  • (verdadero) -

    verdadero.



340
341
342
343
344
 
# Archivo 'lib/mongoid/config.rb', línea 340

def ¡truncar!
  cliente_global.database.collections.cada hacer |Colección|
    Colección.buscar.eliminar_muchos
  end y  true
end