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
Instance Method Summary collapse
-
#clients ⇒ Hash
Get the client configuration or an empty hash.
-
#config ⇒ self
Returns the Config singleton, for use in the configure DSL.
-
#configured? ⇒ true | false
Has Mongoid been configured? This is checking that at least a valid client config exists.
-
#connect_to(name, options = { read: { mode: :primary }}) ⇒ Object
Connect to the provided database name on the default client.
-
#deregister_model(klass) ⇒ Object
private
Deregister a model in the application with Mongoid.
-
#destructive_fields ⇒ Array<String>
Return field names that could cause destructive things to happen if defined in a Mongoid::Document.
-
#load!(path, environment = nil) ⇒ Object
Load the settings from a compliant mongoid.yml file.
-
#load_configuration(settings) ⇒ Object
From a hash of settings, load all the configuration.
-
#models ⇒ Array<Class>
Get all the models in the application - this is everything that includes Mongoid::Document.
-
#options=(options) ⇒ Object
Set the configuration options.
-
#override_client(name) ⇒ String | Symbol
Override the client to use globally.
-
#override_database(name) ⇒ String | Symbol
Override the database to use globally.
-
#purge! ⇒ true
Purge all data in all collections, including indexes.
-
#register_model(klass) ⇒ Object
Register a model in the application with Mongoid.
-
#running_with_passenger? ⇒ true | false
Is the application running under passenger?.
-
#time_zone ⇒ String
Get the time zone to use.
-
#truncate! ⇒ true
Truncate all data in all collections, but not the indexes.
Methods included from Options
defaults, log_level, option, reset, settings
Methods included from Defaults
Methods included from Encryption
Methods included from DeprecatedOptions
Instance Method Details
#clients ⇒ Hash
Get the client configuration or an empty hash.
325 326 327 |
# File 'lib/mongoid/config.rb', line 325 def clients @clients ||= {} end |
#config ⇒ self
Returns the Config singleton, for use in the configure DSL.
143 144 145 |
# File 'lib/mongoid/config.rb', line 143 def config self end |
#configured? ⇒ true | false
Has Mongoid been configured? This is checking that at least a valid client config exists.
154 155 156 |
# File 'lib/mongoid/config.rb', line 154 def configured? clients.key?(:default) end |
#connect_to(name, options = { read: { mode: :primary }}) ⇒ Object
Use only in development or test environments for convenience.
Connect to the provided database name on the default client.
166 167 168 169 170 171 172 173 174 |
# File 'lib/mongoid/config.rb', line 166 def connect_to(name, = { read: { mode: :primary }}) self.clients = { default: { database: name, hosts: [ "localhost:27017" ], 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.
233 234 235 236 237 |
# File 'lib/mongoid/config.rb', line 233 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.
183 184 185 |
# File 'lib/mongoid/config.rb', line 183 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.
195 196 197 198 199 200 201 202 203 |
# File 'lib/mongoid/config.rb', line 195 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.
245 246 247 248 249 250 251 |
# File 'lib/mongoid/config.rb', line 245 def load_configuration(settings) configuration = settings.with_indifferent_access self. = configuration[:options] self.clients = configuration[:clients] Mongo. = configuration[:driver_options] || {} set_log_levels end |
#models ⇒ Array<Class>
Get all the models in the application - this is everything that includes Mongoid::Document.
212 213 214 |
# File 'lib/mongoid/config.rb', line 212 def models @models ||= [] end |
#options=(options) ⇒ Object
Set the configuration options. Will validate each one individually.
309 310 311 312 313 314 315 316 317 |
# File 'lib/mongoid/config.rb', line 309 def () if Validators::AsyncQueryExecutor.validate() .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.
273 274 275 |
# File 'lib/mongoid/config.rb', line 273 def override_client(name) Threaded.client_override = name ? name.to_s : nil end |
#override_database(name) ⇒ String | Symbol
Override the database to use globally.
261 262 263 |
# File 'lib/mongoid/config.rb', line 261 def override_database(name) Threaded.database_override = name end |
#purge! ⇒ true
This is the fastest way to drop all data.
Purge all data in all collections, including indexes.
285 286 287 |
# File 'lib/mongoid/config.rb', line 285 def purge! global_client.database.collections.each(&:drop) and true end |
#register_model(klass) ⇒ Object
Register a model in the application with Mongoid.
222 223 224 225 226 |
# File 'lib/mongoid/config.rb', line 222 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?
345 346 347 |
# File 'lib/mongoid/config.rb', line 345 def running_with_passenger? @running_with_passenger ||= defined?(PhusionPassenger) end |
#time_zone ⇒ String
Get the time zone to use.
335 336 337 |
# File 'lib/mongoid/config.rb', line 335 def time_zone use_utc? ? "UTC" : ::Time.zone end |
#truncate! ⇒ true
This will be slower than purge!
Truncate all data in all collections, but not the indexes.
297 298 299 300 301 |
# File 'lib/mongoid/config.rb', line 297 def truncate! global_client.database.collections.each do |collection| collection.find.delete_many end and true end |