Module: Mongoid::Clients

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

Defined Under Namespace

Modules: Factory, Options, Sessions, StorageOptions, Validators

Class Method Summary collapse

Methods included from Sessions

#with_session

Methods included from Options

#collection, #collection_name, #mongo_client, #persistence_context, #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.



24
25
26
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 24

def clear
  clients.clear
end

.clients ⇒ Object 



70
71
72
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 70

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.



34
35
36
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 34

def default
  with_name(:default)
end

.disconnect ⇒ true

Disconnect all active clients.

Examples:

Disconnect all active clients.

Mongoid::Clients.disconnect

Returns:

  • (true) —

    True.



44
45
46
47
48
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 44

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

.set(name, client) ⇒ Object 



66
67
68
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 66

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 (String | Symbol) —

    The name of the client.

Returns:

  • (Mongo::Client) —

    The named client.



58
59
60
61
62
63
64
 
# File 'build/mongoid-8.1/lib/mongoid/clients.rb', line 58

def with_name(name)
  name_as_symbol = name.to_sym
  return clients[name_as_symbol] if clients[name_as_symbol]
  CREATE_LOCK.synchronize do
    clients[name_as_symbol] ||= Clients::Factory.create(name)
  end
end