指定连接选项

在此页面上

Overview

设置连接选项
使用连接 URI
使用 mongocxx::options::client对象
读取连接选项
连接 URI 选项
副本集选项
连接选项
连接池选项
写关注选项
读关注选项
读取偏好选项
身份验证选项
服务器选择和发现选项
其他配置

Overview

本页介绍了C++驾驶员中可用的MongoDB连接和身份验证选项。

设置连接选项

您可以通过在连接 URI 中指定选项或将 mongocxx::options::client类的实例作为client_options参数传递给mongocxx::client构造函数来配置连接。

注意

您可以仅在连接 URI 中指定某些连接选项，而其他连接选项则只能在client_options参数中指定。您可能需要结合使用这些方法来指定所需的所有选项。

使用连接 URI

构造mongocxx::client对象时，可以传入表示连接 URI 的mongocxx::uri对象。此连接 URI 可以包含<name>=<value>对形式的连接选项。在以下示例中，连接 URItls 包含值为的true 选项和值为tlsCertificateKeyFile 的path/to/file.pem 选项：

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true&tlsCertificateKeyFile=path/to/file.pem");
    mongocxx::client client(uri);
}

`mongocxx::options::client`使用对象

mongocxx::client构造函数包含一个client_options参数，该参数接受mongocxx::options::client类的实例。您可以在client_options参数中指定某些选项，而不是将其包含在连接 URI 中。

以下示例演示如何使用client_options参数设立连接选项：

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::options::client client_options;
    mongocxx::options::tls tls_options;
    tls_options.pem_file("/path/to/file.pem");
    client_options.tls_opts(tls_options);
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true");
    mongocxx::client client(uri, client_options);
}

读取连接选项

构造mongocxx::client对象后，您可以使用mongocxx::uri对象的属性读取某些连接选项的值。

以下示例展示了如何使用tls()属性读取tls连接选项的值：

#include <mongocxx/uri.hpp>
#include <mongocxx/client.hpp>
#include <mongocxx/instance.hpp>
int main()
{
    mongocxx::instance instance;
    mongocxx::uri uri("mongodb://<hostname>:<port>/?tls=true");
    mongocxx::client client(uri);
    auto is_tls_enabled = uri.tls();
}

以下部分显示了支持该连接的每个连接选项的相应mongocxx::uri属性。

连接 URI 选项

以下部分介绍了可以在传递给C++驾驶员的连接 URI 中设立的连接选项。每个连接选项都链接到MongoDB Server手册及其相应的mongocxx::uri属性（如果支持）。

副本集选项

连接 URI 选项	`mongocxx::uri` 成员
directConnection	direct_connection()
replicaSet	replica_set()

连接选项

TLS 选项

连接 URI 选项	`mongocxx::uri` 成员
TLS	tls()
tlsCertificateKeyFile	tls_certificate_key_file()
tlsCertificateKeyFilePassword	tls_certificate_key_file_password()
tlsCAFile	tls_ca_file()
tlsAllowInvalidCertificates	tls_allow_invalid_certificates()
tlsAllowInvalidHostnames	tls_allow_invalid_hostnames()
tlsInsecure	tls_insecure()
tlsDisableCertificateReplicationCheck	tls_disable_certificate_replication_check()
tlsDisableOCSPEndpointCheck	tls_disable_ocsp_endpoint_check()

提示

您可以使用client_options参数设立大多数 TLS 选项。请参阅 mongocxx::options::tls API文档以了解更多信息。

超时选项

连接 URI 选项	`mongocxx::uri` 成员
connectTimeoutMS	connect_timeout_ms()
socketTimeoutMS	socket_timoeout_ms()

压缩选项

连接 URI 选项	`mongocxx::uri` 成员
compressors	Compressor()
zlibCompressionLevel	zlib_compression_level()

连接池选项

连接 URI 选项	`mongocxx::uri` 成员
maxPoolSize	max_pool_size()
waitQueueTimeoutMS	wait_queue_timeout_ms()

写关注选项

连接 URI 选项	`mongocxx::uri` 成员
w	write_concern()
wtimeoutMS	不适用
journal	不适用

读关注选项

连接 URI 选项	`mongocxx::uri` 成员
readConcernLevel	read_concern()

读取偏好选项

连接 URI 选项	`mongocxx::uri` 成员
readPreference	read_preference()
maxStalenessSeconds	不适用
readPreferenceTags	不适用

身份验证选项

连接 URI 选项	`mongocxx::uri` 成员
authMechanism	auth_ Mechanism()
authMechanismProperties	auth_ Mechanism_properties()
authSource	auth_source()

服务器选择和发现选项

连接 URI 选项	`mongocxx::uri` 成员
localThresholdMS	local_threshold_ms()
serverSelectionTimeoutMS	server_selection_timeout_ms()
serverSelectionTryOnce	server_selection_try_once()
heartbeatFrequencyMS	heartbeat_Frequency_ms()
socketCheckIntervalMS	不适用

其他配置

连接 URI 选项	`mongocxx::uri` 成员
appName	appname()
retryReads	retry_reads()
retryWrites	retry_writes()
loadBalanced	不适用
SrvMaxHosts	srv_max_hosts()

后退

选择连接目标

来年

配置 TLS