Docs Home → Develop Applications → MongoDB Manual
MongoClient Options for Queryable Encryption
On this page
Overview
View information about the Queryable Encryption specific
configuration options for MongoClient instances.
AutoEncryptionOpts
Pass an AutoEncryptionOpts object to your MongoClient
instance to specify Queryable Encryption specific options.
The following table describes the structure of an
AutoEncryptionOpts object:
Parameter | Type | Required | Description |
|---|---|---|---|
keyVaultClient | MongoClient | No | A If you omit the To learn more about Key Vault collections, see Key Vault Collections. |
keyVaultNamespace | String | Yes | The full namespace of the Key Vault collection. |
kmsProviders | Object | Yes | The Key Management System (KMS) used by Queryable Encryption for managing your Customer Master Keys (CMKs). To learn more about To learn more about Customer Master Keys, see Keys and Key Vaults. |
encryptedFieldsMap | Object | No | An encryption schema. To learn how to construct an encryption schema, see Field Encryption and Queryability. |
bypassQueryAnalysis | Boolean | No | Disables automatic analysis of outgoing commands. Set bypassQueryAnalysis
to true to use explicit encryption on indexed fields without the
crypt_shared library. Defaults to false if not specified. |
Example
To view a code-snippet demonstrating how to use
AutoEncryptionOpts to configure your
MongoClient instance, select the tab corresponding to your driver:
To learn about additional options for configuring Automatic Encryption Shared Library, see Configuration.