For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
IMPORTANT: To avoid exposing your authentication credentials in your connection.uri setting, use a ConfigProvider and set the appropriate configuration parameters.
Default: mongodb://localhost:27017 Accepted Values: A MongoDB connection URI string
server.api.version
Type: string
Description: The Stable API version you want to use with your MongoDB
server. For more information on the Stable API and versions of
the server that support it, see the Stable API
MongoDB server manual guide.
Default: "" Accepted Values: An empty string or a valid Stable API version
server.api.deprecationErrors
Type: boolean
Description: When set to true, if the connector calls a command on your
MongoDB instance that's deprecated in the declared Stable API
version, it raises an exception.
You can set the API version with the server.api.version
configuration option. For more information on the Stable API, see
the MongoDB manual entry on the
Stable API.
Default: false Accepted Values: true or false
server.api.strict
Type: boolean
Description: When set to true, if the connector calls a command on your
MongoDB instance that's not covered in the declared Stable API
version, it raises an exception.
You can set the API version with the server.api.version
configuration option. For more information on the Stable API, see
the MongoDB manual entry on the
Stable API.
Default: false Accepted Values: true or false
csfle.enabled
Type: boolean
Description: Flag that, when set to true, enables Client-Side Field Level
Encryption (CSFLE) for the MongoDB connection.
Default: false Accepted Values: true or false
csfle.key.vault.namespace
Type: string
Description: Key vault namespace for CSFLE in the format
database.collection. For example: encryption.__keyVault. Required when csfle.enabled is set to true.
Default: "" Accepted Values: A valid MongoDB namespace in the format database.collection
csfle.local.master.key
Type: string
Description: Base64-encoded 96-byte local master key for CSFLE with the local
KMS provider. The connector uses the key to encrypt and decrypt data
encryption keys stored in the key vault. Required when csfle.enabled is set to true.
Default: "" Accepted Values: A Base64-encoded 96-byte string
csfle.schema.map
Type: string
Description: JSON document defining the encryption schema map for CSFLE.
This maps namespaces to JSON schemas that specify which fields to
encrypt and which encryption algorithm and key to use.
Default: "" Accepted Values: A valid JSON document
csfle.bypass.query.analysis
Type: boolean
Description: Flag that indicates whether or not to bypass automatic query analysis
for CSFLE. When set to true, the connector disables automatic
encryption based on schema maps, and you must use explicit encryption.
When set to false, the connector enables automatic encryption but
requires mongocryptd or the crypt_shared library. Defaults to true to avoid external dependencies.