Module: Mongoid::Config

Extended by:
Forwardable, Config, Defaults, Encryption, Options
Includes:
DeprecatedOptions
Included in:
Config
Defined in:
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

This module defines all the configuration options for Mongoid, including the database connections.

Defined Under Namespace

Modules: Defaults, DeprecatedOptions, Encryption, Environment, Options, Validators

Constant Summary collapse

LOCK = 
Mutex.new

Constants included from DeprecatedOptions

DeprecatedOptions::OPTIONS

Instance Method Summary collapse

Methods included from Options

defaults, log_level, option, reset, settings

Methods included from Defaults

load_defaults

Methods included from Encryption

encryption_schema_map

Methods included from DeprecatedOptions

prepended

Instance Method Details

#clients ⇒ Hash

Get the client configuration or an empty hash.

Examples:

Get the clients configuration.

config.clients

Returns:

  • (Hash) —

    The clients configuration.



359
360
361
 
# File 'lib/mongoid/config.rb', line 359

def clients
  @clients ||= {}
end

#config ⇒ self

Returns the Config singleton, for use in the configure DSL.

Returns:

  • (self) —

    The Config singleton.



177
178
179
 
# File 'lib/mongoid/config.rb', line 177

def config
  self
end

#configured? ⇒ true | false

Has Mongoid been configured? This is checking that at least a valid client config exists.

Examples:

Is Mongoid configured?

config.configured?

Returns:

  • (true | false) —

    If Mongoid is configured.



188
189
190
 
# File 'lib/mongoid/config.rb', line 188

def configured?
  clients.key?(:default)
end

#connect_to(name, options = { read: { mode: :primary }}) ⇒ Object

Note:

Use only in development or test environments for convenience.

Connect to the provided database name on the default client.

Examples:

Set the database to connect to.

config.connect_to("mongoid_test")

Parameters:

  • name (String) —

    The database name.



200
201
202
203
204
205
206
207
208
 
# File 'lib/mongoid/config.rb', line 200

def connect_to(name, options = { read: { mode: :primary }})
  self.clients = {
    default: {
      database: name,
      hosts: [ "localhost:27017" ],
      options: options
    }
  }
end

#deregister_model(klass) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deregister a model in the application with Mongoid.

Parameters:

  • klass (Class) —

    The model to deregister.



267
268
269
270
271
 
# File 'lib/mongoid/config.rb', line 267

def deregister_model(klass)
  LOCK.synchronize do
    models.delete(klass)
  end
end

#destructive_fields ⇒ Array<String>

Return field names that could cause destructive things to happen if defined in a Mongoid::Document.

Examples:

Get the destructive fields.

config.destructive_fields

Returns:

  • (Array<String>) —

    An array of bad field names.



217
218
219
 
# File 'lib/mongoid/config.rb', line 217

def destructive_fields
  Composable.prohibited_methods
end

#load!(path, environment = nil) ⇒ Object

Load the settings from a compliant mongoid.yml file. This can be used for easy setup with frameworks other than Rails.

Examples:

Configure Mongoid.

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

Parameters:

  • path (String) —

    The path to the file.

  • environment (String | Symbol) (defaults to: nil) —

    The environment to load.



229
230
231
232
233
234
235
236
237
 
# File 'lib/mongoid/config.rb', line 229

def load!(path, environment = nil)
  settings = Environment.load_yaml(path, environment)
  if settings.present?
    Clients.disconnect
    Clients.clear
    load_configuration(settings)
  end
  settings
end

#load_configuration(settings) ⇒ Object

From a hash of settings, load all the configuration.

Examples:

Load the configuration.

config.load_configuration(settings)

Parameters:

  • settings (Hash) —

    The configuration settings.



279
280
281
282
283
284
285
 
# File 'lib/mongoid/config.rb', line 279

def load_configuration(settings)
  configuration = settings.with_indifferent_access
  self.options = configuration[:options]
  self.clients = configuration[:clients]
  Mongo.options = configuration[:driver_options] || {}
  set_log_levels
end

#models ⇒ Array<Class>

Get all the models in the application - this is everything that includes Mongoid::Document.

Examples:

Get all the models.

config.models

Returns:

  • (Array<Class>) —

    All the models in the application.



246
247
248
 
# File 'lib/mongoid/config.rb', line 246

def models
  @models ||= []
end

#options=(options) ⇒ Object

Set the configuration options. Will validate each one individually.

Examples:

Set the options.

config.options = { raise_not_found_error: true }

Parameters:

  • options (Hash) —

    The configuration options.



343
344
345
346
347
348
349
350
351
 
# File 'lib/mongoid/config.rb', line 343

def options=(options)
  if options
    Validators::AsyncQueryExecutor.validate(options)
    options.each_pair do |option, value|
      Validators::Option.validate(option)
      send("#{option}=", value)
    end
  end
end

#override_client(name) ⇒ String | Symbol

Override the client to use globally.

Examples:

Override the client globally.

config.override_client(:optional)

Parameters:

  • name (String | Symbol) —

    The name of the client.

Returns:

  • (String | Symbol) —

    The global override.



307
308
309
 
# File 'lib/mongoid/config.rb', line 307

def override_client(name)
  Threaded.client_override = name ? name.to_s : nil
end

#override_database(name) ⇒ String | Symbol

Override the database to use globally.

Examples:

Override the database globally.

config.override_database(:optional)

Parameters:

  • name (String | Symbol) —

    The name of the database.

Returns:

  • (String | Symbol) —

    The global override.



295
296
297
 
# File 'lib/mongoid/config.rb', line 295

def override_database(name)
  Threaded.database_override = name
end

#purge! ⇒ true

Note:

This is the fastest way to drop all data.

Purge all data in all collections, including indexes.

Examples:

Purge all data.

Mongoid::Config.purge!

Returns:

  • (true) —

    true.



319
320
321
 
# File 'lib/mongoid/config.rb', line 319

def purge!
  global_client.database.collections.each(&:drop) and true
end

#register_model(klass) ⇒ Object

Register a model in the application with Mongoid.

Examples:

Register a model.

config.register_model(Band)

Parameters:

  • klass (Class) —

    The model to register.



256
257
258
259
260
 
# File 'lib/mongoid/config.rb', line 256

def register_model(klass)
  LOCK.synchronize do
    models.push(klass) unless models.include?(klass)
  end
end

#running_with_passenger? ⇒ true | false

Is the application running under passenger?

Examples:

Is the application using passenger?

config.running_with_passenger?

Returns:

  • (true | false) —

    If the app is deployed on Passenger.



379
380
381
 
# File 'lib/mongoid/config.rb', line 379

def running_with_passenger?
  @running_with_passenger ||= defined?(PhusionPassenger)
end

#time_zone ⇒ String

Get the time zone to use.

Examples:

Get the time zone.

Config.time_zone

Returns:

  • (String) —

    The time zone.



369
370
371
 
# File 'lib/mongoid/config.rb', line 369

def time_zone
  use_utc? ? "UTC" : ::Time.zone
end

#truncate! ⇒ true

Note:

This will be slower than purge!

Truncate all data in all collections, but not the indexes.

Examples:

Truncate all collection data.

Mongoid::Config.truncate!

Returns:

  • (true) —

    true.



331
332
333
334
335
 
# File 'lib/mongoid/config.rb', line 331

def truncate!
  global_client.database.collections.each do |collection|
    collection.find.delete_many
  end and true
end