Module: Mongoid::Sessions::Factory

Extended by:: Factory
Included in:: Factory
Defined in:: lib/mongoid/sessions/factory.rb

Instance Method Summary (collapse)

- (Moped::Session) create(name = nil)

Create a new session given the named configuration.
- (Moped::Session) default

Get the default session.

Instance Method Details

- (`Moped::Session`) create(name = nil)

Create a new session given the named configuration. If no name is provided, return a new session with the default configuration. If a name is provided for which no configuration exists, an error will be raised.

Examples:

Create the session.

Factory.create(:secondary)

Parameters:

name (String, Symbol) (defaults to: nil) —

The named session configuration.

Returns:

(Moped::Session) —

The new session.

Raises:

(Errors::NoSessionConfig) —

If no config could be found.

Since:

3.0.0

# File 'lib/mongoid/sessions/factory.rb', line 22

def create(name = nil)
  return default unless name
  config = Mongoid.sessions[name]
  raise Errors::NoSessionConfig.new(name) unless config
  create_session(config)
end

- (`Moped::Session`) default

Get the default session.