Interface ClientEncryptionEncryptOptions

Options to provide when encrypting data.

Hierarchy

  • ClientEncryptionEncryptOptions

Properties

algorithm contentionFactor? keyAltName? keyId? queryType? rangeOptions?

Properties

algorithm

algorithm: "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic" | "AEAD_AES_256_CBC_HMAC_SHA_512-Random" | "Indexed" | "Unindexed" | "RangePreview"

The algorithm to use for encryption.

Optional contentionFactor

contentionFactor?: number | bigint

The contention factor.

Optional keyAltName

keyAltName?: string

A unique string name corresponding to an already existing dataKey.

Optional keyId

keyId?: Binary

The id of the Binary dataKey to use for encryption

Optional Experimental queryType

queryType?: "equality" | "rangePreview"

The query type supported. Only the queryType equality is stable.

Public Technical Preview: The queryType rangePreview is experimental.

Optional Experimental rangeOptions

rangeOptions?: RangeOptions

Public Technical Preview: The index options for a Queryable Encryption field supporting "rangePreview" queries.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc