Especificar opções de conexão

Nesta página

Visão geral

Definir opções de conexão
Como utilizar o URI de conexão
Usando um objeto mongocxx::options::client
Ler opções de conexão
Opções de URI de conexão
Opções de conjunto de réplicas
Opções de conexão
Opções do pool de conexões
Opções de write concern
Opções de read concern
Opções de read preference
Opções de autenticação
Seleção de servidor e opções de descoberta
Configurações diversas

Visão geral

Esta página descreve as opções de conexão e autenticação MongoDB disponíveis no driver C++ .

Definir opções de conexão

Você pode configurar sua conexão especificando opções no URI de conexão ou passando uma instância da classe mongocxx::options::client como parâmetro client_options para o construtor mongocxx::client .

Observação

Você pode especificar algumas opções de conexão somente no URI de conexão e outras somente no parâmetro client_options . Talvez seja necessário combinar esses métodos para especificar todas as opções necessárias.

Como utilizar o URI de conexão

Ao construir um objeto mongocxx::client , você pode passar um objeto mongocxx::uri que representa seu URI de conexão. Esse URI de conexão pode incluir opções de conexão como <name>=<value> pares. No exemplo a seguir , o URI de conexão contém a opção tls com um valor de true e a opção tlsCertificateKeyFile com um valor de 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);
}

Usando um `mongocxx::options::client` objeto

O construtor mongocxx::client inclui um parâmetro client_options que aceita uma instância da classe mongocxx::options::client . Você pode especificar determinadas opções no parâmetro client_options em vez de incluí-las em seu URI de conexão.

O exemplo seguinte mostra como utilizar o parâmetro client_options para configurar opções de conexão:

#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);
}

Ler opções de conexão

Após construir um objeto mongocxx::client , você pode ler os valores de determinadas opções de conexão usando propriedades do objeto mongocxx::uri .

O exemplo seguinte mostra como ler o valor das opções de conexão do tls utilizando a propriedade 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();
}

As seções a seguir mostram a propriedade mongocxx::uri correspondente para cada opção de conexão compatível.

Opções de URI de conexão

As seções a seguir descrevem as opções de conexão que você pode definir no URI de conexão passado para o driver C++ . Cada opção de conexão está vinculada ao manual do MongoDB Server e à propriedade mongocxx::uri correspondente, se suportado.

Opções de conjunto de réplicas

Opção de URI de conexão	`mongocxx::uri` membro
directConnection	direct_connection()
replicaSet	replica_set()

Opções de conexão

Opções de TLS

Opção de URI de conexão	`mongocxx::uri` membro
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()
tlsDisableCertificateRe aggregateCheck	tls_disable_certificate_re preference_check()
tlsDisableOCSPEndpointCheck	tls_disable_ocsp_endpoint_check()

Dica

Você pode definir a maioria das opções de TLS usando o parâmetro client_options . Consulte o mongocxx::options::tls Documentação da API para obter mais informações.

Opções de tempo limite

Opção de URI de conexão	`mongocxx::uri` membro
connectTimeoutMS	connect_timeout_ms()
socketTimeoutMS	socket_timoeout_ms()

Opções de compressão

Opção de URI de conexão	`mongocxx::uri` membro
compressors	compressors()
zlibCompressionLevel	zlib_compression_level()

Opções do pool de conexões

Opção de URI de conexão	`mongocxx::uri` membro
maxPoolSize	max_pool_size()
waitQueueTimeoutMS	wait_queue_timeout_ms()

Opções de write concern

Opção de URI de conexão	`mongocxx::uri` membro
w	write_concern()
wTimeoutMS	N/A
journal	N/A

Opções de read concern

Opção de URI de conexão	`mongocxx::uri` membro
readConcernLevel	read_concern()

Opções de read preference

Opção de URI de conexão	`mongocxx::uri` membro
readPreference	read_preference()
maxStalenessSeconds	N/A
readPreferenceTags	N/A

Opções de autenticação

Opção de URI de conexão	`mongocxx::uri` membro
authMechanism	auth_mecanismo()
authMechanismProperties	auth_mecanismo_properties()
authSource	auth_source()

Seleção de servidor e opções de descoberta

Opção de URI de conexão	`mongocxx::uri` membro
localThresholdMS	local_threshold_ms()
serverSelectionTimeoutMS	server_selection_timeout_ms()
serverSelectionTryOnce	server_selection_try_once()
heartbeatFrequencyMS	heartbeat_frequency_ms()
socketCheckIntervalMS	N/A

Configurações diversas

Opção de URI de conexão	`mongocxx::uri` membro
appName	appname()
retryReads	retry_reads()
retryWrites	retry_writes()
loadBalanced	N/A
srvMaxHosts	srv_max_hosts()

Voltar

Escolha um destino de conexão

Configurar TLS