class Mongo::Client
The client is the entry point to the driver and is the main object that will be interacted with.
@since 2.0.0
Constants
- CRUD_OPTIONS
The options that do not affect the behaviour of a cluster and its subcomponents.
@since 2.1.0
- VALID_OPTIONS
Valid client options.
@since 2.1.2
Attributes
@return [ Mongo::Cluster ] cluster The cluster of servers for the client.
@return [ Mongo::Database ] database The database the client is operating on.
@return [ Hash ] options The configuration options.
Public Class Methods
Instantiate a new driver client.
@example Instantiate a single server or mongos client.
Mongo::Client.new([ '127.0.0.1:27017' ])
@example Instantiate a client for a replica set.
Mongo::Client.new([ '127.0.0.1:27017', '127.0.0.1:27021' ])
@param [ Array<String>, String ] addresses_or_uri The array of server addresses in the
form of host:port or a MongoDB URI connection string.
@param [ Hash ] options The options to be used by the client.
@option options [ Symbol ] :auth_mech The authentication mechanism to
use. One of :mongodb_cr, :mongodb_x509, :plain, :scram
@option options [ String ] :auth_source The source to authenticate from. @option options [ Symbol ] :connect The connection method to use. This
forces the cluster to behave in the specified way instead of auto-discovering. One of :direct, :replica_set, :sharded
@option options [ String ] :database The database to connect to. @option options [ Hash ] :auth_mech_properties @option options [ Float ] :heartbeat_frequency The number of seconds for
the server monitor to refresh it's description via ismaster.
@option options [ Integer ] :local_threshold The local threshold boundary
in seconds for selecting a near server for an operation.
@option options [ Integer ] :server_selection_timeout The timeout in seconds
for selecting a server for an operation.
@option options [ String ] :password The user's password. @option options [ Integer ] :max_pool_size The maximum size of the
connection pool.
@option options [ Integer ] :min_pool_size The minimum size of the
connection pool.
@option options [ Float ] :wait_queue_timeout The time to wait, in
seconds, in the connection pool for a connection to be checked in.
@option options [ Float ] :connect_timeout The timeout, in seconds, to
attempt a connection.
@option options [ Hash ] :read The read preference options. They consist of a
mode specified as a symbol, an array of hashes known as tag_sets, and local_threshold. :mode can be one of :secondary, :secondary_preferred, :primary, :primary_preferred, :nearest.
@option options [ Symbol ] :replica_set The name of the replica set to
connect to. Servers not in this replica set will be ignored.
@option options [ true, false ] :ssl Whether to use SSL. @option options [ String ] :ssl_cert The certificate file used to identify
the connection against MongoDB. This option, if present, takes precedence over the values of :ssl_cert_string and :ssl_cert_object
@option options [ String ] :ssl_cert_string A string containing the PEM-encoded
certificate used to identify the connection against MongoDB. This option, if present, takes precedence over the value of :ssl_cert_object
@option options [ OpenSSL::X509::Certificate ] :ssl_cert_object The OpenSSL::X509::Certificate
used to identify the connection against MongoDB
@option options [ String ] :ssl_key The private keyfile used to identify the
connection against MongoDB. Note that even if the key is stored in the same file as the certificate, both need to be explicitly specified. This option, if present, takes precedence over the values of :ssl_key_string and :ssl_key_object
@option options [ String ] :ssl_key_string A string containing the PEM-encoded private key
used to identify the connection against MongoDB. This parameter, if present, takes precedence over the value of option :ssl_key_object
@option options [ OpenSSL::PKey ] :ssl_key_object The private key used to identify the
connection against MongoDB
@option options [ String ] :ssl_key_pass_phrase A passphrase for the private key. @option options [ true, false ] :ssl_verify Whether or not to do peer certification
validation.
@option options [ String ] :ssl_ca_cert The file containing a set of concatenated
certification authority certifications used to validate certs passed from the other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
@option options [ String ] :ssl_ca_cert_string A string containing a set of concatenated
certification authority certifications used to validate certs passed from the other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
@option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object An array of
OpenSSL::X509::Certificate representing the certification authority certifications used to validate certs passed from the other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
@option options [ Float ] :socket_timeout The timeout, in seconds, to
execute operations on a socket.
@option options [ String ] :user The user name. @option options [ Hash ] :write The write concern options. Can be :w =>
Integer|String, :fsync => Boolean, :j => Boolean.
@option options [ true, false ] :monitoring Initializes a client without
any default monitoring if false is provided.
@option options [ Logger ] :logger A custom logger if desired. @option options [ true, false ] :truncate_logs Whether to truncate the
logs at the default 250 characters.
@option options [ Integer ] :max_read_retries The maximum number of read
retries on mongos query failures.
@option options [ Float ] :read_retry_interval The interval, in seconds,
in which reads on a mongos are retried.
@option options [ Object ] :id_generator A custom object to generate ids
for documents. Must respond to #generate.
@option options [ String, Symbol ] :app_name Application name that is printed to the
mongod logs upon establishing a connection in server versions >= 3.4.
@option options [ String ] :platform Platform information to include in the
metadata printed to the mongod logs upon establishing a connection in server versions >= 3.4.
@since 2.0.0
# File lib/mongo/client.rb, line 230 def initialize(addresses_or_uri, options = Options::Redacted.new) @monitoring = Monitoring.new(options) if addresses_or_uri.is_a?(::String) create_from_uri(addresses_or_uri, validate_options(options)) else create_from_addresses(addresses_or_uri, validate_options(options)) end yield(self) if block_given? end
Public Instance Methods
Determine if this client is equivalent to another object.
@example Check client equality.
client == other
@param [ Object ] other The object to compare to.
@return [ true, false ] If the objects are equal.
@since 2.0.0
# File lib/mongo/client.rb, line 100 def ==(other) return false unless other.is_a?(Client) cluster == other.cluster && options == other.options end
Get a collection object for the provided collection name.
@example Get the collection.
client[:users]
@param [ String, Symbol ] collection_name The name of the collection. @param [ Hash ] options The options to the collection.
@return [ Mongo::Collection ] The collection.
@since 2.0.0
# File lib/mongo/client.rb, line 117 def [](collection_name, options = {}) database[collection_name, options] end
Close all connections.
@example Disconnect the client.
client.close
@return [ true ] Always true.
@since 2.1.0
# File lib/mongo/client.rb, line 326 def close @cluster.disconnect! and true end
Get the names of all databases.
@example Get the database names.
client.database_names
@return [ Array<String> ] The names of the databases.
@since 2.0.5
# File lib/mongo/client.rb, line 350 def database_names list_databases.collect{ |info| info[Database::NAME] } end
Get the hash value of the client.
@example Get the client hash value.
client.hash
@return [ Integer ] The client hash value.
@since 2.0.0
# File lib/mongo/client.rb, line 129 def hash [cluster, options].hash end
Get an inspection of the client as a string.
@example Inspect the client.
client.inspect
@return [ String ] The inspection string.
@since 2.0.0
# File lib/mongo/client.rb, line 248 def inspect "#<Mongo::Client:0x#{object_id} cluster=#{cluster.addresses.join(', ')}>" end
Get info for each database.
@example Get the info for each database.
client.list_databases
@return [ Array<Hash> ] The info for each database.
@since 2.0.5
# File lib/mongo/client.rb, line 362 def list_databases use(Database::ADMIN).command(listDatabases: 1).first[Database::DATABASES] end
Get the read preference from the options passed to the client.
@example Get the read preference.
client.read_preference
@return [ Object ] The appropriate read preference or primary if none
was provided to the client.
@since 2.0.0
# File lib/mongo/client.rb, line 261 def read_preference @read_preference ||= ServerSelector.get(options[:read] || ServerSelector::PRIMARY) end
Reconnect the client.
@example Reconnect the client.
client.reconnect
@return [ true ] Always true.
@since 2.1.0
# File lib/mongo/client.rb, line 338 def reconnect @cluster.reconnect! and true end
Use the database with the provided name. This will switch the current database the client is operating on.
@example Use the provided database.
client.use(:users)
@param [ String, Symbol ] name The name of the database to use.
@return [ Mongo::Client ] The new client with new database.
@since 2.0.0
# File lib/mongo/client.rb, line 276 def use(name) with(database: name) end
Provides a new client with the passed options merged over the existing options of this client. Useful for one-offs to change specific options without altering the original client.
@example Get a client with changed options.
client.with(:read => { :mode => :primary_preferred })
@param [ Hash ] new_options The new options to use.
@return [ Mongo::Client ] A new client instance.
@since 2.0.0
# File lib/mongo/client.rb, line 292 def with(new_options = Options::Redacted.new) clone.tap do |client| opts = validate_options(new_options) client.options.update(opts) Database.create(client) # We can't use the same cluster if some options that would affect it # have changed. if cluster_modifying?(opts) Cluster.create(client) end end end
Get the write concern for this client. If no option was provided, then a default single server acknowledgement will be used.
@example Get the client write concern.
client.write_concern
@return [ Mongo::WriteConcern ] The write concern.
@since 2.0.0
# File lib/mongo/client.rb, line 314 def write_concern @write_concern ||= WriteConcern.get(options[:write]) end
Private Instance Methods
# File lib/mongo/client.rb, line 389 def cluster_modifying?(new_options) cluster_options = new_options.reject do |name| CRUD_OPTIONS.include?(name.to_sym) end cluster_options.any? do |name, value| options[name] != value end end
# File lib/mongo/client.rb, line 368 def create_from_addresses(addresses, opts = Options::Redacted.new) @options = Database::DEFAULT_OPTIONS.merge(opts).freeze @cluster = Cluster.new(addresses, @monitoring, options) @database = Database.new(self, options[:database], options) end
# File lib/mongo/client.rb, line 374 def create_from_uri(connection_string, opts = Options::Redacted.new) uri = URI.new(connection_string, opts) @options = Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts)).freeze @cluster = Cluster.new(uri.servers, @monitoring, options) @database = Database.new(self, options[:database], options) end
# File lib/mongo/client.rb, line 381 def initialize_copy(original) @options = original.options.dup @monitoring = Monitoring.new(@options) @database = nil @read_preference = nil @write_concern = nil end
# File lib/mongo/client.rb, line 398 def validate_options(opts = Options::Redacted.new) return Options::Redacted.new unless opts Options::Redacted.new(opts.select do |o| if VALID_OPTIONS.include?(o) true else log_warn("Unsupported client option '#{o}'. It will be ignored.") false end end) end