Struct mongodb::options::ClientOptions [−][src]
#[non_exhaustive]pub struct ClientOptions {Show 22 fields
pub hosts: Vec<StreamAddress>,
pub app_name: Option<String>,
pub cmap_event_handler: Option<Arc<dyn CmapEventHandler>>,
pub command_event_handler: Option<Arc<dyn CommandEventHandler>>,
pub connect_timeout: Option<Duration>,
pub credential: Option<Credential>,
pub direct_connection: Option<bool>,
pub driver_info: Option<DriverInfo>,
pub heartbeat_freq: Option<Duration>,
pub local_threshold: Option<Duration>,
pub max_idle_time: Option<Duration>,
pub max_pool_size: Option<u32>,
pub min_pool_size: Option<u32>,
pub read_concern: Option<ReadConcern>,
pub repl_set_name: Option<String>,
pub retry_reads: Option<bool>,
pub retry_writes: Option<bool>,
pub selection_criteria: Option<SelectionCriteria>,
pub server_selection_timeout: Option<Duration>,
pub tls: Option<Tls>,
pub wait_queue_timeout: Option<Duration>,
pub write_concern: Option<WriteConcern>,
// some fields omitted
}
Expand description
Contains the options that can be used to create a new Client
.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.hosts: Vec<StreamAddress>
The initial list of seeds that the Client should connect to.
Note that by default, the driver will autodiscover other nodes in the cluster. To connect
directly to a single server (rather than autodiscovering the rest of the cluster), set the
direct
field to true
.
app_name: Option<String>
The application name that the Client will send to the server as part of the handshake. This can be used in combination with the server logs to determine which Client is connected to a server.
cmap_event_handler: Option<Arc<dyn CmapEventHandler>>
The handler that should process all Connection Monitoring and Pooling events. See the CmapEventHandler type documentation for more details.
command_event_handler: Option<Arc<dyn CommandEventHandler>>
The handler that should process all command-related events. See the CommandEventHandler type documentation for more details.
connect_timeout: Option<Duration>
The connect timeout passed to each underlying TcpStream when attemtping to connect to the server.
The default value is 10 seconds.
credential: Option<Credential>
The credential to use for authenticating connections made by this client.
direct_connection: Option<bool>
Specifies whether the Client should directly connect to a single host rather than autodiscover all servers in the cluster.
The default value is false.
driver_info: Option<DriverInfo>
Extra information to append to the driver version in the metadata of the handshake with the server. This should be used by libraries wrapping the driver, e.g. ODMs.
heartbeat_freq: Option<Duration>
The amount of time each monitoring thread should wait between sending an isMaster command to its respective server.
The default value is 10 seconds.
local_threshold: Option<Duration>
When running a read operation with a ReadPreference that allows selecting secondaries,
local_threshold
is used to determine how much longer the average round trip time between
the driver and server is allowed compared to the least round trip time of all the suitable
servers. For example, if the average round trip times of the suitable servers are 5 ms, 10
ms, and 15 ms, and the local threshold is 8 ms, then the first two servers are within the
latency window and could be chosen for the operation, but the last one is not.
A value of zero indicates that there is no latency window, so only the server with the lowest average round trip time is eligible.
The default value is 15 ms.
max_idle_time: Option<Duration>
The amount of time that a connection can remain idle in a connection pool before being closed. A value of zero indicates that connections should not be closed due to being idle.
By default, connections will not be closed due to being idle.
max_pool_size: Option<u32>
The maximum amount of connections that the Client should allow to be created in a
connection pool for a given server. If an operation is attempted on a server while
max_pool_size
connections are checked out, the operation will block until an in-progress
operation finishes and its connection is checked back into the pool.
The default value is 100.
min_pool_size: Option<u32>
The minimum number of connections that should be available in a server’s connection pool at
a given time. If fewer than min_pool_size
connections are in the pool, connections will
be added to the pool in the background until min_pool_size
is reached.
The default value is 0.
read_concern: Option<ReadConcern>
Specifies the default read concern for operations performed on the Client. See the ReadConcern type documentation for more details.
repl_set_name: Option<String>
The name of the replica set that the Client should connect to.
retry_reads: Option<bool>
Whether or not the client should retry a read operation if the operation fails.
The default value is true.
retry_writes: Option<bool>
Whether or not the client should retry a write operation if the operation fails.
The default value is true.
selection_criteria: Option<SelectionCriteria>
The default selection criteria for operations performed on the Client. See the SelectionCriteria type documentation for more details.
server_selection_timeout: Option<Duration>
The amount of time the Client should attempt to select a server for an operation before timing outs
The default value is 30 seconds.
tls: Option<Tls>
The TLS configuration for the Client to use in its connections with the server.
By default, TLS is disabled.
wait_queue_timeout: Option<Duration>
The amount of time a thread should block while waiting to check out a connection before
returning an error. Note that if there are fewer than max_pool_size
connections checked
out or if a connection is available in the pool, checking out a connection will not block.
By default, threads will wait indefinitely for a connection to become available.
write_concern: Option<WriteConcern>
Specifies the default write concern for operations performed on the Client. See the WriteConcern type documentation for more details.
Implementations
Create a builder for building ClientOptions
.
On the builder, call .hosts(...)
(optional), .app_name(...)
(optional), .compressors(...)
(optional), .cmap_event_handler(...)
(optional), .command_event_handler(...)
(optional), .connect_timeout(...)
(optional), .credential(...)
(optional), .direct_connection(...)
(optional), .driver_info(...)
(optional), .heartbeat_freq(...)
(optional), .local_threshold(...)
(optional), .max_idle_time(...)
(optional), .max_pool_size(...)
(optional), .min_pool_size(...)
(optional), .read_concern(...)
(optional), .repl_set_name(...)
(optional), .retry_reads(...)
(optional), .retry_writes(...)
(optional), .selection_criteria(...)
(optional), .server_selection_timeout(...)
(optional), .socket_timeout(...)
(optional), .tls(...)
(optional), .wait_queue_timeout(...)
(optional), .write_concern(...)
(optional), .zlib_compression(...)
(optional), .original_srv_hostname(...)
(optional), .original_uri(...)
(optional), .resolver_config(...)
(optional), .heartbeat_freq_test(...)
(optional) to set the values of the fields (they accept Into
values).
Finally, call .build()
to create the instance of ClientOptions
.
Parses a MongoDB connection string into a ClientOptions struct. If the string is malformed or one of the options has an invalid value, an error will be returned.
In the case that “mongodb+srv” is used, SRV and TXT record lookups will be done as part of this method.
The format of a MongoDB connection string is described here.
The following options are supported in the options query string:
appName
: maps to theapp_name
fieldauthMechanism
: maps to themechanism
field of thecredential
fieldauthSource
: maps to thesource
field of thecredential
fieldauthMechanismProperties
: maps to themechanism_properties
field of thecredential
fieldcompressors
: not yet implementedconnectTimeoutMS
: maps to theconnect_timeout
fielddirect
: maps to thedirect
fieldheartbeatFrequencyMS
: maps to theheartbeat_frequency
fieldjournal
: maps to thejournal
field of thewrite_concern
fieldlocalThresholdMS
: maps to thelocal_threshold
fieldmaxIdleTimeMS
: maps to themax_idle_time
fieldmaxStalenessSeconds
: maps to themax_staleness
field of theselection_criteria
fieldmaxPoolSize
: maps to themax_pool_size
fieldminPoolSize
: maps to themin_pool_size
fieldreadConcernLevel
: maps to theread_concern
fieldreadPreferenceField
: maps to the ReadPreference enum variant of theselection_criteria
fieldreadPreferenceTags
: maps to thetags
field of theselection_criteria
field. Note that this option can appear more than once; each instance will be mapped to a separate tag setreplicaSet
: maps to therepl_set_name
fieldretryWrites
: not yet implementedretryReads
: maps to theretry_reads
fieldserverSelectionTimeoutMS
: maps to theserver_selection_timeout
fieldsocketTimeoutMS
: maps to thesocket_timeout
fieldssl
: an alias of thetls
optiontls
: maps to the TLS variant of thetls
field`.tlsInsecure
: relaxes the TLS constraints on connections being made; currently is just an alias oftlsAllowInvalidCertificates
, but more behavior may be added to this option in the futuretlsAllowInvalidCertificates
: maps to theallow_invalidCertificates
field of thetls
fieldtlsCAFile
: maps to theca_file_path
field of thetls
fieldtlsCertificateKeyFile
: maps to thecert_key_file_path
field of thetls
fieldw
: maps to thew
field of thewrite_concern
fieldwaitQueueTimeoutMS
: maps to thewait_queue_timeout
fieldwTimeoutMS
: maps to thew_timeout
field of thewrite_concern
fieldzlibCompressionLevel
: not yet implemented
Note: if the sync
feature is enabled, then this method will be replaced with the sync
version.
This is supported on crate feature sync
only.
sync
only.This method will be present if the sync
feature is enabled. It’s otherwise identical to
the async version
pub async fn parse_with_resolver_config(
uri: &str,
resolver_config: ResolverConfig
) -> Result<Self>
pub async fn parse_with_resolver_config(
uri: &str,
resolver_config: ResolverConfig
) -> Result<Self>
Parses a MongoDB connection string into a ClientOptions
struct.
If the string is malformed or one of the options has an invalid value, an error will be
returned.
In the case that “mongodb+srv” is used, SRV and TXT record lookups will be done using the
provided ResolverConfig
as part of this method.
The format of a MongoDB connection string is described here.
See the docstring on ClientOptions::parse
for information on how the various URI options
map to fields on ClientOptions
.
Note: if the sync
feature is enabled, then this method will be replaced with the sync
version.
This is supported on crate feature sync
only.
sync
only.This method will be present if the sync
feature is enabled. It’s otherwise identical to
the async version
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ClientOptions
impl Send for ClientOptions
impl Sync for ClientOptions
impl Unpin for ClientOptions
impl !UnwindSafe for ClientOptions
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self