Queryable Encryption の MongoClient オプション

keyVaultNamespace

String

はい

キーヴォールト コレクションの完全な名前空間。

kmsProviders

Object

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

kmsProvidersオブジェクトの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

bypassAutoEncryption

Boolean

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 trueを指定します。

bypassQueryAnalysis

Boolean

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 trueを指定します。

encryptedFieldsMap

Object

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

explicitEncryptionOnly

Boolean

No

explicitEncryptionOnly を true に設定すると、ドライバーは明示的（手動）のフィールドごとの暗号化のみを使用し、接続から自動暗号化設定を削除します。ClientEncryption APIを使用してフィールド値を手動で暗号化および復号化する必要があります。

このオプションは CSFLE でのみ機能します。

keyVaultClient

MongoClient

No

キーヴォールト コレクションをホストしている MongoDB インスタンスに接続するMongoClientを指定します。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

tlsOptions

Object

No

KMS プロバイダーに接続するときに使用する TLS オプションです。

KeyVaultNamespace

CollectionNamespace

はい

キーヴォールト コレクションの完全な名前空間。

KmsProviders

IReadOnlyDictionary

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

KmsProvidersオブジェクトの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

BypassAutoEncryption

Boolean

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 trueを指定します。

BypassQueryAnalysis

Boolean

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、このプロパティをtrueに設定します。

EncryptedFieldsMap

IReadOnlyDictionary

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

ExtraOptions

IReadOnlyDictionary

No

暗号化ライブラリの構成オプション。

mongocryptdの代わりに 自動暗号化共有ライブラリ を使用するには、 cryptSharedLibPathプロパティでライブラリ ファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。

ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 MongoClientの作成は失敗します。

KeyVaultClient

IMongoClient

No

キーヴォールト コレクションをホストしている MongoDB インスタンスに接続するMongoClientを指定します。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

TlsOptions

IReadOnlyDictionary

No

KMS プロバイダーに接続するときに使用する TLS オプションです。

KeyVaultNamespace

String

はい

キーヴォールト コレクションの完全な名前空間。

KmsProviders

map[string]map[string]interface{}

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

KmsProvidersオブジェクトの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

BypassAutoEncryption

*bool

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 trueを指定します。

BypassQueryAnalysis

*bool

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 trueを指定します。

EncryptedFieldsMap

map[string]interface{}

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

ExtraOptions

map[string]interface{}

No

暗号化ライブラリの構成オプション。

mongocryptdの代わりに 自動暗号化共有ライブラリ を使用するには、 cryptSharedLibPathプロパティでライブラリ ファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。

ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 MongoClientの作成は失敗します。

KeyVaultClientOptions

*ClientOptions

No

キーヴォールトコレクションをホストしている MongoDB インスタンスに接続するための新しい内部mongo.Clientのオプション。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

TlsConfig

map[string]*tls.Config

No

KMS プロバイダーに接続するときに使用する TLS オプションです。

keyVaultNamespace

String

はい

キーヴォールト コレクションの完全な名前空間。

kmsProviders

Map

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

kmsProvidersオブジェクトの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

bypassAutoEncryption

Boolean

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 trueを指定します。

bypassQueryAnalysis

Boolean

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 trueを指定します。

encryptedFieldsMap

Map

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

extraOptions

Map

No

暗号化ライブラリの構成オプション。

mongocryptdの代わりに 自動暗号化共有ライブラリ を使用するには、 cryptSharedLibPathプロパティでライブラリ ファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。

keyVaultMongoClientSettings

MongoClientSettings

No

新しいMongoClientインスタンスが、キーヴォールトコレクションをホストしている MongoDB インスタンスに接続するための設定。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

kmsProviderPropertySuppliers

Map

No

kmsProviders()メソッドと同様ですが、代わりに各プロパティに対してSupplierを構成します。

kmsProviderSslContextMap

Map

No

認証に使用する SSL コンテキスト。

keyVaultNamespace

String

はい

キーヴォールト コレクションの完全な名前空間。

kmsProviders

Object

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

kmsProvidersオブジェクトの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

bypassAutoEncryption

Boolean

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 trueを指定します。

bypassQueryAnalysis

Boolean

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 trueを指定します。 指定しない場合、デフォルトはfalseです。

encryptedFieldsMap

Object

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

extraOptions

Object

No

暗号化ライブラリの構成オプション。

mongocryptdの代わりに 自動暗号化共有ライブラリ を使用するには、このオブジェクトのcryptSharedLibPathプロパティでライブラリ ファイルへの完全な絶対ファイルパスまたは相対ファイルパスを指定します。

ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合、 MongoClientの作成は失敗します。

keyVaultClient

MongoClient

No

キーヴォールト コレクションをホストしている MongoDB インスタンスに接続するMongoClientを指定します。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

tlsOptions

Object

No

KMS プロバイダーに接続するときに使用する TLS オプションです。

key_vault_namespace

String

はい

キーヴォールト コレクションの完全な名前空間。

kms_providers

Mapping[string, Any]

はい

CMK（Customer Master Key）を管理するために Queryable Encryption で使用される KMS（Key Management System） 。

kms_Providersマップの詳細については、 KMS プロバイダー を参照してください。

CMK の詳細については、「暗号化キー と キーヴォールト 」を参照してください。

bypass_auto_encryption

Boolean

No

自動暗号化ルールをバイパスし、フィールドごとの明示的な（手動）暗号化を実行するには、 Trueを指定します。

bypass_query_analysis

Boolean

No

送信コマンドの自動分析を無効にします。 自動暗号化共有ライブラリなしで明示的な暗号化を使用するには、 Trueを指定します。

encrypted_fields_map

Mapping

No

自動的に暗号化するフィールドと、それらのフィールドで許可されるクエリのタイプを指定するスキーマ。

暗号化スキーマの構築方法については、「暗号化されたフィールド 」と「 有効なクエリ 」を参照してください。

crypt_shared_lib_path

String

No

このパラメータでライブラリ ファイルへの完全な絶対ファイル パスまたは相対ファイル パスを指定して、 mongocryptdの代わりに自動暗号化共有ライブラリを使用します。

ドライバーがこのパスから自動暗号化共有ライブラリを読み込まない場合は、エラーが発生します。

crypt_shared_lib_required

Boolean

No

Trueを指定した場合、 libmongocryptが自動暗号化共有ライブラリを読み込まない場合、ドライバーはエラーを発生させます。

key_vault_client

MongoClient

No

キーヴォールト コレクションをホストしている MongoDB インスタンスに接続するMongoClientを指定します。

このオプションを省略すると、ドライバーは現在のMongoClientインスタンスを使用します。

キー Vault コレクションの詳細については、「キー Vault コレクション 」を参照してください。

kms_tls_options

Mapping[string, Any]

No

KMS プロバイダーに接続するときに使用する TLS オプションです。

mongocryptd_uri

String

No

暗号化にmongocryptdを使用する場合に、ローカルmongocryptdプロセスへの接続に使用される MongoDB URI 。

mongocryptd_bypass_spawn

Boolean

No

このパラメータにTrueを指定すると、暗号化されたMongoClientは、暗号化にmongocryptdを使用している場合、 mongocryptdプロセスの生成を試行しません。

mongocryptd_spawn_path

String

No

暗号化にmongocryptdを使用する場合に、 mongocryptdプロセスを生成するために使用されます。

mongocryptd_spawn_args

String

No

暗号化にmongocryptdを使用する場合に、 mongocryptdプロセスを生成するときに使用する string 引数のリスト。