Packages

o

org.mongodb.scala

AutoEncryptionSettings

object AutoEncryptionSettings

The client-side automatic encryption settings. Client side encryption enables an application to specify what fields in a collection must be encrypted, and the driver automatically encrypts commands sent to MongoDB and decrypts responses.

Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view and will result in error. To bypass automatic encryption, set bypassAutoEncryption=true in AutoEncryptionSettings.

Explicit encryption/decryption and automatic decryption is a community feature, enabled with the new com.mongodb.client.vault.ClientEncryption type.

A MongoClient configured with bypassAutoEncryption=true will still automatically decrypt.

If automatic encryption fails on an operation, use a MongoClient configured with bypassAutoEncryption=true and use ClientEncryption#encrypt to manually encrypt values.

Enabling client side encryption reduces the maximum document and message size (using a maxBsonObjectSize of 2MiB and maxMessageSizeBytes of 6MB) and may have a negative performance impact.

Automatic encryption requires the authenticated user to have the listCollections privilege action.

Since

2.7

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AutoEncryptionSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Builder = com.mongodb.AutoEncryptionSettings.Builder

    AutoEncryptionSettings builder type

Value Members

  1. def builder(): Builder

    Gets a Builder for creating a new AutoEncryptionSettings instance.

    Gets a Builder for creating a new AutoEncryptionSettings instance.

    returns

    a new Builder for creating AutoEncryptionSettings.