Module: Mongoid::Clients

Extended by:
ActiveSupport::Concern
Includes:
Options, StorageOptions
Included in:
Composable
Defined in:
lib/mongoid/clients.rb,
lib/mongoid/clients/factory.rb,
lib/mongoid/clients/options.rb,
lib/mongoid/clients/storage_options.rb,
lib/mongoid/clients/validators/storage.rb

Defined Under Namespace

Modules: Factory, Options, StorageOptions, Validators

Class Method Summary collapse

Methods included from Options

#collection, #collection_name, #mongo_client, #persistence_context, #with

Class Method Details

.clear ⇒ Array

Clear all clients from the current thread.

Examples:

Clear all clients.

Mongoid::Clients.clear

Returns:

  • (Array) —

    The empty clients.

Since:

  • 3.0.0



23
24
25
 
# File 'lib/mongoid/clients.rb', line 23

def clear
  clients.clear
end

.clients ⇒ Object 



71
72
73
 
# File 'lib/mongoid/clients.rb', line 71

def clients
  @clients ||= {}
end

.default ⇒ Mongo::Client

Get the default client.

Examples:

Get the default client.

Mongoid::Clients.default

Returns:

  • (Mongo::Client) —

    The default client.

Since:

  • 3.0.0



35
36
37
 
# File 'lib/mongoid/clients.rb', line 35

def default
  clients[:default] ||= Clients::Factory.default
end

.disconnect ⇒ true

Disconnect all active clients.

Examples:

Disconnect all active clients.

Mongoid::Clients.disconnect

Returns:

  • (true) —

    True.

Since:

  • 3.1.0



47
48
49
50
51
 
# File 'lib/mongoid/clients.rb', line 47

def disconnect
  clients.values.each do |client|
    client.close
  end
end

.set(name, client) ⇒ Object 



67
68
69
 
# File 'lib/mongoid/clients.rb', line 67

def set(name, client)
  clients[name.to_sym] = client
end

.with_name(name) ⇒ Mongo::Client

Get a client with the provided name.

Examples:

Get a client with the name.

Mongoid::Clients.with_name(:replica)

Parameters:

  • name (Symbol) —

    The name of the client.

Returns:

  • (Mongo::Client) —

    The named client.

Since:

  • 3.0.0



63
64
65
 
# File 'lib/mongoid/clients.rb', line 63

def with_name(name)
  clients[name.to_sym] ||= Clients::Factory.create(name)
end