Module: Mongoid::Config
- Included in:
- Config
- Defined in:
- build/mongoid-master/lib/mongoid/config.rb,
build/mongoid-master/lib/mongoid/config/options.rb,
build/mongoid-master/lib/mongoid/config/defaults.rb,
build/mongoid-master/lib/mongoid/config/environment.rb,
build/mongoid-master/lib/mongoid/config/validators/client.rb,
build/mongoid-master/lib/mongoid/config/validators/option.rb
Overview
This module defines all the configuration options for Mongoid, including the database connections.
Defined Under Namespace
Modules: Defaults, Environment, Options, Validators
Constant Summary collapse
- LOCK =
Mutex.new
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.
-
#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
Instance Method Details
#clients ⇒ Hash
Get the client configuration or an empty hash.
303 304 305 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 303 def clients @clients ||= {} end |
#config ⇒ self
Returns the Config singleton, for use in the configure DSL.
133 134 135 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 133 def config self end |
#configured? ⇒ true | false
Has Mongoid been configured? This is checking that at least a valid client config exists.
144 145 146 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 144 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.
156 157 158 159 160 161 162 163 164 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 156 def connect_to(name, = { read: { mode: :primary }}) self.clients = { default: { database: name, hosts: [ "localhost:27017" ], options: } } end |
#destructive_fields ⇒ Array<String>
Return field names that could cause destructive things to happen if defined in a Mongoid::Document.
173 174 175 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 173 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.
185 186 187 188 189 190 191 192 193 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 185 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.
224 225 226 227 228 229 230 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 224 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.
202 203 204 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 202 def models @models ||= [] end |
#options=(options) ⇒ Object
Set the configuration options. Will validate each one individually.
288 289 290 291 292 293 294 295 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 288 def () if .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.
252 253 254 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 252 def override_client(name) Threaded.client_override = name ? name.to_s : nil end |
#override_database(name) ⇒ String | Symbol
Override the database to use globally.
240 241 242 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 240 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.
264 265 266 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 264 def purge! global_client.database.collections.each(&:drop) and true end |
#register_model(klass) ⇒ Object
Register a model in the application with Mongoid.
212 213 214 215 216 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 212 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?
323 324 325 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 323 def running_with_passenger? @running_with_passenger ||= defined?(PhusionPassenger) end |
#time_zone ⇒ String
Get the time zone to use.
313 314 315 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 313 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.
276 277 278 279 280 |
# File 'build/mongoid-master/lib/mongoid/config.rb', line 276 def truncate! global_client.database.collections.each do |collection| collection.find.delete_many end and true end |