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

Establecer opciones de conexión

Puede configurar su conexión especificando opciones en la URI de conexión o pasando una instancia de la 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 de la URI de conexión

Al construir un objeto mongocxx::client, puede pasar un objeto mongocxx::uri que represente su URI de conexión. Este URI de conexión puede incluir opciones de conexión como pares <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. Puede especificar ciertas opciones en el parámetro client_options en lugar de incluirlas en la URI de conexión.

El siguiente ejemplo muestra cómo utilizar el parámetro client_options para establecer 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 las opciones de conexión

Después de construir un objeto mongocxx::client, puede leer los valores de ciertas opciones de conexión utilizando las propiedades del objeto mongocxx::uri.

El siguiente ejemplo muestra cómo leer el valor de las opciones de conexión tls utilizando 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 mongocxx::uri correspondiente para cada opción de conexión que la admite.

Opciones de 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 del conjunto de réplicas

Opción de URI de conexión	`mongocxx::uri` Miembros
directConnection	conexión directa()
replicaSet	conjunto_de_réplicas()

Opciones de conexión

Opciones de TLS

Opción de URI de conexión	`mongocxx::uri` Miembros
tls	tls()
tlsCertificateKeyFile	archivo de clave de certificado tls()
tlsCertificateKeyFilePassword	contraseña del archivo de clave de certificado tls()
tlsCAFile	archivo tls_ca()
tlsPermitirCertificadosInválidos	tls_allow_invalid_certificates()
tlsPermitir nombres de host no válidos	tls_allow_invalid_hostnames()
tlsInsecure	tls_inseguro()
Comprobación de revocación de certificado de deshabilitación de tls	tls_deshabilitar_verificación_de_revocación_de_certificado()
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` Miembros
connectTimeoutMS	tiempo de espera de conexión_ms()
socketTimeoutMS	tiempo de salida del socket_ms()

Opciones de compresión

Opción de URI de conexión	`mongocxx::uri` Miembros
compresores	compresores()
zlibCompressionLevel	nivel de compresión zlib()

Opciones del pool de conexiones

Opción de URI de conexión	`mongocxx::uri` Miembros
maxPoolSize	tamaño máximo de la piscina()
waitQueueTimeoutMS	tiempo de espera de la cola de espera_ms()

Opciones de nivel de confirmación de escritura

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

Opciones de lectura de inquietudes

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

Opciones de preferencia de lectura

Opción de URI de conexión	`mongocxx::uri` Miembros
readPreference	preferencia de lectura()
maxStalenessSeconds	N/A
readPreferenceTags	N/A

Opciones de autenticación

Opción de URI de conexión	`mongocxx::uri` Miembros
mecanismo de autenticación	mecanismo de autenticación()
Propiedades del mecanismo de autenticación	propiedades_del_mecanismo_de_autenticación()
authSource	auth_source()

Opciones de selección y descubrimiento de servidores

Opción de URI de conexión	`mongocxx::uri` Miembros
localThresholdMS	umbral_local_ms()
Tiempo de espera de selección del servidor MS	tiempo de espera de selección de servidor_ms()
Selección de servidorIntentar una vez	selección de servidor_intentar_una vez()
heartbeatFrequencyMS	frecuencia_del_latido_del_corazón_ms()
Intervalo de comprobación de socketMS	N/A

Varias configuraciones

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

Volver

Elija un destino de conexión

Comprimir el tráfico de la red