Especifica opciones de conexión

Overview

Esta página describe las opciones de conexión y autenticación de MongoDB disponibles en el controlador C++.

Configurar opciones de conexión

Puede configurar su conexión especificando opciones en la URI de conexión o pasando una instancia del mongocxx::options::client clase como el parámetro client_options del constructor mongocxx::client.

Nota

Se pueden especificar algunas opciones de conexión solo en la URI de conexión y otras solo en el parámetro client_options. Es posible que sea necesario combinar estos métodos para especificar todas las opciones necesarias.

Uso del URI de conexión

Cuando construyes un objeto mongocxx::client, puedes pasar un objeto mongocxx::uri que representa tu URI de conexión. Este URI de conexión puede incluir opciones de conexión como pares de <name>=<value>. En el siguiente ejemplo, el URI de conexión contiene la opción tls con un valor de true y la opción tlsCertificateKeyFile con un 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 un `mongocxx::options::client` objeto

El constructor mongocxx::client incluye un parámetro client_options que acepta una instancia de la clase mongocxx::options::client. Puedes especificar ciertas opciones en el parámetro client_options en lugar de incluirlas en tu URI de conexión.

El siguiente ejemplo muestra cómo utilizar el parámetro client_options para configurar las opciones de conexión:

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

Leer Opciones de Conexión

Una vez construido un objeto mongocxx::client, se pueden leer los valores de ciertas opciones de conexión usando las propiedades del objeto mongocxx::uri.

El siguiente ejemplo muestra cómo leer el valor de las opciones de conexión tls usando la propiedad 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();
}

Las siguientes secciones muestran la propiedad correspondiente de mongocxx::uri para cada opción de conexión que la admite.

Opciones del URI de conexión

Las siguientes secciones describen las opciones de conexión que se pueden configurar en la URI de conexión enviada al controlador de C++. Cada opción de conexión enlaza con el manual del servidor MongoDB y con su propiedad mongocxx::uri correspondiente, si es compatible.

Opciones de set de réplicas

Opción de URI de conexión	`mongocxx::uri` nodo
directConnection	direct_connection()
replicaSet	replica_set()

Opciones de conexión

Opciones de TLS

Opción de URI de conexión	`mongocxx::uri` nodo
tls	tls()
tlsCertificateKeyFile	tls_certificate_key_file()
tlsCertificateKeyFilePassword	contraseña del archivo de clave de certificado tls()
tlsCAFile	tls_ca_file()
tlsPermitirCertificadosInválidos	tls_allow_invalid_certificates()
tlsAllowInvalidHostnames	tls_allow_invalid_hostnames()
tlsInsecure	tls_inseguro()
tlsDisableCertificateRevocationCheck	tls_disable_certificate_revocation_check()
tlsDisableOCSPEndpointCheck	tls_disable_ocsp_endpoint_check()

Tip

Puede configurar la mayoría de las opciones TLS mediante el client_options parámetro. Consulte la documentación de la API mongocxx::options::tls para obtener más información.

Opciones de tiempo de espera

Opción de URI de conexión	`mongocxx::uri` nodo
connectTimeoutMS	connect_timeout_ms()
socketTimeoutMS	socket_timoeout_ms()

Opciones de compresión

Opción de URI de conexión	`mongocxx::uri` nodo
compresores	compresores()
zlibCompressionLevel	zlib_nivel_de_compresión()

Opciones del pool de conexiones

Opción de URI de conexión	`mongocxx::uri` nodo
maxPoolSize	max_pool_size()
waitQueueTimeoutMS	wait_queue_timeout_ms()

Opciones de nivel de confirmación de escritura

Opción de URI de conexión	`mongocxx::uri` nodo
w	escribir_preocupación()
wTimeoutMS	N/A
journal	N/A

Opciones de readConcern

Opción de URI de conexión	`mongocxx::uri` nodo
readConcernLevel	leer_preocupación()

Opciones de preferencia de lectura

Opción de URI de conexión	`mongocxx::uri` nodo
readPreference	read_preference()
maxStalenessSeconds	N/A
readPreferenceTags	N/A

Opciones de autenticación

Opción de URI de conexión	`mongocxx::uri` nodo
mecanismo de autenticación	auth_mechanism()
authMechanismProperties	auth_mechanism_properties()
authSource	auth_source()

Opciones de selección y descubrimiento de servidores

Opción de URI de conexión	`mongocxx::uri` nodo
localThresholdMS	local_threshold_ms()
serverSelectionTimeoutMS	server_selection_timeout_ms()
Selección de servidorIntentar una vez	selección de servidor_intentar_una vez()
heartbeatFrequencyMS	heartbeat_frequency_ms()
socketCheckIntervalMS	N/A

Varias configuraciones

Opción de URI de conexión	`mongocxx::uri` nodo
appName	nombre de la aplicación()
retryReads	retry_reads()
retryWrites	retry_writes()
loadBalanced	N/A
srvMaxHosts	srv_max_hosts()

Volver

Elija un destino de conexión

Comprimir el tráfico de la red