module Mongoid

Constants

MONGODB_VERSION
VERSION

Public Instance Methods

configure() { |Config| ... } 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.use(name: "mongoid_test", host: "localhost", port: 27017)
end

@return [ Config ] The configuration object.

@since 1.0.0

# File lib/mongoid.rb, line 56
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 68
def default_session
  Sessions.default
end
disconnect_sessions() click to toggle source

Disconnect all active sessions.

@example Disconnect all active sessions.

Mongoid.disconnect_sessions

@return [ true ] True.

@since 3.1.0

# File lib/mongoid.rb, line 80
def disconnect_sessions
  Sessions.disconnect
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 92
def session(name)
  Sessions.with_name(name)
end