In Files

Class/Module Index [+]

Quicksearch

Mongoid

Public Instance Methods

configure() click to toggle source

Sets the Mongoid configuration options. Best used by passing a block.

@example Set up configuration options.

Mongoid.configure do |config|
  config.allow_dynamic_fields = false
  config.use(name: "mongoid_test", host: "localhost", port: 27017)
end

@return [ Config ] The configuration object.

@since 1.0.0

# File lib/mongoid.rb, line 110
def configure
  block_given? ? yield(Config) : Config
end
default_session() click to toggle source

Convenience method for getting the default session.

@example Get the default session.

Mongoid.default_session

@return [ Moped::Session ] The default session.

@since 3.0.0

# File lib/mongoid.rb, line 122
def default_session
  Sessions.default
end
session(name) click to toggle source

Convenience method for getting a named session.

@example Get a named session.

Mongoid.session(:default)

@return [ Moped::Session ] The named session.

@since 3.0.0

# File lib/mongoid.rb, line 134
def session(name)
  Sessions.with_name(name)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.