Clase: Mongo::Client

Hereda:

Objeto

Objeto
Mongo::cliente

Mostrar todo

Ampliado por:: Reenviable

Incluye:: Registrable

Definido en:: lib/mongo/cliente.rb

Overview

El cliente es el punto de entrada al driver y es el objeto principal con el que se interactuará.

Desde:

2.0.0

Colapso delresumen constante

CRUD_OPCIONES = Las opciones que no afectan el comportamiento de un clúster y sus subcomponentes. Desde: 2.1.0

[
  opciones de cifrado automático,
  :database,
  :leer, :read_concern,
  guardar, :escribir_preocupación,
  :retry_reads, :max_read_retries, :intervalo de reintento de lectura,
  retry_writes, :max_write_retries,

  # Opciones que actualmente no pueden estar aquí:
  #
  # :tiempo de espera de selección de servidor
  # El tiempo de espera de la selección del servidor es utilizado por el constructor de clústeres para determinar
  # cuánto tiempo esperar para la exploración inicial en modo de compatibilidad, pero una vez
  # el clúster es inicializado, ya no utiliza este tiempo de espera.
  # Desafortunadamente, el selector de servidores lee el tiempo de espera de selección de servidor fuera de
  # el clúster, y este comportamiento es necesario para Cluster#next_primary
  # que no acepta argumentos. Al eliminar next_primary, podemos volver a visitar
  # uso del mismo objeto de clúster con diferentes tiempos de espera para la selección de servidores.
].freeze

VALID_OPTIONS = Opciones válidas del cliente. Desde: 2.1.2

[
  :app_name,
  :mecánica de autenticación,
  :propiedades_mecánicas_de_autenticación,
  origen_de_autenticación,
  opciones de cifrado automático,
  :bg_error_backtrace,
  :limpieza,
  :compresores,
  conexión_directa,
  :conectar,
  :tiempo de espera de conexión,
  :database,
  :frecuencia_del_latido,
  generador_de_id,
  :balanceo de carga,
  :umbral_local,
  :logger,
  log_prefix,
  :max_conectando,
  :max_idle_time,
  :max_pool_size,
  :max_read_retries,
  :max_write_retries,
  min_pool_size,
  :escucha,
  :monitoring_io,
  :contraseña,
  :plataforma,
  :populator_io,
  :leer,
  :read_concern,
  :intervalo de reintento de lectura,
  :conjunto de réplicas,
  :resolv_opciones,
  :retry_reads,
  retry_writes,
  :escanear,
  :sdam_proc,
  API del servidor,
  :server_selection_timeout,
  :tiempo de espera del socket,
  máximo_srv_hosts,
  :srv_nombre_del_servicio,
  :ssl,
  :certificado ssl_ca_cert,
  :objeto de certificado SSL CA,
  :ssl_ca_cert_string,
  :certificado_ssl,
  :objeto de certificado SSL,
  :ssl_cert_string,
  :ssl_key,
  :ssl_key_object,
  :frase_de_contraseña_de_clave_ssl,
  Cadena de clave SSL,
  Verificación SSL,
  ssl_verificar_certificado,
  :ssl_verify_hostname,
  ssl_verify_ocsp_endpoint,
  :timeout_ms,
  truncate_logs,
  Usuario/a,
  Tiempo de espera de la cola,
  wrapping_libraries,
  guardar,
  :escribir_preocupación,
  zlib_compression_level,
].freeze

COMPRESORES VÁLIDOS = Los algoritmos de compresión compatibles con el driver. Desde: 2.5.0

[
  Mongo::protocolo::Comprimido::zstd,
  Mongo::protocolo::Comprimido::rápido,
  Mongo::protocolo::Comprimido::zlib
].freeze

VERSIONES_API_SERVIDOR_VÁLIDAS = Las versiones conocidas de API del servidor. Desde: 2.0.0

%w(
  1
).freeze

Constantes incluidas desde Loggable

Registrable::PREFIX

Resumen de atributos de la instancia colapsar

#cluster ⇒ Mongo::Cluster Solo lectura

Clúster El clúster de servidores para el cliente.
#database ⇒ Mongo::Database Solo lectura

Base de datos La base de datos en la que está operando el cliente.
#encrypter ⇒ Mongo::Crypt::AutoEncrypter Solo lectura

El objeto que encapsula el comportamiento de autoencriptación.
#options ⇒ Hash Solo lectura

Opciones Las opciones de configuración.

Resumen del método de clase colapsar

.canonicalize_ruby_options(options) ⇒ objeto privado

Convierta las propiedades del mecanismo de autenticación a minúsculas, si se proporcionan, en las opciones especificadas, luego convierta las opciones en una instancia de Options::Redacted.

Resumen del método de instancia colapsar

#==(otro) ⇒ true, false (también: #eql?)

Determine si este cliente es equivalente a otro objeto.
#[](collection_name, options = {}) ⇒ Mongo::Collection

Obtén un objeto de colección para el nombre de colección proporcionado.
#close ⇒ true

Cerrar todas las conexiones.
#close_encrypter ⇒ verdadero

Cierre el cifrador y limpie los recursos de cifrado automático.
#¿cerrado? ⇒ Booleano
#cluster_options ⇒ Objeto privado
#nombres_de_base_de_datos(filtro = {}, opciones = {}) ⇒ Matriz<String>

Obtén los nombres de todas las bases de datos.
#mapa_de_campos_encriptados ⇒ Hash | nulo privado

Devuelve un hash de mapa de campo cifrado si se proporciona al crear el cliente.
#get_session(options = {}) ⇒ Session | nil privado

Devuelve una sesión para usar en operaciones si es posible.
#hash ⇒ Integer

Obtén el valor hash del cliente.
#initialize(addresses_or_uri, options = nil) ⇒ Cliente constructor

Instancia un nuevo cliente de driver.
#inspeccionar ⇒ Cadena

Obtén una inspección del cliente como string.
#list_databases(filtro = {}, name_only = false, opts = {}) ⇒ Array<Hash>

Obtener información de cada base de datos.
#list_mongo_databases(filtro = {}, opts = {}) ⇒ Arreglo<Mongo::Database>

Devuelve una lista de objetos Mongo::Database.
#max_read_retries ⇒ Entero privado

Obten el número máximo de veces que el cliente puede reintentar una operación de lectura al utilizar reintentos de lectura heredados.
#max_write_retries ⇒ Integer privado

Obtén el número máximo de veces que el cliente puede volver a intentar una operación de escritura cuando se utilizan reintentos de escritura heredados.
#read_concern ⇒ Hash

Obtenga la información de lectura preocupante para este cliente.
#read_preference ⇒ BSON::Document

Obtenga la preferencia de lectura de las opciones pasadas al cliente.
#read_retry_interval ⇒ Flotante privado

Obtenga el intervalo, en segundos, en el que se reintenta la lectura al utilizar reintentos de lectura heredados.
#reconnect ⇒ verdadero

Reconectar el cliente.
#server_selector ⇒ Mongo::ServerSelector

Obtenga el selector de servidor.
#start_session(opciones = {}) ⇒ Sesión

Inicia una sesión.
#resumen ⇒ Cadena

Obtenga un resumen del estado del cliente.
#timeout_ms ⇒ Integer | nil privado

Valor de la opción timeout_ms si está configurada.
#timeout_sec ⇒ Float | nil privado

Valor de la opción timeout_ms convertida en segundos.
#update_options(new_options) ⇒ Hash privado

Actualiza las opciones de este cliente utilizando new_options, validando todas las opciones.
#use(name) ⇒ Mongo::cliente

Crea un nuevo cliente configurado para utilizar la base de datos con el nombre proporcionado y utilizando las otras opciones configuradas en este cliente.
#ver(pipeline = [], options = {}) ⇒ ChangeStream

A partir de la versión 3.6 del servidor MongoDB, se admite una etapa de pipeline "$changeStream" en el framework de agregación.
#with(new_options = nil) ⇒ Mongo::cliente

Crea un nuevo cliente con las opciones pasadas fusionadas con las opciones existentes de este cliente.
#with_session(options = {}, &block) ⇒ Objeto privado

Crea una sesión para usar en operaciones si es posible y la entrega al bloque proporcionado.
#write_concern ⇒ Mongo::WriteConcern

Obtén el nivel de confirmación de escritura (write concern) para este cliente.

Métodos incluidos desde Registrable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Detalles del constructor

#inicializar(direcciones_o_uri, opciones = nil) ⇒ `Cliente`

Instancia un nuevo cliente de driver.

Ejemplos:

Instanciar un único servidor o cliente mongos.

Mongo::Client.new(['127.0.0.1:27017'])

Instanciar un cliente para un set de réplicas.

Mongo::Client.new(['127.0.0.1:27017', '127.0.0.1:27021'])

Conéctese directamente a un mongod en un set de réplicas

Mongo::Client.new(['127.0.0.1:27017'], :connect => :direct)
# without `:connect => :direct`, Mongo::Client will discover and
# connect to the replica set if given the address of a server in
# a replica set

Parámetros:

direcciones_o_uri (arreglo<String> | String) —

El arreglo de direcciones de servidores en la forma de host:puerto o una cadena de conexión URI de MongoDB.
opciones (Hash) (predeterminado: nulo) —

Las opciones que usará el cliente. Si también se proporciona una cadena de conexión URI de MongoDB, estas opciones tienen prioridad sobre cualquier opción análoga presente en la cadena URI.

Opciones Hash (options):

:app_name (String, Símbolo) —

Nombre de la aplicación que se imprime en los registros de mongod al establecer una conexión en versiones de servidor >= 3.4.
:mecánica de autenticación (Símbolo) —

El mecanismo de autenticación que se debe utilizar. Uno de :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256
:propiedades_mecánicas_de_autenticación (Hash)
origen_de_autenticación (Cadena) —

La fuente desde la cual autenticar.
:bg_error_backtrace (true | false | nil | Integer) —

Experimental. Configúrelo como verdadero para registrar seguimientos completos de errores en subprocesos en segundo plano. Configúrelo como falso o nulo para no registrarlos. Proporcione un entero positivo para registrar hasta ese número de líneas de seguimiento.
:compresores (Matriz<String>) —

Una lista de compresores potenciales para usar, en orden de preferencia. El controlador elige el primer compresor que también es compatible con el servidor. Actualmente, el controlador solo admite ‘zstd’, ‘snappy’ y ‘zlib’.
conexión_directa (true | false) —

Si se debe conectar directamente a la semilla especificada, omitiendo el descubrimiento de topología. Se debe proporcionar exactamente una semilla.
:conectar (Símbolo) —

Obsoleto: utiliza la opción :direct_connection en lugar de esta opción. El método de conexión a utilizar. Esto obliga al clúster a comportarse de la manera especificada en lugar de descubrirlo automáticamente. Una de :direct, :replica_set, :particionado, :load_balanced. Si :connect está configurado como :load_balanced, el controlador se comportará como si el servidor fuera un balanceador de carga, incluso si no está conectado a un balanceador de carga.
:tiempo de espera de conexión (Flotante) —

El tiempo de espera, en segundos, para intentar una conexión.
:database (Cadena) —

La base de datos a la que conectarse.
:frecuencia_del_latido (Flotante) —

El intervalo, en segundos, para que el monitor del servidor refresque su descripción a través de hello.
generador_de_id (Objeto) —

Un objeto personalizado para generar identificaciones para documentos. Debe responder a #generate.
:balanceo de carga (true | false) —

Si se espera conectar a un balanceador de carga.
:umbral_local (Entero) —

Límite de umbral local en segundos para seleccionar un servidor cercano para una operación.
:logger (Logger) —

Un registrador personalizado para usar.
log_prefix (Cadena) —

Un prefijo de registro personalizado para usar al registrar. Esta opción es experimental y está sujeta a cambios en futuras versiones del controlador.
:max_conectando (Entero) —

El número máximo de conexiones que pueden estar estableciéndose simultáneamente. El por defecto es 2. Esta opción debe aumentarse si hay muchos hilos que comparten el mismo cliente y la aplicación experimenta expiraciones al esperar que se establezcan conexiones. seleccionar un servidor para una operación. El valor por defecto es 2.
:max_idle_time (Entero) —

Los segundos máximos que un socket puede permanecer inactivo desde que se ingresó en el clúster.
:max_pool_size (Entero) —

El tamaño máximo del pool de conexiones. Establecer esta opción en cero crea un grupo de conexiones ilimitado.
:max_read_retries (Entero) —

El número máximo de reintentos de lectura cuando se utilizan los reintentos de lectura heredados.
:max_write_retries (Entero) —

El número máximo de reintentos de escritura cuando se utilizan reintentos de escritura heredados.
min_pool_size (Entero) —

El tamaño mínimo del pool de conexiones.
:escucha (verdadero, falso) —

Si se proporciona false, el cliente se inicializa sin suscriptores de eventos SDAM globales y no publicará eventos SDAM. La supervisión de comandos y los eventos heredados aún se publicarán, y el driver seguirá realizando el SDAM y supervisando su clúster para llevar a cabo la selección del servidor. El registro de eventos SDAM integrado en el controlador se desactivará porque se implementa a través de la suscripción a eventos SDAM. Client#subscribe tendrá éxito para todos los tipos de eventos, pero los suscriptores de eventos SDAM no serán invocados. Los valores diferentes de false resultan en un comportamiento por defecto, que consiste en realizar la publicación normal de eventos SDAM.
:monitoring_io (verdadero, falso) —

Para uso interno del driver solamente. Establezca en falso para impedir que este cliente o los servidores bajo su control realicen I/O relacionados con SDAM. Nota: si establece esta opción en falso, el cliente dejará de funcionar. Está destinado a usarse en pruebas en las que se invocan manualmente las transiciones de estado SDAM.
:limpieza (true | false) —

Solo para uso interno del controlador. Establézcalo en falso para evitar que se envíe el comando endSessions al servidor para limpiar las sesiones del servidor cuando el clúster se desconecta y para no iniciar el ejecutor periódico. Si :monitoring_io es falso, :cleanup también se establece automáticamente en falso por defecto.
:contraseña (Cadena) —

La contraseña del usuario.
:plataforma (Cadena) —

Información de la plataforma para incluir en los metadatos impresos en los registros de mongod al establecer una conexión en versiones de servidor >= 3.4.
:leer (Hash) —
Las opciones de preferencia de lectura. El hash puede tener los siguientes elementos:
- :mode – preferencia de lectura especificada como un símbolo; los valores válidos son:primary,:primary_preferred,:secondary,:secondary_preferred y:nearest.
- :tag_sets – una matriz de hashes.
- :local_threshold.
:read_concern (Hash) —

La opción de nivel de consistencia de lectura.
:intervalo de reintento de lectura (Flotante) —

El intervalo, en segundos, en el que se reintentan las lecturas en un mongos.
:conjunto de réplicas (Símbolo) —

El nombre del set de réplicas al que se desea conectar. Se ignorarán los servidores que no estén en este set de réplicas.
:retry_reads (true | false) —

Si es verdadero, se habilitan las lecturas reintentables modernas (predeterminado). Si es falso, se deshabilitan las lecturas reintentables modernas y se habilitan las lecturas reintentables antiguas.
retry_writes (true | false) —

Se reintenta la escritura una vez al conectarse a un conjunto de réplicas o a un clúster fragmentado con versiones 3.6 o superiores. (El valor predeterminado es "true").
:escanear (true | false) —

Si se desea escanear todas las semillas en el constructor. El valor por defecto en la versión 2.x del driver es hacerlo; la versión 3.x del driver no escaneará semillas en el constructor. Opta por el nuevo comportamiento configurando esta opción en 'falso'. Nota: establecer esta opción en nil permite escanear semillas en el constructor en la versión 2.x del driver. La versión 3.x del driver reconocerá esta opción, pero la ignorará y nunca escaneará semillas en el constructor.
:sdam_proc (Proc) —

Un Proc para invocar con el cliente como argumento antes de realizar el descubrimiento y supervisión del servidor. Utilícelo para configurar los listeners de eventos SDAM y recibir eventos publicados durante la construcción del cliente.

Nota: el cliente no está completamente construido cuando se invoca sdam_proc, en particular el clúster es nulo en este momento. sdam_proc debe limitarse únicamente a invocar los métodos #suscribirse y #desuscribirse en el cliente.
API del servidor (Hash) —
La versión de la API del servidor solicitada. Este hash puede contener los siguientes elementos:
- :version – string
- :estricto – booleano
- :deprecation_errors – booleano
:server_selection_timeout (Entero) —

El tiempo de espera en segundos para seleccionar un servidor para una operación.
:tiempo de espera del socket (Flotante) —

El tiempo de espera, en segundos, para ejecutar operaciones en un socket. Esta opción está obsoleta, utiliza :timeout_ms en su lugar.
máximo_srv_hosts (Entero) —

El número máximo de mongoses con los que el driver se comunicará para topologías particionadas. Si esta opción es 0, entonces no habrá un número máximo de mongoses. Si el URI proporcionado se resuelve en más hosts que “:srv_max_hosts“, el cliente elegirá aleatoriamente un subconjunto de hosts del tamaño “:srv_max_hosts“.
:srv_nombre_del_servicio (Cadena) —

El nombre del servicio que se utilizará en la consulta DNS SRV.
:ssl (verdadero, falso) —

Si se debe utilizar TLS.
:certificado ssl_ca_cert (Cadena) —

El archivo que contiene los certificados de autoridad de certificación concatenados utilizados para validar los certificados recibidos del otro extremo de la conexión. Los certificados intermedios NO deben especificarse en los archivos referenciados por esta opción. Se requiere uno de :ssl_ca_cert, :ssl_ca_cert_string o :ssl_ca_cert_object (en orden prioritario) al utilizar :ssl_verify.
:objeto de certificado SSL CA (Array<OpenSSL::X509::Certificate>) —

Una matriz de objetos OpenSSL::X509::Certificate que representan los certificados de la autoridad de certificación utilizados para validar los certificados transmitidos desde el otro extremo de la conexión. Los certificados intermedios NO deben especificarse en los archivos referenciados por esta opción. Se requiere :ssl_ca_cert, :ssl_ca_cert_string o :ssl_ca_cert_object (en orden de prioridad) al usar :ssl_verify.
:ssl_ca_cert_string (Cadena) —

Una string que contiene un certificado de autoridad de certificación utilizada para validar información que se pasa desde el otro extremo de la conexión. Esta opción permite pasar solo un certificado CA al controlador. Los certificados intermedios NO deben especificarse en los archivos a los que hace referencia esta opción. Se requiere uno de :ssl_ca_cert, :ssl_ca_cert_string o :ssl_ca_cert_object (en orden de prioridad) cuando se utiliza :ssl_verify.
:certificado_ssl (Cadena) —

El archivo de certificado que se utiliza para identificar la conexión con MongoDB. Se puede pasar una cadena de certificados especificando primero el certificado cliente, seguido de cualquier certificado intermedio hasta el certificado CA. El archivo también puede contener la llave privada del certificado, la cual será ignorada. Esta opción, si está presente, prevalece sobre los valores de :ssl_cert_string y :ssl_cert_object.
:objeto de certificado SSL (OpenSSL::X509::Certificate) —

El certificado OpenSSL::X509::Certificate utilizado para identificar la conexión con MongoDB. Solo se puede pasar un certificado mediante esta opción.
:ssl_cert_string (Cadena) —

Una cadena que contiene el certificado codificado en PEM utilizado para identificar la conexión con MongoDB. Se puede pasar una cadena de certificados especificando primero el certificado del cliente, seguido de cualquier certificado intermedio hasta el certificado de la CA. La cadena también puede contener la clave privada del certificado, que se ignorará. Esta opción, si está presente, prevalece sobre el valor de :ssl_cert_object.
:ssl_key (Cadena) —

El archivo de clave privada que se utiliza para identificar la conexión con MongoDB. Ten en cuenta que, aunque la clave se almacene en el mismo archivo que el certificado, es necesario especificar ambos explícitamente. Esta opción, si está presente, tiene prioridad sobre los valores de :ssl_key_string y :ssl_key_object
:ssl_key_object (OpenSSL::PKey) —

La clave privada utilizada para identificar la conexión con MongoDB
:frase_de_contraseña_de_clave_ssl (Cadena) —

Una frase secreta para la llave privada.
Cadena de clave SSL (Cadena) —

Una string que contiene la llave privada codificada PEM que se utiliza para identificar la conexión con MongoDB. Este parámetro, si está presente, tiene prioridad sobre el valor de la opción :ssl_key_object
Verificación SSL (verdadero, falso) —

Si se debe realizar la validación del certificado de par y la verificación del nombre de host. Tenga en cuenta que la decisión de validar los certificados se anulará si :ssl_verify_certificate está configurado, y la decisión de validar los nombres de host se anulará si :ssl_verify_hostname está configurado.
ssl_verificar_certificado (verdadero, falso) —

Si se debe realizar la validación del certificado de pares. Esta configuración anula :ssl_verify respecto a si se realiza la validación del certificado.
:ssl_verify_hostname (verdadero, falso) —

Si se debe realizar la validación del nombre de host del par. Esta configuración anula :ssl_verify respecto a si se realiza la validación del nombre de host.
:timeout_ms (Entero) —

El tiempo de espera de la operación en milisegundos. Debe ser un número entero no negativo. Un valor explícito de 0 significa infinito. El valor predeterminado no está establecido, lo que significa que la funcionalidad no está activada.
truncate_logs (verdadero, falso) —

Si desea truncar los registros en los 250 caracteres predeterminados.
Usuario/a (Cadena) —

El nombre de usuario.
Tiempo de espera de la cola (Flotante) —

El tiempo de espera, en segundos, en el grupo de conexiones para que se registre una conexión. Esta opción está obsoleta, utilice :timeout_ms en su lugar.
wrapping_libraries (arreglo<Hash>) —
Información sobre bibliotecas como ODM que encapsulan el controlador, que se agregará a
```
metadata sent to the server. Specify the lower level libraries first.
Allowed hash keys: :name, :version, :platform.
```
guardar (Hash) —

Obsoleto. Equivalente a la opción :write_concern.
:escribir_preocupación (Hash) —

Las opciones de escritura pueden ser: :w => Entero|Cadena, :wtimeout => Entero (en milisegundos, obsoleto), :j => Booleano, :fsync => Booleano.
zlib_compression_level (Entero) —

El nivel de compresión Zlib a utilizar, si se utiliza compresión. Consulta el módulo Zlib de Ruby para conocer los niveles válidos.
:resolv_opciones (Hash) —

Para uso interno de conductores solamente. Opciones para pasar al constructor de Resolv::DNS para búsquedas SRV.
opciones de cifrado automático (Hash) —
Opciones relacionadas con el cifrado automático.
- :key_vault_client => Cliente | nil, un cliente conectado a la instancia de MongoDB que contiene el almacén de llaves de cifrado
- `:key_vault_namespace` => String, el namespace del almacén de claves en el formato base de datos.colección
- :kms_providers => Hash: un hash de la información de configuración del servicio de administración de claves (KMS). Las claves hash válidas son:aws, :azure, :gcp, :kmip y :local. Puede haber más de un proveedor de KMS especificado.
- :kms_tls_options => Hash: un hash de opciones TLS para autenticarse con proveedores KMS, generalmente usado para servidores KMIP. Las claves hash válidas son:aws, :azure, :gcp, :kmip, :local. Puede haber más de un proveedor KMS especificado.
- :schema_map => Hash | nil, JSONSchema para una o más colecciones especificando qué campos deben cifrados. Esta opción es mutuamente exclusiva con :schema_map_path.
  - Nota: Los esquemas proporcionados en el schema_map solo se aplican a la configuración de cifrado automático para el cifrado del lado del cliente. El driver no aplicará otras reglas de validación en el JSON schema, lo que resultará en un error.
  - Nota: proporcionar un schema_map ofrece más seguridad que confiar en los Esquemas JSON obtenidos del servidor. Protege contra un servidor malicioso que anuncie un falso JSON Schema, lo que podría engañar al cliente para que envíe datos no cifrados que deberían cifrarse.
  - Nota: Si una colección está presente tanto en :encrypted_fields_map como en :schema_map, se producirá un error.
- :schema_map_path => String | nil Una ruta a un archivo contiene el esquema JSON
de la colección que almacena documentos con cifrado automático. Esta opción es mutuamente excluyente con :schema_map.
- :bypass_auto_encryption => Booleano, si es verdadero, deshabilita el cifrado automático; por defecto es falso.
- :extra_options => Hash | nulo, opciones relacionadas con la creación de mongocryptd (esta parte de la API está sujeta a cambios).
- :encrypted_fields_map => Hash | nil, asigna un namespace de colección a un hash que describe campos cifrados para la queryable encryption.
  - Nota: si una colección está presente tanto en encryptedFieldsMap como en schemaMap, se producirá un error.
- bypass_query_analysis => Booleano | nil, cuando está activo (true) inhabilita el análisis automático de comandos de salida.
- :crypt_shared_lib_path => [ String | nil ] Ruta que debe usarse para cargar la librería compartida crypt. Proporcionar esta opción anula las rutas de carga por defecto de la librería compartida para libmongocrypt.
- crypt_shared_lib_required => [ booleano | nulo ] Indica si la librería compartida crypt es necesaria. Si es "verdadero", se generará un error si libmongocrypt no puede cargar una librería crypt_shared.
Notas sobre el cifrado automático:
- El cifrado automático es una función exclusiva para empresas que se aplica únicamente a operaciones en una colección.
- El cifrado automático no es compatible con operaciones en una base de datos o vista.
- El cifrado automático requiere que el usuario autenticado tenga el privilegio listCollections.
- En el peor de los casos, el cifrado automático puede triplicar el número de conexiones utilizadas por el cliente en un momento dado.
- Si la encriptación automática falla en una operación, utiliza un MongoClient configurado con bypass_auto_encryption: true y utiliza ClientEncryption.encrypt para encriptar manualmente los valores.
- Habilitar el cifrado del lado del cliente reduce el tamaño máximo del lote de escritura y puede tener un impacto negativo en el rendimiento.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 502

def inicializar(direcciones_o_uri, opciones = nulo)
  opciones = opciones ? opciones.dup : {}

  procesado = process_addresses(direcciones_o_uri, opciones)

  uri = procesado[uri]
  direcciones = procesado[direcciones]
  opciones = procesado[:options]

  # Si el URI es un URI SRV, tómese nota de esto para que podamos comenzar
  # sondeo SRV si la topología es un clúster sharded.
  srv_uri = uri si uri.is_a?(URI::SRVProtocol)

  opciones = sí mismo.clase.canonicalizar_opciones_ruby(opciones)

  # La versión de la API del servidor se debe especificar como una string.
  # Sin embargo, es muy molesto tener que proporcionar siempre el número 1 como una string,
  # por lo tanto, se convierte al tipo de cadena aquí.
  si server_api = opciones[API del servidor]
    si server_api.is_a?(Picadillo)
      server_api = opciones::Redactado.Nuevo(server_api)
      si (Versión = server_api[:versión]).is_a?(entero)
        opciones[API del servidor] = server_api.fusionar(versión: Versión.to_s)
      end
    end
  end

  # Manejo especial para sdam_proc ya que solo se utiliza durante el cliente
  # construcción
  sdam_proc = opciones.borrar(:sdam_proc)

  # Para gssapi service_name, la opción predeterminada se proporciona en un hash
  # (un nivel por debajo del nivel superior).
  merged_options = default_options(opciones)
  opciones.cada hacer |k, v|
    default_v = merged_options[k]
    si Picadillo === default_v
      v = default_v.fusionar(v)
    end
    merged_options[k] = v
  end
  opciones = merged_options

  opciones.claves.cada hacer |k|
    si opciones[k].nil?
      opciones.borrar(k)
    end
  end

  @options = validate_new_options!(opciones)
=begin Soporte de objetos WriteConcern
  si @options[:write_concern].is_a?(WriteConcern::Base)
    # Almacene la instancia en caché para que no tengamos que reconstruirla innecesariamente.
    @write_concern = @options[:write_concern]
    @options[:write_concern] = @write_concern.options
  end
=end
  @options.freeze
  validate_options!(direcciones, is_srv: uri.is_a?(URI::SRVProtocol))
  validate_authentication_options!

  database_options = @options.dup
  database_options.borrar(API del servidor)
  @database = Database.Nuevo(sí mismo, @options[:database], database_options)

  # Establecer temporalmente la supervisión para que las suscripciones de eventos puedan ser
  #configurar sin que haya un clúster
  @monitoring = Monitoring.Nuevo(@options)

  si sdam_proc
    sdam_proc.llamar(sí mismo)
  end

  @connect_lock = Mutex (exclusión mutua).Nuevo
  @connect_lock.sincronizar hacer
    @cluster = clúster.Nuevo(direcciones, @monitoring,
      cluster_options.fusionar(srv_uri: srv_uri))
  end

  begin
    # Desactivar la supervisión, se desconectará del clúster a partir de ahora
    eliminar_variable_de_instancia('@monitoring')

    si @options[opciones de cifrado automático]
      @connect_lock.sincronizar hacer
        construir_encrypter
      end
    end

  rescate
    begin
      @cluster.Cerrar
    rescate => e
      advertencia de registro("Erroral cerrar el clúster en el controlador de excepciones del constructor del cliente: #{e.class}: #{e}")
      # Descarta esta excepción para que se genere la excepción original
    end
    propagar
  end

  si ¿block_given?
    begin
      rendimiento(sí mismo)
    asegurar
      Cerrar
    end
  end
end

Detalles de los atributos de instancia

#clúster ⇒ `Mongo::Cluster` (solo lectura)

Devuelve el clúster El clúster de servidores para el cliente.

Devuelve:

(Mongo::Cluster) —

cluster El clúster de servidores para el cliente.

Desde:

2.0.0



139
140
141

# Archivo 'lib/mongo/client.rb', línea 139

def clúster
  @cluster
end

#database ⇒ `Mongo::Database` (readonly)

Devuelve la base de datos La base de datos en la que opera el cliente.

Devuelve:

(Mongo::Database) —

base de datos La base de datos en la que opera el cliente.

Desde:

2.0.0



142
143
144

# Archivo 'lib/mongo/client.rb', línea 142

def database
  @database
end

#encrypter ⇒ `Mongo:: Crypt:: AutoEncrypter` (solo lectura)

Devuelve el objeto que encapsula el comportamiento de cifrado automático.

Devuelve:

(Mongo::Crypt::AutoEncrypter) —

El objeto que encapsula el comportamiento de autocifrado.

Desde:

2.0.0



149
150
151

# Archivo 'lib/mongo/client.rb', línea 149

def encriptador
  @encryptador
end

#opciones ⇒ `Hash` (solo lectura)

Devuelve opciones Las opciones de configuración.

Devuelve:

(encriptada) —

opciones Las opciones de configuración.

Desde:

2.0.0



145
146
147

# Archivo 'lib/mongo/client.rb', línea 145

def opciones
  @options
end

Detalles del método de clase

.canonicalize_ruby_options(opciones) ⇒ `Objeto`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Convierta las propiedades del mecanismo de autenticación a minúsculas, si se proporcionan, en las opciones especificadas, luego convierta las opciones en una instancia de Options::Redacted.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 1162

def canonicalizar_opciones_ruby(opciones)
  opciones::Redactado.Nuevo(Picadillo[opciones.map hacer |k, v|
    si k == :propiedades_mecánicas_de_autenticación || k == 'auth_mech_properties'
      si v
        v = Picadillo[v.map { |pk, pv| [pk.minúscula, pv] }]
      end
    end
    [k, v]
  end])
end

Detalles del método de instancia

#==(otro) ⇒ verdadero, `falso` También conocido como: eql?

Determine si este cliente es equivalente a otro objeto.

Ejemplos:

Comprueba la igualdad del cliente.

client == other

Parámetros:

Otros (objeto) —

El objeto con el que comparar.

Devuelve:

(verdadero,falso) —

Si los objetos son iguales.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 178

def ==(Otros)
  return false a menos que Otros.is_a?(Cliente)
  clúster == Otros.clúster && opciones == Otros.opciones
end

#[](collection_name, options = {}) ⇒ `Mongo::Collection`

Obtén un objeto de colección para el nombre de colección proporcionado.

Ejemplos:

Obtenga la colección.

client[:users]

Parámetros:

nombre_colección (Cadena,Símbolo) —

El nombre de la colección.
opciones (Hash) (por defecto: {}) —

Las opciones para la colección.

Devuelve:

(Mongo::Collection) —

La colección.

Desde:

2.0.0



195
196
197

# Archivo 'lib/mongo/client.rb', línea 195

def [](nombre_colección, opciones = {})
  database[nombre_colección, opciones]
end

#cerrar ⇒ `verdadero`

Cerrar todas las conexiones.

Devuelve:

(cierto) —

Siempre verdadero.

Desde:

2.1.0

# Archivo 'lib/mongo/client.rb', línea 865

def Cerrar
  @connect_lock.sincronizar hacer
    @closed = true
    cerrar
  end
  true
end

#close_encrypter ⇒ `true`

Cierre el cifrador y limpie los recursos de cifrado automático.

Devuelve:

(cierto) —

Siempre verdadero.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 876

def close_encrypter
  @encryptador.Cerrar si @encryptador

  true
end

#cerrado? ⇒ `Booleano`

Devuelve:

(booleano)

Desde:

2.0.0



856
857
858

# Archivo 'lib/mongo/client.rb', línea 856

def ¿Cerrado?
  !!@closed
end

#cluster_options ⇒ `Objeto`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 611

def cluster_options
  # Compartimos clústeres cuando un nuevo cliente tiene diferentes CRUD_OPCIONES
  # se solicita; por lo tanto, el clúster no debería obtener ninguno de ellos
  # opciones al momento de la creación
  opciones.rechazar hacer |llave, Valor|
    CRUD_OPTIONS.incluir?(llave.to_sym)
  end.fusionar(
    # pero necesitamos volver a poner la base de datos para la autenticación...
    database: opciones[:database],

    # Introduce estas opciones por compatibilidad con versiones anteriores, pero ten en cuenta que
    # sus valores en el cliente y el clúster no tienen que coincidir -
    # Las aplicaciones deben leer estos valores desde el cliente, no desde el clúster
    max_reintentos_lectura: opciones[:max_read_retries],
    read_retry_interval: opciones[:intervalo de reintento de lectura],
  ).tocar hacer |opciones|
    # Si el cliente ya tiene un clúster, reenvía srv_uri al nuevo
    # clúster para mantener la supervisión SRV. Si el cliente es completamente nuevo,
    # su constructor establece srv_uri manualmente.
    si clúster
      opciones.update(srv_uri: clúster.opciones[:srv_uri])
    end
  end
end

#database_names(filtro = {}, opciones = {}) ⇒ `arreglo<String>`

Obtén los nombres de todas las bases de datos.

Ejemplos:

Obtener los nombres de las bases de datos.

client.database_names

Parámetros:

filtro (Hash) (por defecto: {}) —

Los criterios de filtro para obtener una lista de bases de datos.
opta (Hash) (por defecto: {}) —

Las opciones de comando.
opciones (encriptada) —

un conjunto personalizable de opciones

Opciones Hash (opts):

:authorized_databases (verdadero, falso) —

Una bandera que determina qué bases de datos se devuelven en función de los privilegios del usuario cuando el control de acceso está habilitado

Consulte mongodb.com/es/docs/manual/reference/command/listDatabases/para obtener más información y uso.
:: sesión (Sesión) —

La sesión para usar.
:comment (Objeto) —

Un comentario proporcionado por el usuario para adjuntar a este comando.

Devuelve:

(arreglo<String>) —

Los nombres de las bases de datos.

Desde:

2.0.5



932
933
934

# Archivo 'lib/mongo/client.rb', línea 932

def nombres_de_base_de_datos(filtro = {}, opta = {})
  lista_bases_de_datos(filtro, true, opta).collect{ |información| información['nombre'] }
end

#encrypted_fields_map ⇒ `Hash | nil`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve un hash de mapa de campo cifrado si se proporciona al crear el cliente.

Devuelve:

(Hash | nil) —

Hash del mapa de campo cifrado, o nulo si no está configurado.

Desde:

2.0.0



1178
1179
1180

# Archivo 'lib/mongo/client.rb', línea 1178

def encrypted_fields_map
  @encrypted_fields_map ||= @options.obtener(opciones de cifrado automático, {})[mapa_de_campos_cifrados]
end

#get_session(options = {}) ⇒ `Session | nil`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve una sesión para usar en operaciones si es posible.

Si la opción :session está activada, se valida la sesión y se devuelve. De lo contrario, si la implementación admite sesiones, se crea una nueva sesión y se devuelve. Al crear una nueva sesión, esta será implícita (el controlador gestiona su ciclo de vida) si se especifica la opción :implicit; de lo contrario, será explícita (la aplicación gestiona su ciclo de vida). Si la implementación no admite sesiones, se devuelve nulo.

Parámetros:

opciones (Hash) (por defecto: {}) —

un conjunto personalizable de opciones

Opciones Hash (options):

:implicit (true | false) —

Cuando no se pasa una sesión, si se debe crear una sesión implícita.
:: sesión (Sesión) —

La sesión para validar y devolver.

Devuelve:

(Session | nil) —

Objeto de sesión o nil si la implementación no admite sesiones.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 1118

def get_session(opciones = {})
  get_session!(opciones)
rescate Error::SessionsNotSupported
  nulo
end

#hash ⇒ `Integer`

Obtén el valor hash del cliente.

Ejemplos:

Obtenga el valor hash del cliente.

client.hash

Devuelve:

(Número entero) —

El valor hash del cliente.

Desde:

2.0.0



207
208
209

# Archivo 'lib/mongo/client.rb', línea 207

def hash
  [clúster, opciones].hash
end

#inspect ⇒ `String`

Obtén una inspección del cliente como string.

Ejemplos:

Inspeccionar al cliente.

client.inspect

Devuelve:

(string) —

La string de inspección.

Desde:

2.0.0



674
675
676

# Archivo 'lib/mongo/client.rb', línea 674

def inspeccionar
  "#<Mongo::cliente:0x#{object_id} clúster=#{clúster.summary}>"
end

#list_databases(filtro = {}, solo_nombre = false, opciones = {}) ⇒ `arreglo<Hash>`

Obtener información de cada base de datos.

See https://mongodb.com/es/docs/manual/reference/command/listDatabases/
for more information and usage.

Ejemplos:

Obtén la información de cada base de datos.

client.list_databases

Parámetros:

filtro (Hash) (por defecto: {}) —

Los criterios de filtro para obtener una lista de bases de datos.
name_only (verdadero, falso) (por defecto: false) —

Determina si solo se devolverá cada nombre de base de datos sin los metadatos completos.
opta (Hash) (por defecto: {}) —

Las opciones de comando.
opciones (encriptada) —

un conjunto personalizable de opciones

Opciones Hash (opts):

:authorized_databases (verdadero, falso) —

Un indicador que determina qué bases de datos se devuelven según los privilegios del usuario cuando el control de acceso está activado.
:comment (Objeto) —

Un comentario proporcionado por el usuario para adjuntar a este comando.
:: sesión (Sesión) —

La sesión para usar.

Devuelve:

(arreglo<Hash>) —

La información de cada base de datos.

Desde:

2.0.5

# Archivo 'lib/mongo/client.rb', línea 963

def lista_bases_de_datos(filtro = {}, name_only = false, opta = {})
  cmd = { listDatabases: 1 }
  cmd[nombreSolo] = !!name_only
  cmd[:filtrar] = filtro a menos que filtro.¿vacío?
  cmd[bases de datos autorizadas] = true si opta[:authorized_databases]
  Usar(Database::ADMIN).database.comando_de_lectura(cmd, opta).primero[Database::base de datos]
end

#list_mongo_databases(filter = {}, opts = {}) ⇒ `Array<Mongo::Database>`

Devuelve una lista de objetos Mongo::Database.

Ejemplos:

Obtenga una lista de objetos Mongo::Database.

client.list_mongo_databases

Parámetros:

filtro (Hash) (por defecto: {}) —

Los criterios de filtro para obtener una lista de bases de datos.
opta (Hash) (por defecto: {}) —

Las opciones de comando.
opciones (encriptada) —

un conjunto personalizable de opciones

Opciones Hash (opts):

:: sesión (Sesión) —

La sesión para usar.

Devuelve:

(arreglo<Mongo::base de datos>) —

La lista de objetos de la base de datos.

Desde:

2.5.0

# Archivo 'lib/mongo/client.rb', línea 986

def lista_bases_de_datos_mongo(filtro = {}, opta = {})
  nombres_de_base_de_datos(filtro, opta).collect hacer |Nombre|
    Database.Nuevo(sí mismo, Nombre, opciones)
  end
end

#max_read_retries ⇒ `Entero`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Obten el número máximo de veces que el cliente puede reintentar una operación de lectura al utilizar reintentos de lectura heredados.

Devuelve:

(Número entero) —

La cantidad máxima de reintentos.

Desde:

2.0.0



642
643
644

# Archivo 'lib/mongo/client.rb', línea 642

def max_read_retries
  opciones[:max_read_retries] || clúster::MAX_READ_RETRIES
end

#max_write_retries ⇒ `Entero`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Obtén el número máximo de veces que el cliente puede volver a intentar una operación de escritura cuando se utilizan reintentos de escritura heredados.

Devuelve:

(Número entero) —

La cantidad máxima de reintentos.

Desde:

2.0.0



662
663
664

# Archivo 'lib/mongo/client.rb', línea 662

def max_write_retries
  opciones[:max_write_retries] || clúster::MÁXIMO DE REINTENTOS DE ESCRITURA
end

#read_concern ⇒ `Hash`

Obtenga la información de lectura preocupante para este cliente.

Ejemplos:

Obtenga el nivel de consistencia de lectura del cliente.

client.read_concern

Devuelve:

(encriptada) —

La preocupación de la lectura.

Desde:

2.6.0



839
840
841

# Archivo 'lib/mongo/client.rb', línea 839

def leer_preocupación
  opciones[:read_concern]
end

#read_preference ⇒ `BSON::Document`

Obtenga la preferencia de lectura de las opciones pasadas al cliente.

Ejemplos:

Obtén la preferencia de lectura.

client.read_preference

Devuelve:

(BSON::Document) —
La preferencia de lectura definida por el usuario. El documento puede tener los siguientes campos:
- :mode – preferencia de lectura especificada como un símbolo; los valores válidos son:primary,:primary_preferred,:secondary,:secondary_preferred y:nearest.
- :tag_sets – una matriz de hashes.
- :local_threshold.

Desde:

2.0.0



722
723
724

# Archivo 'lib/mongo/client.rb', línea 722

def read_preference
  @read_preference ||= opciones[:leer]
end

#read_retry_interval ⇒ `Float`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Obtenga el intervalo, en segundos, en el que se reintenta la lectura al utilizar reintentos de lectura heredados.

Devuelve:

(Float) —

El intervalo.

Desde:

2.0.0



652
653
654

# Archivo 'lib/mongo/client.rb', línea 652

def read_retry_interval
  opciones[:intervalo de reintento de lectura] || clúster::READ_RETRY_INTERVAL
end

#reconectar ⇒ `verdadero`

Reconectar el cliente.

Ejemplos:

Reconectar el cliente.

client.reconnect

Devuelve:

(cierto) —

Siempre verdadero.

Desde:

2.1.0

# Archivo 'lib/mongo/client.rb', línea 890

def Reconnecting
  direcciones = clúster.direcciones.map(Yto_s)

  @connect_lock.sincronizar hacer
    cerrar rescate nulo

    @cluster = clúster.Nuevo(direcciones, Monitoring, cluster_options)

    si @options[opciones de cifrado automático]
      construir_encrypter
    end

    @closed = false
  end

  true
end

#server_selector ⇒ `Mongo::ServerSelector`

Obtenga el selector de servidor. Utiliza la preferencia de lectura definida en las opciones del cliente o se establece por defecto en un selector de servidor primario.

Ejemplos:

Obtenga el selector de servidor.

client.server_selector

Devuelve:

(Mongo::ServerSelector) —

El selector de servidor que utiliza la preferencia de lectura definida por el usuario o un selector de servidor primario por defecto.

Desde:

2.5.0

# Archivo 'lib/mongo/client.rb', línea 700

def selector_de_servidor
  @server_selector ||= si read_preference
    ServerSelector.Obtener(read_preference)
  else
    ServerSelector.primario
  end
end

#start_session(options = {}) ⇒ `Sesión`

Nota:

Una sesión no puede ser utilizada por varios hilos al mismo tiempo; los objetos de sesión no son seguros para hilos.

Inicia una sesión.

Si la implementación no admite sesiones, genera Mongo::Error::InvalidSession. Esta excepción también puede generar si el controlador no está conectado a un servidor que contiene datos, por ejemplo, durante una conmutación por error.

Ejemplos:

Inicia una sesión.

client.start_session(causal_consistency: true)

Parámetros:

opciones (Hash) (por defecto: {}) —

Opciones de sesión. Acepta las opciones que acepta Session#initialize.

Devuelve:

(Sesión) —

La sesión.

Desde:

2.5.0

# Archivo 'lib/mongo/client.rb', línea 1011

def start_session(opciones = {})
  sesión = get_session!(opciones.fusionar(implicit: false))
  si ¿block_given?
    begin
      rendimiento sesión
    asegurar
      sesión.fin_sesión
    end
  else
    sesión
  end
end

#summary → `String`

Nota:

El formato y diseño exactos de la string de resumen devuelta no forman parte de la API pública del driver y pueden cambiarse en cualquier momento.

Obtenga un resumen del estado del cliente.

Devuelve:

(string) —

La string resumen.

Desde:

2.7.0



686
687
688

# Archivo 'lib/mongo/client.rb', línea 686

def Resumen
  "#<Grupo de clientes=#{clúster.resumen}>"
end

#timeout_ms ⇒ `Integer | nil`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el valor de la opción timeout_ms si está configurada.

Devuelve:

(Integer | nil) —

Valor de la opción timeout_ms si está configurada.

Desde:

2.0.0



1184
1185
1186

# Archivo 'lib/mongo/client.rb', línea 1184

def timeout_ms
  @options[:timeout_ms]
end

#timeout_sec ⇒ `Float | nil`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Devuelve el valor de la opción timeout_ms convertido a segundos.

Devuelve:

(Float | nil) —

Valor de la opción timeout_ms convertida en segundos.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 1190

def tiempo_límite_seg
  si timeout_ms.nil?
    nulo
  else
    timeout_ms / 1_000.0
  end
end

#update_options(new_options) ⇒ `Hash`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Actualiza las opciones de este cliente utilizando new_options, validando todas las opciones.

Las nuevas opciones pueden transformarse según distintas reglas. Se devuelve el hash final de las opciones realmente aplicadas al cliente.

Si las opciones no pasan la validación, este método puede advertir o generar una excepción. Si este método genera una excepción, el cliente debe ser descartado (de manera similar a si un constructor genera una excepción).

Parámetros:

nuevas_opciones (encriptada) —

Las nuevas opciones a usar.

Devuelve:

(encriptada) —

Se modificaron nuevas opciones escritas en el cliente.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 789

def update_options(nuevas_opciones)
  old_options = @options

  nuevas_opciones = sí mismo.clase.canonicalizar_opciones_ruby(nuevas_opciones || {})

  validate_new_options!(nuevas_opciones).tocar hacer |opta|
    # Nuestras opciones están congeladas
    opciones = @options.dup
    si opciones[guardar] && opta[:escribir_preocupación]
      opciones.borrar(guardar)
    end
    si opciones[:escribir_preocupación] && opta[guardar]
      opciones.borrar(:escribir_preocupación)
    end

    opciones.update(opta)
    @options = opciones.freeze

    auto_encryption_options_changed =
      @options[opciones de cifrado automático] != old_options[opciones de cifrado automático]

    # Si hay nuevas auto_encryption_options, crea un nuevo encriptador.
    # De lo contrario, permita que el nuevo cliente comparta un cifrador con el
    # cliente original.
    #
    # Si auto_encryption_options son nulos, establecer @encrypter en nulo, pero no
    # cierra el encriptador porque aún puede ser usado por el cliente original.
    si @options[opciones de cifrado automático] && auto_encryption_options_changed
      @connect_lock.sincronizar hacer
        construir_encrypter
      end
    elsif @options[opciones de cifrado automático].nil?
      @connect_lock.sincronizar hacer
        @encryptador = nulo
      end
    end

    validate_options!
    validate_authentication_options!
  end
end

#use(name) ⇒ `Mongo::Client`

Nota:

El nuevo cliente comparte el clúster con el cliente original, y como resultado también comparte la instancia de supervisión y los suscriptores de eventos de supervisión.

Crea un nuevo cliente configurado para utilizar la base de datos con el nombre proporcionado y utilizando las otras opciones configuradas en este cliente.

Ejemplos:

Crear un cliente para la base de datos "Usuarios".

client.use(:users)

Parámetros:

Nombre (Cadena,Símbolo) —

El nombre de la base de datos que se va a utilizar.

Devuelve:

(Mongo::Cliente) —

Una nueva instancia de cliente.

Desde:

2.0.0



741
742
743

# Archivo 'lib/mongo/client.rb', línea 741

def Usar(Nombre)
  con(database: Nombre)
end

#watch(tubería = [], opciones = {}) ⇒ `ChangeStream`

Nota:

Un flujo de cambios solo permite el nivel de consistencia de lectura de 'mayoría'.

Nota:

Este método asistente es preferible a ejecutar una agregación sin procesar con una etapa de $changeStream, con el fin de soportar la capacidad de reanudación.

A partir de la versión 3.6 del servidor MongoDB, se admite una etapa de pipeline “$changeStream“ en el framework de agregación. A partir de la versión 4.0, esta etapa permite a los usuarios solicitar que se envíen notificaciones por todos los cambios que ocurran en el clúster del cliente.

Ejemplos:

Reciba notificaciones de cambios para el clúster del cliente.

client.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])

Parámetros:

pipeline (arreglo<Hash>) (predeterminado: []) —

Operadores opcionales de filtro adicional.
opciones (Hash) (por defecto: {}) —

Las opciones de flujo de cambios.

Opciones Hash (options):

:documento_completo (Cadena) —

Valores permitidos: nulo, 'predeterminado', 'updateLookup', 'whenAvailable', 'obligatorio'.

El valor predeterminado es no enviar ningún valor (es decir, nulo), lo que equivale a "predeterminado". Por defecto, la notificación de cambios para actualizaciones parciales incluirá un delta que describe los cambios en el documento.

Cuando se configura en 'updateLookup', la notificación de cambio para actualizaciones parciales incluirá tanto un delta que describe los cambios en el documento como una copia del documento completo que se modificó algún tiempo después de que ocurrió el cambio.

Cuando se establece en 'whenAvailable', configura el flujo de cambios para devolver la imagen posterior del documento modificado para eventos de reemplazo y actualización si la imagen posterior para este evento está disponible.

Cuando se establece en "requerido", se comporta de la misma manera que "cuandoDisponible" excepto que se genera un error si la imagen de publicación no está disponible.
documento_completo_antes_de_modificar (Cadena) —

Valores permitidos: nil, ‘whenAvailable’ , ‘required’ , ‘off’.

El valor por defecto es no enviar ningún valor (es decir, nil), que equivale a ‘apagado’ o ‘desactivado’.

Cuando se configura en 'whenAvailable', establece el flujo de cambios para devolver la preimagen del documento modificado en caso de eventos de reemplazo, actualizar o borrar, si está disponible.

Cuando se establece en 'obligatorio', el mismo comportamiento que 'whenAvailable' excepto que se genera un error si la imagen previa no está disponible.
:resume_after (BSON::Document, Hash) —

Especifica el punto de partida lógico para el nuevo flujo de cambios.
; tiempo_máximo_espera_ms (Entero) —

El tiempo máximo que el servidor espera documentos nuevos para satisfacer una query de flujo de cambios.
:batch_size (Entero) —

El número de documentos a devolver por agrupar.
:colación (BSON::Document, Hash) —

La intercalación para usar.
:: sesión (Sesión) —

La sesión para usar.
:start_at_operation_time (BSON::Timestamp) —

Solo devuelve los cambios que ocurrieron en o después de la marca de tiempo especificada. Cualquier comando ejecutado en el servidor devolverá un tiempo de clúster que puede usarse aquí. Solo es reconocido por versiones del servidor 4.0+}.
:comment (Objeto) —

Un comentario proporcionado por el usuario para adjuntar a este comando.
:mostrar eventos expandidos (booleano) —

Permite al servidor enviar la lista 'expandida' de eventos de flujo de cambios. La lista de eventos adicionales incluidos con este conjunto de flags son: createIndexes, dropIndexes, modify, create, shardCollection, reshardCollection, refineCollectionShardKey.

Devuelve:

(Transmisiónde cambios) —

El objeto de flujo de cambio.

Desde:

2.6.0

# Archivo 'lib/mongo/client.rb', línea 1088

def reloj(pipeline = [], opciones = {})
  return Usar(Database::ADMIN).reloj(pipeline, opciones) a menos que database.Nombre == Database::ADMIN

  view_options = opciones.dup
  view_options[tipo_de_cursor] = tailable_await si opciones[; tiempo_máximo_espera_ms]

  Mongo::Colección::vista::ChangeStream.Nuevo(
    Mongo::Colección::vista.Nuevo(sí mismo["#{Basede datos::COMANDO}.aggregate"], {}, view_options),
    pipeline,
    Mongo::Colección::vista::ChangeStream::clúster,
    opciones)
end

#con(new_options = nil) ⇒ `Mongo::Client`

Nota:

Según las opciones proporcionadas, el cliente devuelto puede compartir el clúster con el cliente original o crearse con un nuevo clúster. Si se crea un nuevo clúster, los suscriptores de eventos de monitorización del nuevo cliente se configuran con el conjunto predeterminado de suscriptores de eventos y no se copia ninguno de los suscriptores del cliente original.

Crea un nuevo cliente con las opciones pasadas fusionadas con las opciones existentes de este cliente. Útil para modificar opciones específicas en casos puntuales sin modificar el cliente original.

Ejemplos:

Obtén un cliente con opciones modificadas.

client.with(:read => { :mode => :primary_preferred })

Parámetros:

nuevas_opciones (Hash) (predeterminado: nulo) —

Las nuevas opciones a usar.

Devuelve:

(Mongo::Cliente) —

Una nueva instancia de cliente.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 763

def con(nuevas_opciones = nulo)
  clon.tocar hacer |Cliente|
    opta = Cliente.update_options(nuevas_opciones || opciones::Redactado.Nuevo)
    Database.Cree(Cliente)
    # No podemos usar el mismo clúster si algunas opciones que lo afectarían
    # Han cambiado.
    si ¿modificando el clúster?(opta)
      clúster.Cree(Cliente, supervisión: opta[:escucha])
    end
  end
end

#con_sesión(opciones = {}, &bloque) ⇒ `Objeto`

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Crea una sesión para usar en operaciones si es posible y la entrega al bloque proporcionado.

Si se establece la opción :session, valida esa sesión y la utiliza. De lo contrario, si la implementación admite sesiones, se crea una nueva sesión y se usa. Cuando se crea una nueva sesión, ésta será implícita (el ciclo de vida lo gestiona el controlador) si se selecciona la opción :implicit, en caso contrario será explícita (el ciclo de vida lo gestiona la aplicación). Si la implementación no admite sesión, ciérralo en nil.

Al finalizar el bloque, si se creó la sesión implícitamente o se pasó una sesión implícita, la sesión finaliza, lo que la devuelve al grupo de sesiones disponibles.

Parámetros:

opciones (Hash) (por defecto: {}) —

un conjunto personalizable de opciones

Opciones Hash (options):

:implicit (true | false) —

Cuando no se pasa una sesión, si se debe crear una sesión implícita.
:: sesión (Sesión) —

La sesión para validar y devolver.

Desde:

2.0.0

# Archivo 'lib/mongo/client.rb', línea 1144

def con_sesión(opciones = {}, Ybloque)
  # TODO: Agregar esto nuevamente en RUBY-3174.
  # assert_not_closed

  sesión = get_session(opciones)

  rendimiento sesión
asegurar
  si sesión && sesión.implicit?
    sesión.fin_sesión
  end
end

#write_concern ⇒ `Mongo::WriteConcern`

Obtén el nivel de confirmación de escritura (write concern) para este cliente. Si no se proporciona ninguna opción, se utilizará por defecto un acuse de recibo de servidor único.

Ejemplos:

Consultar el nivel de confirmación de escritura (write concern) del cliente.

client.write_concern

Devuelve:

(Mongo::WriteConcern) —

El nivel de confirmación de escritura (write concern).

Desde:

2.0.0



852
853
854

# Archivo 'lib/mongo/client.rb', línea 852

def escribir_preocupación
  @write_concern ||= Nivel de confirmación de escritura (write concern).Obtener(opciones[:escribir_preocupación] || opciones[guardar])
end

Clase: Mongo::Client

Overview

Colapso delresumen constante

Constantes incluidas desde Loggable

Resumen de atributos de la instancia colapsar

Resumen del método de clase colapsar

Resumen del método de instancia colapsar

Métodos incluidos desde Registrable

Detalles del constructor

#inicializar(direcciones_o_uri, opciones = nil) ⇒ Cliente

Ejemplos:

Instanciar un único servidor o cliente mongos.

Instanciar un cliente para un set de réplicas.

Conéctese directamente a un mongod en un set de réplicas

Detalles de los atributos de instancia

#clúster ⇒ Mongo::Cluster (solo lectura)

#database ⇒ Mongo::Database (readonly)

#encrypter ⇒ Mongo:: Crypt:: AutoEncrypter (solo lectura)

#opciones ⇒ Hash (solo lectura)

Detalles del método de clase

.canonicalize_ruby_options(opciones) ⇒ Objeto

Detalles del método de instancia

#==(otro) ⇒ verdadero, falso También conocido como: eql?

Ejemplos:

Comprueba la igualdad del cliente.

#[](collection_name, options = {}) ⇒ Mongo::Collection

Ejemplos:

Obtenga la colección.

#cerrar ⇒ verdadero

#close_encrypter ⇒ true

#cerrado? ⇒ Booleano

#cluster_options ⇒ Objeto

#database_names(filtro = {}, opciones = {}) ⇒ arreglo<String>

Ejemplos:

Obtener los nombres de las bases de datos.

#encrypted_fields_map ⇒ Hash | nil

#get_session(options = {}) ⇒ Session | nil

#hash ⇒ Integer

Ejemplos:

Obtenga el valor hash del cliente.

#inspect ⇒ String

Ejemplos:

Inspeccionar al cliente.

#list_databases(filtro = {}, solo_nombre = false, opciones = {}) ⇒ arreglo<Hash>

Ejemplos:

Obtén la información de cada base de datos.

#list_mongo_databases(filter = {}, opts = {}) ⇒ Array<Mongo::Database>

Ejemplos:

Obtenga una lista de objetos Mongo::Database.

#max_read_retries ⇒ Entero

#max_write_retries ⇒ Entero

#read_concern ⇒ Hash

Ejemplos:

Obtenga el nivel de consistencia de lectura del cliente.

#read_preference ⇒ BSON::Document

Ejemplos:

Obtén la preferencia de lectura.

#read_retry_interval ⇒ Float

#reconectar ⇒ verdadero

Ejemplos:

Reconectar el cliente.

#server_selector ⇒ Mongo::ServerSelector

Ejemplos:

Obtenga el selector de servidor.

#start_session(options = {}) ⇒ Sesión

Ejemplos:

Inicia una sesión.

#summary → String

#timeout_ms ⇒ Integer | nil

#timeout_sec ⇒ Float | nil

#update_options(new_options) ⇒ Hash

#use(name) ⇒ Mongo::Client

Ejemplos:

Crear un cliente para la base de datos "Usuarios".

#watch(tubería = [], opciones = {}) ⇒ ChangeStream

Ejemplos:

Reciba notificaciones de cambios para el clúster del cliente.

#con(new_options = nil) ⇒ Mongo::Client

Ejemplos:

Obtén un cliente con opciones modificadas.

#inicializar(direcciones_o_uri, opciones = nil) ⇒ `Cliente`

#clúster ⇒ `Mongo::Cluster` (solo lectura)

#database ⇒ `Mongo::Database` (readonly)

#encrypter ⇒ `Mongo:: Crypt:: AutoEncrypter` (solo lectura)

#opciones ⇒ `Hash` (solo lectura)

.canonicalize_ruby_options(opciones) ⇒ `Objeto`

#==(otro) ⇒ verdadero, `falso` También conocido como: eql?

#[](collection_name, options = {}) ⇒ `Mongo::Collection`

#cerrar ⇒ `verdadero`

#close_encrypter ⇒ `true`

#cerrado? ⇒ `Booleano`

#cluster_options ⇒ `Objeto`

#database_names(filtro = {}, opciones = {}) ⇒ `arreglo<String>`

#encrypted_fields_map ⇒ `Hash | nil`

#get_session(options = {}) ⇒ `Session | nil`

#hash ⇒ `Integer`

#inspect ⇒ `String`

#list_databases(filtro = {}, solo_nombre = false, opciones = {}) ⇒ `arreglo<Hash>`

#list_mongo_databases(filter = {}, opts = {}) ⇒ `Array<Mongo::Database>`

#max_read_retries ⇒ `Entero`

#max_write_retries ⇒ `Entero`

#read_concern ⇒ `Hash`

#read_preference ⇒ `BSON::Document`

#read_retry_interval ⇒ `Float`

#reconectar ⇒ `verdadero`

#server_selector ⇒ `Mongo::ServerSelector`

#start_session(options = {}) ⇒ `Sesión`

#summary → `String`

#timeout_ms ⇒ `Integer | nil`

#timeout_sec ⇒ `Float | nil`

#update_options(new_options) ⇒ `Hash`

#use(name) ⇒ `Mongo::Client`

#watch(tubería = [], opciones = {}) ⇒ `ChangeStream`

#con(new_options = nil) ⇒ `Mongo::Client`

#con_sesión(opciones = {}, &bloque) ⇒ `Objeto`

#write_concern ⇒ `Mongo::WriteConcern`