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_COMPRESSORS
The compression algorithms supported by the driver.
@since 2.5.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'])
@example Directly connect to a mongod in a replica set
Mongo::Client.new(['127.0.0.1:27017'], :connect => :direct) # without `:connect => :direct`, Mongo::Client will discover and # connect to the replica set if given the address of a server in # a replica set
@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, :scram256
@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_idle_time The maximum seconds a socket can remain idle
since it has been checked in to the pool.
@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 [ Array<String> ] :compressors A list of potential compressors to use, in order of preference.
The driver chooses the first compressor that is also supported by the server. Currently the driver only supports 'zlib'.
@option options [ Hash ] :read The read preference options. The hash
may have the following items: - *:mode* -- read preference specified as a symbol; valid values are *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred* and *:nearest*. - *:tag_sets* -- an array of hashes. - *:local_threshold*.
@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 to do peer certificate
validation.
@option options [ String ] :ssl_ca_cert The file containing concatenated
certificate authority certificates 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 concatenated
certificate authority certificates 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 certificate authority certificates 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 [ Hash ] :read_concern The read concern option. @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.
@option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.
See Ruby's Zlib module for valid levels.
@option options [ true, false ] :retry_writes Retry writes once when
connected to a replica set or sharded cluster versions 3.6 and up.
@option options [ Proc ] :sdam_proc A Proc to invoke with the client
as the argument prior to performing server discovery and monitoring. Use this to set up SDAM event listeners to receive events dispatched during client construction.
@since 2.0.0
# File lib/mongo/client.rb, line 267 def initialize(addresses_or_uri, options = Options::Redacted.new) Mongo::Lint.validate_underscore_read_preference(options[:read]) if addresses_or_uri.is_a?(::String) uri = URI.get(addresses_or_uri, options) addresses = uri.servers options = uri.client_options.merge(options) else addresses = addresses_or_uri end options = options.dup # Special handling for sdam_proc as it is only used during client # construction sdam_proc = options.delete(:sdam_proc) @options = validate_options!(Database::DEFAULT_OPTIONS.merge(options)).freeze @database = Database.new(self, @options[:database], @options) monitoring = Monitoring.new(@options) if sdam_proc @cluster = Cluster.new([], monitoring, @options) sdam_proc.call(self) end @cluster = Cluster.new(addresses, monitoring, @options) 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 115 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 132 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 409 def close @cluster.disconnect! and true end
Get the names of all databases.
@example Get the database names.
client.database_names
@param [ Hash ] filter The filter criteria for getting a list of databases. @param [ Hash ] opts The command options.
@return [ Array<String> ] The names of the databases.
@since 2.0.5
# File lib/mongo/client.rb, line 442 def database_names(filter = {}, opts = {}) list_databases(filter, true, opts).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 144 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 299 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
@param [ Hash ] filter The filter criteria for getting a list of databases. @param [ true, false ] name_only Whether to only return each database name without full metadata. @param [ Hash ] opts The command options.
@return [ Array<Hash> ] The info for each database.
@since 2.0.5
# File lib/mongo/client.rb, line 458 def list_databases(filter = {}, name_only = false, opts = {}) cmd = { listDatabases: 1 } cmd[:nameOnly] = !!name_only cmd[:filter] = filter unless filter.empty? use(Database::ADMIN).command(cmd, opts).first[Database::DATABASES] end
Returns a list of Mongo::Database
objects.
@example Get a list of Mongo::Database
objects.
client.list_mongo_databases
@param [ Hash ] filter The filter criteria for getting a list of databases. @param [ Hash ] opts The command options.
@return [ Array<Mongo::Database> ] The list of database objects.
@since 2.5.0
# File lib/mongo/client.rb, line 476 def list_mongo_databases(filter = {}, opts = {}) database_names(filter, opts).collect do |name| Database.new(self, name, options) end end
Get the read concern for this client.
@example Get the client read concern.
client.read_concern
@return [ Hash ] The read concern.
@since 2.6.0
# File lib/mongo/client.rb, line 383 def read_concern @read_concern ||= options[:read_concern] end
Get the read preference from the options passed to the client.
@example Get the read preference.
client.read_preference
@return [ BSON::Document ] The user-defined read preference.
The document may have the following fields: - *:read* -- read preference specified as a symbol; valid values are *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred* and *:nearest*. - *:tag_sets* -- an array of hashes. - *:local_threshold*.
@since 2.0.0
# File lib/mongo/client.rb, line 331 def read_preference @read_preference ||= options[:read] end
Reconnect the client.
@example Reconnect the client.
client.reconnect
@return [ true ] Always true.
@since 2.1.0
# File lib/mongo/client.rb, line 421 def reconnect addresses = cluster.addresses.map(&:to_s) monitoring = cluster.monitoring @cluster.disconnect! rescue nil @cluster = Cluster.new(addresses, monitoring, options) true end
Get the server selector. It either uses the read preference defined in the client options or defaults to a Primary server selector.
@example Get the server selector.
client.server_selector
@return [ Mongo::ServerSelector
] The server selector using the
user-defined read preference or a Primary server selector default.
@since 2.5.0
# File lib/mongo/client.rb, line 313 def server_selector @server_selector ||= ServerSelector.get(read_preference || ServerSelector::PRIMARY) end
Start a session.
@example Start a session.
client.start_session(causal_consistency: true)
@param [ Hash ] options The session options.
@note A Session
cannot be used by multiple threads at once; session objects are not
thread-safe.
@return [ Session
] The session.
@since 2.5.0
# File lib/mongo/client.rb, line 495 def start_session(options = {}) cluster.send(:get_session, self, options.merge(implicit: false)) || (raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED)) 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 346 def use(name) with(database: name) end
As of version 3.6 of the MongoDB server, a “$changeStream“ pipeline stage is supported in the aggregation framework. As of version 4.0, this stage allows users to request that notifications are sent for all changes that occur in the client's cluster.
@example Get change notifications for the client's cluster.
client.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
@param [ Array<Hash> ] pipeline Optional additional filter operators. @param [ Hash ] options The change stream options.
@option options [ String ] :full_document Allowed values: 'default', 'updateLookup'.
Defaults to 'default'. When set to 'updateLookup', the change notification for partial updates will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.
@option options [ BSON::Document, Hash ] :resume_after Specifies the logical starting point
for the new change stream.
@option options [ Integer ] :max_await_time_ms The maximum amount of time for the server to
wait on new documents to satisfy a change stream query.
@option options [ Integer ] :batch_size The number of documents to return per batch. @option options [ BSON::Document, Hash ] :collation The collation to use. @option options [ Session
] :session The session to use. @option options [ BSON::Timestamp ] :start_at_operation_time Only return
changes that occurred at or after the specified timestamp. Any command run against the server will return a cluster time that can be used here. Only recognized by server versions 4.0+.
@note A change stream only allows 'majority' read concern. @note This helper method is preferable to running a raw aggregation with a $changeStream
stage, for the purpose of supporting resumability.
@return [ ChangeStream ] The change stream object.
@since 2.6.0
# File lib/mongo/client.rb, line 533 def watch(pipeline = [], options = {}) return use(Database::ADMIN).watch(pipeline, options) unless database.name == Database::ADMIN Mongo::Collection::View::ChangeStream.new( Mongo::Collection::View.new(self["#{Database::COMMAND}.aggregate"]), pipeline, Mongo::Collection::View::ChangeStream::CLUSTER, options) 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 362 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 397 def write_concern @write_concern ||= WriteConcern.get(options[:write]) end
Private Instance Methods
# File lib/mongo/client.rb, line 561 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 545 def get_session(options = {}) cluster.send(:get_session, self, options) end
# File lib/mongo/client.rb, line 553 def initialize_copy(original) @options = original.options.dup @monitoring = @cluster ? monitoring : Monitoring.new(options) @database = nil @read_preference = nil @write_concern = nil end
# File lib/mongo/client.rb, line 590 def valid_compressors(compressors) compressors.select do |compressor| if !VALID_COMPRESSORS.include?(compressor) log_warn("Unsupported compressor '#{compressor}' in list '#{compressors}'. " + "This compressor will not be used.") false else true end end end
# File lib/mongo/client.rb, line 602 def validate_max_min_pool_size!(option, opts) if option == :min_pool_size && opts[:min_pool_size] max = opts[:max_pool_size] || Server::ConnectionPool::Queue::MAX_SIZE raise Error::InvalidMinPoolSize.new(opts[:min_pool_size], max) unless opts[:min_pool_size] <= max end true end
# File lib/mongo/client.rb, line 570 def validate_options!(opts = Options::Redacted.new) return Options::Redacted.new unless opts opts.each.inject(Options::Redacted.new) do |_options, (k, v)| key = k.to_sym if VALID_OPTIONS.include?(key) validate_max_min_pool_size!(key, opts) validate_read!(key, opts) if key == :compressors compressors = valid_compressors(v) _options[key] = compressors unless compressors.empty? else _options[key] = v end else log_warn("Unsupported client option '#{k}'. It will be ignored.") end _options end end
# File lib/mongo/client.rb, line 610 def validate_read!(option, opts) if option == :read && opts.has_key?(:read) read = opts[:read] # We could check if read is a Hash, but this would fail # for custom classes implementing key access ([]). # Instead reject common cases of strings and symbols. if read.is_a?(String) || read.is_a?(Symbol) raise Error::InvalidReadOption.new(read, 'must be a hash') end if mode = read[:mode] mode = mode.to_sym unless Mongo::ServerSelector::PREFERENCES.include?(mode) raise Error::InvalidReadOption.new(read, "mode #{mode} is not one of recognized modes") end end end true end
# File lib/mongo/client.rb, line 549 def with_session(options = {}, &block) cluster.send(:with_session, self, options, &block) end