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 behavior 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

cluster[R]

@return [ Mongo::Cluster ] cluster The cluster of servers for the client.

database[R]

@return [ Mongo::Database ] database The database the client is operating on.

options[R]

@return [ Hash ] options The configuration options.

Public Class Methods

new(addresses_or_uri, options = nil) { |self| ... } click to toggle source

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. If a MongoDB URI

connection string is also provided, these options take precedence over any
analogous options present in the URI string.

@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 [ Symbol ] :auth_mech The authentication mechanism to

use. One of :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256

@option options [ Hash ] :auth_mech_properties @option options [ String ] :auth_source The source to authenticate from. @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 [ 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 [ Float ] :connect_timeout The timeout, in seconds, to

attempt a connection.

@option options [ String ] :database The database to connect to. @option options [ Float ] :heartbeat_frequency The interval, in seconds,

for the server monitor to refresh its description via ismaster.

@option options [ Object ] :id_generator A custom object to generate ids

for documents. Must respond to #generate.

@option options [ Integer ] :local_threshold The local threshold boundary

in seconds for selecting a near server for an operation.

@option options [ Logger ] :logger A custom logger to use. @option options [ String ] :log_prefix A custom log prefix to use when

logging. This option is experimental and subject to change in a future
version of the driver.

@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 ] :max_read_retries The maximum number of read

retries when legacy read retries are in use.

@option options [ Integer ] :max_write_retries The maximum number of write

retries when legacy write retries are in use.

@option options [ Integer ] :min_pool_size The minimum size of the

connection pool.

@option options [ true, false ] :monitoring If false is given, the

client is initialized without global SDAM event subscribers and
will not publish SDAM events. Command monitoring and legacy events
will still be published, and the driver will still perform SDAM and
monitor its cluster in order to perform server selection. Built-in
driver logging of SDAM events will be disabled because it is
implemented through SDAM event subscription. Client#subscribe will
succeed for all event types, but subscribers to SDAM events will
not be invoked. Values other than false result in default behavior
which is to perform normal SDAM event publication.

@option options [ true, false ] :monitoring_io For internal driver

use only. Set to false to prevent SDAM-related I/O from being
done by this client or servers under it. Note: setting this option
to false will make the client non-functional. It is intended for
use in tests which manually invoke SDAM state transitions.

@option options [ true | false ] :cleanup For internal driver use only.

Set to false to prevent endSessions command being sent to the server
to clean up server sessions when the cluster is disconnected, and to
to not start the periodic executor. If :monitoring_io is false,
:cleanup automatically defaults to false as well.

@option options [ String ] :password The user's password. @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 [ 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 [ Hash ] :read_concern The read concern option. @option options [ Float ] :read_retry_interval The interval, in seconds,

in which reads on a mongos are retried.

@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 ] :retry_reads If true, modern retryable

reads are enabled (which is the default). If false, modern retryable
reads are disabled and legacy retryable reads are enabled.

@option options [ true | false ] :retry_writes Retry writes once when

connected to a replica set or sharded cluster versions 3.6 and up.
(Default is true.)

@option options [ true | false ] :scan Whether to scan all seeds

in constructor. The default in driver version 2.x is to do so;
driver version 3.x will not scan seeds in constructor. Opt in to the
new behavior by setting this option to false. *Note:* setting
this option to nil enables scanning seeds in constructor in driver
version 2.x. Driver version 3.x will recognize this option but
will ignore it and will never scan seeds in the constructor.

@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.

Note: the client is not fully constructed when sdam_proc is invoked,
in particular the cluster is nil at this time. sdam_proc should
limit itself to calling #subscribe and #unsubscribe methods on the
client only.

@option options [ Integer ] :server_selection_timeout The timeout in seconds

for selecting a server for an operation.

@option options [ Float ] :socket_timeout The timeout, in seconds, to

execute operations on a socket.

@option options [ true, false ] :ssl Whether to use SSL. @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. Intermediate certificates should NOT be
specified in files referenced by this option. One of :ssl_ca_cert,
:ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is
required when using :ssl_verify.

@option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object

An array of OpenSSL::X509::Certificate objects representing the
certificate authority certificates used to validate certs passed from
the other end of the connection. Intermediate certificates should NOT
be specified in files referenced by this option. One of :ssl_ca_cert,
:ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority)
is required when using :ssl_verify.

@option options [ String ] :ssl_ca_cert_string A string containing

certificate authority certificate used to validate certs passed from the
other end of the connection. This option allows passing only one CA
certificate to the driver. Intermediate certificates should NOT
be specified in files referenced by this option. One of :ssl_ca_cert,
:ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is
required when using :ssl_verify.

@option options [ String ] :ssl_cert The certificate file used to identify

the connection against MongoDB. A certificate chain may be passed by
specifying the client certificate first followed by any intermediate
certificates up to the CA certificate. The file may also contain the
certificate's private key, which will be ignored. This option, if present,
takes precedence over the values of :ssl_cert_string and :ssl_cert_object

@option options [ OpenSSL::X509::Certificate ] :ssl_cert_object The OpenSSL::X509::Certificate

used to identify the connection against MongoDB. Only one certificate
may be passed through this option.

@option options [ String ] :ssl_cert_string A string containing the PEM-encoded

certificate used to identify the connection against MongoDB. A certificate
chain may be passed by specifying the client certificate first followed
by any intermediate certificates up to the CA certificate. The string
may also contain the certificate's private key, which will be ignored,
This option, if present, takes precedence over the value of :ssl_cert_object

@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 [ 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 [ 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 [ true, false ] :ssl_verify Whether to perform peer certificate validation and

hostname verification. Note that the decision of whether to validate certificates will be
overridden if :ssl_verify_certificate is set, and the decision of whether to validate
hostnames will be overridden if :ssl_verify_hostname is set.

@option options [ true, false ] :ssl_verify_certificate Whether to perform peer certificate

validation. This setting overrides :ssl_verify with respect to whether certificate
validation is performed.

@option options [ true, false ] :ssl_verify_hostname Whether to perform peer hostname

validation. This setting overrides :ssl_verify with respect to whether hostname validation
is performed.

@option options [ true, false ] :truncate_logs Whether to truncate the

logs at the default 250 characters.

@option options [ String ] :user The user name. @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 [ Hash ] :write Deprecated. Equivalent to :write_concern

option.

@option options [ Hash ] :write_concern The write concern options.

Can be :w => Integer|String, :wtimeout => Integer (in milliseconds),
:j => Boolean, :fsync => Boolean.

@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 [ Hash ] :resolv_options For internal driver use only.

Options to pass through to Resolv::DNS constructor for SRV lookups.

@since 2.0.0

# File lib/mongo/client.rb, line 374
    def initialize(addresses_or_uri, options = nil)
      options = options ? options.dup : {}

      srv_uri = nil
      if addresses_or_uri.is_a?(::String)
        uri = URI.get(addresses_or_uri, options)
        if uri.is_a?(URI::SRVProtocol)
          # If the URI is an SRV URI, note this so that we can start
          # SRV polling if the topology is a sharded cluster.
          srv_uri = uri
        end
        addresses = uri.servers
        uri_options = uri.client_options.dup
        # Special handing for :write and :write_concern: allow client Ruby
        # options to override URI options, even when the Ruby option uses the
        # deprecated :write key and the URI option uses the current
        # :write_concern key
        if options[:write]
          uri_options.delete(:write_concern)
        end
        options = uri_options.merge(options)
        @srv_records = uri.srv_records
      else
        addresses = addresses_or_uri
        @srv_records = nil
      end

      # Special handling for sdam_proc as it is only used during client
      # construction
      sdam_proc = options.delete(:sdam_proc)

      options = default_options(options).merge(options)
      @options = validate_new_options!(options)
=begin WriteConcern object support
      if @options[:write_concern].is_a?(WriteConcern::Base)
        # Cache the instance so that we do not needlessly reconstruct it.
        @write_concern = @options[:write_concern]
        @options[:write_concern] = @write_concern.options
      end
=end
      @options.freeze
      validate_options!
      validate_authentication_options!

      @database = Database.new(self, @options[:database], @options)

      # Temporarily set monitoring so that event subscriptions can be
      # set up without there being a cluster
      @monitoring = Monitoring.new(@options)

      if sdam_proc
        sdam_proc.call(self)
      end

      @cluster = Cluster.new(addresses, @monitoring, cluster_options.merge(srv_uri: srv_uri))

      # Unset monitoring, it will be taken out of cluster from now on
      remove_instance_variable('@monitoring')

      yield(self) if block_given?
    end

Public Instance Methods

==(other) click to toggle source

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 149
def ==(other)
  return false unless other.is_a?(Client)
  cluster == other.cluster && options == other.options
end
Also aliased as: eql?
[](collection_name, options = {}) click to toggle source

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 166
def [](collection_name, options = {})
  database[collection_name, options]
end
close() click to toggle source

Close all connections.

@return [ true ] Always true.

@since 2.1.0

# File lib/mongo/client.rb, line 666
def close
  @cluster.disconnect!
  true
end
cluster_options() click to toggle source

@api private

# File lib/mongo/client.rb, line 437
def cluster_options
  # We share clusters when a new client with different CRUD_OPTIONS
  # is requested; therefore, cluster should not be getting any of these
  # options upon instantiation
  options.reject do |key, value|
    CRUD_OPTIONS.include?(key.to_sym)
  end.merge(
    # but need to put the database back in for auth...
    database: options[:database],

    # Put these options in for legacy compatibility, but note that
    # their values on the client and the cluster do not have to match -
    # applications should read these values from client, not from cluster
    max_read_retries: options[:max_read_retries],
    read_retry_interval: options[:read_retry_interval],
  ).tap do |options|
    # If the client has a cluster already, forward srv_uri to the new
    # cluster to maintain SRV monitoring. If the client is brand new,
    # its constructor sets srv_uri manually.
    if cluster
      options.update(srv_uri: cluster.options[:srv_uri])
    end
  end
end
database_names(filter = {}, opts = {}) click to toggle source

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 699
def database_names(filter = {}, opts = {})
  list_databases(filter, true, opts).collect{ |info| info['name'] }
end
eql?(other)
Alias for: ==
hash() click to toggle source

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 178
def hash
  [cluster, options].hash
end
inspect() click to toggle source

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 500
def inspect
  "#<Mongo::Client:0x#{object_id} cluster=#{cluster.summary}>"
end
list_databases(filter = {}, name_only = false, opts = {}) click to toggle source

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 715
def list_databases(filter = {}, name_only = false, opts = {})
  cmd = { listDatabases: 1 }
  cmd[:nameOnly] = !!name_only
  cmd[:filter] = filter unless filter.empty?
  use(Database::ADMIN).database.read_command(cmd, opts).first[Database::DATABASES]
end
list_mongo_databases(filter = {}, opts = {}) click to toggle source

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 733
def list_mongo_databases(filter = {}, opts = {})
  database_names(filter, opts).collect do |name|
    Database.new(self, name, options)
  end
end
max_read_retries() click to toggle source

Get the maximum number of times the client can retry a read operation when using legacy read retries.

@return [ Integer ] The maximum number of retries.

@api private

# File lib/mongo/client.rb, line 468
def max_read_retries
  options[:max_read_retries] || Cluster::MAX_READ_RETRIES
end
max_write_retries() click to toggle source

Get the maximum number of times the client can retry a write operation when using legacy write retries.

@return [ Integer ] The maximum number of retries.

@api private

# File lib/mongo/client.rb, line 488
def max_write_retries
  options[:max_write_retries] || Cluster::MAX_WRITE_RETRIES
end
read_concern() click to toggle source

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 643
def read_concern
  options[:read_concern]
end
read_preference() click to toggle source

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 551
def read_preference
  @read_preference ||= options[:read]
end
read_retry_interval() click to toggle source

Get the interval, in seconds, in which read retries when using legacy read retries.

@return [ Float ] The interval.

@api private

# File lib/mongo/client.rb, line 478
def read_retry_interval
  options[:read_retry_interval] || Cluster::READ_RETRY_INTERVAL
end
reconnect() click to toggle source

Reconnect the client.

@example Reconnect the client.

client.reconnect

@return [ true ] Always true.

@since 2.1.0

# File lib/mongo/client.rb, line 679
def reconnect
  addresses = cluster.addresses.map(&:to_s)

  @cluster.disconnect! rescue nil

  @cluster = Cluster.new(addresses, monitoring, cluster_options)
  true
end
server_selector() click to toggle source

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 529
def server_selector
  @server_selector ||= if read_preference
    ServerSelector.get(read_preference)
  else
    ServerSelector.primary
  end
end
start_session(options = {}) click to toggle source

Start a session.

If the deployment does not support sessions, raises Mongo::Error::InvalidSession. This exception can also be raised when the driver is not connected to a data-bearing server, for example during failover.

@example Start a session.

client.start_session(causal_consistency: true)

@param [ Hash ] options The session options. Accepts the options

that Session#initialize accepts.

@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 758
def start_session(options = {})
  get_session(options.merge(implicit: false)) or
    raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED)
end
summary() click to toggle source

Get a summary of the client state.

@note This method is experimental and subject to change.

@example Inspect the client.

client.summary

@return [ String ] Summary string.

@since 2.7.0 @api experimental

# File lib/mongo/client.rb, line 515
def summary
  "#<Client cluster=#{cluster.summary}>"
end
update_options(new_options) click to toggle source

Updates this client's options from new_options, validating all options.

The new options may be transformed according to various rules. The final hash of options actually applied to the client is returned.

If options fail validation, this method may warn or raise an exception. If this method raises an exception, the client should be discarded (similarly to if a constructor raised an exception).

@param [ Hash ] new_options The new options to use.

@return [ Hash ] Modified new options written into the client.

@api private

# File lib/mongo/client.rb, line 618
def update_options(new_options)
  validate_new_options!(new_options).tap do |opts|
    # Our options are frozen
    options = @options.dup
    if options[:write] && opts[:write_concern]
      options.delete(:write)
    end
    if options[:write_concern] && opts[:write]
      options.delete(:write_concern)
    end
    options.update(opts)
    @options = options.freeze
    validate_options!
    validate_authentication_options!
  end
end
use(name) click to toggle source

Creates a new client configured to use the database with the provided name, and using the other options configured in this client.

@note The new client shares the cluster with the original client,

and as a result also shares the monitoring instance and monitoring
event subscribers.

@example Create a client for the `users' database.

client.use(:users)

@param [ String, Symbol ] name The name of the database to use.

@return [ Mongo::Client ] A new client instance.

@since 2.0.0

# File lib/mongo/client.rb, line 570
def use(name)
  with(database: name)
end
watch(pipeline = [], options = {}) click to toggle source

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 796
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
with(new_options = Options::Redacted.new) click to toggle source

Creates 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.

@note Depending on options given, the returned client may share the

cluster with the original client or be created with a new cluster.
If a new cluster is created, the monitoring event subscribers on
the new client are set to the default event subscriber set and
none of the subscribers on the original client are copied over.

@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 592
def with(new_options = Options::Redacted.new)
  clone.tap do |client|
    opts = client.update_options(new_options)
    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
write_concern() click to toggle source

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 657
def write_concern
  @write_concern ||= WriteConcern.get(options[:write_concern] || options[:write])
end

Private Instance Methods

cluster_modifying?(new_options) click to toggle source
# File lib/mongo/client.rb, line 859
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
default_options(options) click to toggle source

Generate default client options based on the URI and options passed into the Client constructor.

# File lib/mongo/client.rb, line 810
def default_options(options)
  Database::DEFAULT_OPTIONS.dup.tap do |default_options|
    if options[:auth_mech] || options[:user]
      default_options[:auth_source] = Auth::User.default_auth_source(options)
    end

    if options[:auth_mech] == :gssapi
      default_options[:auth_mech_properties] = { service_name: 'mongodb' }
    end

    default_options[:retry_reads] = true
    default_options[:retry_writes] = true
  end
end
get_session(options = {}) click to toggle source

If options is set, validates that session and returns it. If deployment supports sessions, creates a new session and returns it. The session is implicit unless options is given. If deployment does not support session, returns nil.

@return [ Session | nil ] Session object or nil if sessions are not

supported by the deployment.
# File lib/mongo/client.rb, line 832
def get_session(options = {})
  if options[:session]
    return options[:session].validate!(self)
  end

  if cluster.sessions_supported?
    Session.new(cluster.session_pool.checkout, self, { implicit: true }.merge(options))
  end
end
initialize_copy(original) click to toggle source
# File lib/mongo/client.rb, line 851
def initialize_copy(original)
  @options = original.options.dup
  @monitoring = @cluster ? monitoring : Monitoring.new(options)
  @database = nil
  @read_preference = nil
  @write_concern = nil
end
monitoring() click to toggle source

@return [ Monitoring ] monitoring The monitoring. @api private

# File lib/mongo/client.rb, line 130
def monitoring
  if cluster
    cluster.monitoring
  else
    @monitoring
  end
end
valid_compressors(compressors) click to toggle source
# File lib/mongo/client.rb, line 945
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
validate_authentication_options!() click to toggle source

Validates all authentication-related options after they are set on the client This method is intended to catch combinations of options which are not allowed

# File lib/mongo/client.rb, line 905
def validate_authentication_options!
  auth_mech = options[:auth_mech]
  user = options[:user]
  password = options[:password]
  auth_source = options[:auth_source]
  mech_properties = options[:auth_mech_properties]

  if auth_mech.nil?
    if user && user.empty?
      raise Mongo::Auth::InvalidConfiguration.new('empty username is not supported for default auth mechanism')
    end

    return
  end

  if !Mongo::Auth::SOURCES.key?(auth_mech)
    raise Mongo::Auth::InvalidMechanism.new(auth_mech)
  end

  if user.nil? && auth_mech != :mongodb_x509
    raise Mongo::Auth::InvalidConfiguration.new("user is required for mechanism #{auth_mech}")
  end

  if password.nil? && ![:gssapi, :mongodb_x509].include?(auth_mech)
    raise Mongo::Auth::InvalidConfiguration.new("password is required for mechanism #{auth_mech}")
  end

  if password && auth_mech == :mongodb_x509
    raise Mongo::Auth::InvalidConfiguration.new('password is not supported for mongodb_x509')
  end

  if !['$external', nil].include?(auth_source) && [:gssapi, :mongodb_x509].include?(auth_mech)
    raise Mongo::Auth::InvalidConfiguration.new("#{auth_source} is an invalid auth source for #{auth_mech}; valid options are $external and nil")
  end

  if mech_properties && auth_mech != :gssapi
    raise Mongo::Auth::InvalidConfiguration.new("mechanism_properties are not supported for #{auth_mech}")
  end
end
validate_max_min_pool_size!(option, opts) click to toggle source
# File lib/mongo/client.rb, line 957
def validate_max_min_pool_size!(option, opts)
  if option == :min_pool_size && opts[:min_pool_size]
    max = opts[:max_pool_size] || Server::ConnectionPool::DEFAULT_MAX_SIZE
    raise Error::InvalidMinPoolSize.new(opts[:min_pool_size], max) unless opts[:min_pool_size] <= max
  end
  true
end
validate_new_options!(opts = Options::Redacted.new) click to toggle source

Validates options in the provided argument for validity. The argument may contain a subset of options that the client will eventually have; this method validates each of the provided options but does not check for interactions between combinations of options.

# File lib/mongo/client.rb, line 872
def validate_new_options!(opts = Options::Redacted.new)
  return Options::Redacted.new unless opts
  Lint.validate_underscore_read_preference(opts[:read])
  Lint.validate_read_concern_option(opts[:read_concern])
  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
validate_options!() click to toggle source

Validates all options after they are set on the client. This method is intended to catch combinations of options which are not allowed.

# File lib/mongo/client.rb, line 897
def validate_options!
  if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
    raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
  end
end
validate_read!(option, opts) click to toggle source
# File lib/mongo/client.rb, line 965
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
with_session(options = {}) { |session| ... } click to toggle source
# File lib/mongo/client.rb, line 842
def with_session(options = {}, &block)
  session = get_session(options)
  yield(session)
ensure
  if session && session.implicit?
    session.end_session
  end
end