module Mongoid

Top-level module for project.

rubocop:todo all

TODO: consider refactoring this Proxy class, to satisfy the following cops… rubocop:disable Metrics/ClassLength

rubocop:todo all

Wrapper class used when a value cannot be casted in evolve method.

rubocop:todo all

Constants

MONGODB_VERSION: The minimum MongoDB version supported.
PLATFORM_DETAILS: A string added to the platform details of Ruby driver client handshake documents.
VERSION

Public Instance Methods

RawValue(*args) click to toggle source

Instantiates a new Mongoid::RawValue object. Used as a syntax shortcut.

@example Create a Mongoid::RawValue object.

Mongoid::RawValue("Beagle")

@return [ Mongoid::RawValue ] The object.

# File lib/mongoid/extensions/raw_value.rb, line 13
def RawValue(*args)
  RawValue.new(*args)
end

client(name) click to toggle source

Convenience method for getting a named client.

@example Get a named client.

Mongoid.client(:default)

@return [ Mongo::Client ] The named client.

# File lib/mongoid.rb, line 119
def client(name)
  Clients.with_name(name)
end

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.connect_to("mongoid_test")

  config.clients.default = {
    hosts: ["localhost:27017"],
    database: "mongoid_test",
  }
end

@example Using a block without an argument. Use ‘config` inside

the block to perform variable assignment.

Mongoid.configure do
  connect_to("mongoid_test")

  config.preload_models = true

@return [ Config ] The configuration object.

# File lib/mongoid.rb, line 77
def configure(&block)
  return Config unless block_given?

  block.arity == 0 ? Config.instance_exec(&block) : yield(Config)
end

default_client() click to toggle source

Convenience method for getting the default client.

@example Get the default client.

Mongoid.default_client

@return [ Mongo::Client ] The default client.

# File lib/mongoid.rb, line 89
def default_client
  Clients.default
end

disconnect_clients() click to toggle source

Disconnect all active clients.

@example Disconnect all active clients.

Mongoid.disconnect_clients

@return [ true ] True.

# File lib/mongoid.rb, line 99
def disconnect_clients
  Clients.disconnect
end

persistence_context() click to toggle source

Define persistence context that is used when a transaction method is called on Mongoid module.

@api private

# File lib/mongoid.rb, line 134
def persistence_context
  PersistenceContext.get(Mongoid) || PersistenceContext.new(Mongoid)
end

reconnect_clients() click to toggle source

Reconnect all active clients.

@example Reconnect all active clients.

Mongoid.reconnect_clients

@return [ true ] True.

# File lib/mongoid.rb, line 109
def reconnect_clients
  Clients.reconnect
end

storage_options() click to toggle source

Define client that is used when a transaction method is called on Mongoid module. This MUST be the default client.

@api private

# File lib/mongoid.rb, line 142
def storage_options
  { client: :default }
end