Opções do MongoClient para Queryable Encryption

Nesta página

Visão geral

Opções de criptografia automática

Queryable Encryption com queries de igualdade normalmente está disponível (GA) no MongoDB 7.0 e versões posteriores. A pré-visualização pública do Queryable Encryption , lançada na versão 6.0, não é mais aceita. Os dados criptografados utilizando a pré-visualização pública são incompatíveis com as funcionalidades da versão. Para obter mais informações, consulte Alterações de compatibilidade no MongoDB 7.0.

Visão geral

Nesta página, você pode aprender sobre as opções de configuração específicas do Queryable Encryption para instâncias do MongoClient .

Opções de criptografia automática

A tabela a seguir descreve a estrutura de um objeto AutoEncryptionOptions:

Propriedade	Tipo de Dados	Obrigatório?	Descrição
`keyVaultNamespace`	`String`	Sim	O namespace completo da coleção Key Vault.
`kmsProviders`	`Object`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `kmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desabilita a análise automática dos comandos de saída. Especifique `true` para usar a criptografia explícita sem a biblioteca compartilhada de criptografia automática.
`encryptedFieldsMap`	`Object`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`extraOptions`	`Object`	No	Opções de configuração para a biblioteca de criptografia. Para usar a Shared Library de criptografia automática em vez de `mongocryptd`, especifique o caminho do arquivo relativo ou absoluto completo para o arquivo de biblioteca na propriedade `cryptSharedLibPath` deste objeto. Se o driver não puder carregar a biblioteca compartilhada de criptografia automática a partir desse caminho, a criação do `MongoClient` falhará.
`keyVaultClient`	`MongoClient`	No	Especifica o `MongoClient` que deve se conectar à instância do MongoDB que hospeda sua Key Vault Collection. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`tlsOptions`	`Object`	No	As opções de TLS a serem usadas ao se conectar ao provedor de KMS.

A tabela a seguir descreve as propriedades em um objeto AutoEncryptionOptions :

Propriedade	Tipo de Dados	Obrigatório?	Descrição
`KeyVaultNamespace`	`CollectionNamespace`	Sim	O namespace completo da coleção Key Vault.
`KmsProviders`	`IReadOnlyDictionary`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `KmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`BypassAutoEncryption`	`Boolean`	No	Especifique `true` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`BypassQueryAnalysis`	`Boolean`	No	Desabilita a análise automática de comandos de saída. Defina essa propriedade como `true` para usar a criptografia explícita sem a Biblioteca compartilhada de criptografia automática.
`EncryptedFieldsMap`	`IReadOnlyDictionary`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`ExtraOptions`	`IReadOnlyDictionary`	No	Opções de configuração para a biblioteca de criptografia. Para usar a Biblioteca Compartilhada de Criptografia Automática em vez de `mongocryptd`, especifique o caminho de arquivo absoluto ou relativo completo para o arquivo de biblioteca na propriedade `cryptSharedLibPath` . Se o driver não puder carregar a biblioteca compartilhada de criptografia automática a partir desse caminho, a criação do `MongoClient` falhará.
`KeyVaultClient`	`IMongoClient`	No	Especifica o `MongoClient` que deve se conectar à instância do MongoDB que hospeda sua Key Vault Collection. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`TlsOptions`	`IReadOnlyDictionary`	No	As opções de TLS a serem usadas ao se conectar ao provedor de KMS.

Observação

Documentação da API

Para obter mais informações sobre essas opções de criptografia automática , consulte a documentação da API para AutoEncryptionOptions classe.

A tabela a seguir descreve as opções em um objeto AutoEncryptionOptions :

Opção	Tipo de Dados	Obrigatório?	Descrição
`KeyVaultNamespace`	`String`	Sim	O namespace completo da coleção Key Vault.
`KmsProviders`	`map[string]map[string]interface{}`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `KmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`BypassAutoEncryption`	`*bool`	No	Especifique `true` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`BypassQueryAnalysis`	`*bool`	No	Desabilita a análise automática dos comandos de saída. Especifique `true` para usar a criptografia explícita sem a biblioteca compartilhada de criptografia automática.
`EncryptedFieldsMap`	`map[string]interface{}`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`ExtraOptions`	`map[string]interface{}`	No	Opções de configuração para a biblioteca de criptografia. Para usar a Biblioteca Compartilhada de Criptografia Automática em vez de `mongocryptd`, especifique o caminho de arquivo absoluto ou relativo completo para o arquivo de biblioteca na propriedade `cryptSharedLibPath` . Se o driver não puder carregar a biblioteca compartilhada de criptografia automática a partir desse caminho, a criação do `MongoClient` falhará.
`KeyVaultClientOptions`	`*ClientOptions`	No	Opções para um novo `mongo.Client` interno para se conectar à instância do MongoDB que hospeda sua coleção do Key Vault. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`TlsConfig`	`map[string]*tls.Config`	No	As opções de TLS a serem usadas ao se conectar ao provedor de KMS.

Observação

Documentação da API

Para obter mais informações sobre essas opções de criptografia automática , consulte a documentação da API para o AutoEncryptionOptions tipo.

A tabela seguinte descreve os métodos disponíveis no construtor do AutoEncryptionSettings :

Método	Tipo de Dados	Obrigatório?	Descrição
`keyVaultNamespace`	`String`	Sim	O namespace completo da coleção Key Vault.
`kmsProviders`	`Map`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `kmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desabilita a análise automática dos comandos de saída. Especifique `true` para usar a criptografia explícita sem a biblioteca compartilhada de criptografia automática.
`encryptedFieldsMap`	`Map`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`extraOptions`	`Map`	No	Opções de configuração para a biblioteca de criptografia. Para usar a Biblioteca Compartilhada de Criptografia Automática em vez de `mongocryptd`, especifique o caminho de arquivo absoluto ou relativo completo para o arquivo de biblioteca na propriedade `cryptSharedLibPath` .
`keyVaultMongoClientSettings`	`MongoClientSettings`	No	Configurações para uma nova instância do `MongoClient` para conectar à instância MongoDB hospedando sua coleção do Key Vault. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`kmsProviderPropertySuppliers`	`Map`	No	Semelhante ao método `kmsProviders()` , mas configura um `Supplier` para cada propriedade .
`kmsProviderSslContextMap`	`Map`	No	O contexto SSL a ser usado para autenticação.

Observação

Documentação da API

Para obter mais informações sobre essas opções de criptografia automática , consulte a documentação da API para o AutoEncryptionSettings.Builder classe.

A tabela a seguir descreve a estrutura de um objeto AutoEncryptionOptions:

Propriedade	Tipo de Dados	Obrigatório?	Descrição
`keyVaultNamespace`	`String`	Sim	O namespace completo da coleção Key Vault.
`kmsProviders`	`Object`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre objetos do `kmsProviders` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`bypassAutoEncryption`	`Boolean`	No	Especifique `true` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`bypassQueryAnalysis`	`Boolean`	No	Desabilita a análise automática de comandos de saída. Especifique `true` para usar a criptografia explícita sem a biblioteca compartilhada de criptografia automática. O padrão para `false` não é especificado.
`encryptedFieldsMap`	`Object`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`extraOptions`	`Object`	No	Opções de configuração para a biblioteca de criptografia. Para usar a Shared Library de criptografia automática em vez de `mongocryptd`, especifique o caminho do arquivo relativo ou absoluto completo para o arquivo de biblioteca na propriedade `cryptSharedLibPath` deste objeto. Se o driver não puder carregar a biblioteca compartilhada de criptografia automática a partir desse caminho, a criação do `MongoClient` falhará.
`keyVaultClient`	`MongoClient`	No	Especifica o `MongoClient` que deve se conectar à instância do MongoDB que hospeda sua Key Vault Collection. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`tlsOptions`	`Object`	No	As opções de TLS a serem usadas ao se conectar ao provedor de KMS.

Observação

Documentação da API

Para obter mais informações sobre essas opções de criptografia automática , consulte a documentação da API para o AutoEncryptionOptions interface.

A tabela seguinte descreve os parâmetros da classe AutoEncryptionOpts :

Parâmetro	Tipo de Dados	Obrigatório?	Descrição
`key_vault_namespace`	`String`	Sim	O namespace completo da coleção Key Vault.
`kms_providers`	`Mapping[string, Any]`	Sim	O sistema de gerenciamento de chaves (KMS) usado pela Queryable Encryption para gerenciar suas chaves mestras do cliente (CMKs). Para saber mais sobre mapas do `kms_Providers` , consulte Fornecedores de KMS. Para saber mais sobre as chaves mestres do cliente, consulte Chaves e cofres de chaves.
`bypass_auto_encryption`	`Boolean`	No	Especifique `True` para ignorar as regras de criptografia automática e executar a criptografia explícita (manual) por campo.
`bypass_query_analysis`	`Boolean`	No	Desabilita a análise automática dos comandos de saída. Especifique `True` para usar a criptografia explícita sem a biblioteca compartilhada de criptografia automática.
`encrypted_fields_map`	`Mapping`	No	Um esquema que especifica quais campos criptografar automaticamente e os tipos de queries permitidas nesses campos. Para saber como construir um esquema de criptografia, consulte Criptografia de campo e consultabilidade.
`crypt_shared_lib_path`	`String`	No	Especifique o caminho do arquivo absoluto ou relativo completo para o arquivo da biblioteca neste parâmetro para usar a Biblioteca Compartilhada de Criptografia Automática em vez de `mongocryptd`, Se o driver não puder carregar a biblioteca compartilhada de criptografia automática a partir desse caminho, ele emitirá um erro.
`crypt_shared_lib_required`	`Boolean`	No	Se você especificar `True`, o driver emitirá um erro se `libmongocrypt` não conseguir carregar a biblioteca compartilhada de criptografia automática.
`key_vault_client`	`MongoClient`	No	Especifica o `MongoClient` que deve se conectar à instância do MongoDB que hospeda sua Key Vault Collection. Se você omitir esta opção, o driver utilizará a instância do `MongoClient` atual. Para saber mais sobre as collections do Key Vault, veja Coleções do Key Vault.
`kms_tls_options`	`Mapping[string, Any]`	No	As opções de TLS a serem usadas ao se conectar ao provedor de KMS.
`mongocryptd_uri`	`String`	No	O URI do MongoDB usado para se conectar ao processo `mongocryptd` local, se estiver usando `mongocryptd` para criptografia.
`mongocryptd_bypass_spawn`	`Boolean`	No	Se você especificar `True` para este parâmetro, o `MongoClient` criptografado não tentará gerar o processo `mongocryptd` , se estiver usando `mongocryptd` para criptografia.
`mongocryptd_spawn_path`	`String`	No	Usado para gerar o processo `mongocryptd` , se estiver usando `mongocryptd` para criptografia.
`mongocryptd_spawn_args`	`String`	No	Uma lista de argumentos de string a serem usados ao gerar o processo `mongocryptd` , se estiver usando `mongocryptd` para criptografia.

Observação

Documentação da API

Para obter mais informações sobre essas opções de criptografia automática , consulte a documentação da API para o AutoEncryptionOpts classe.

Voltar

Operações suportadas

Biblioteca compartilhada