Interface ClientEncryptionEncryptOptions

Options to provide when encrypting data.

interface ClientEncryptionEncryptOptions {
    algorithm:
        | "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
        | "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
        | "Indexed"
        | "Unindexed"
        | "Range";
    contentionFactor?: number | bigint;
    keyAltName?: string;
    keyId?: Binary;
    queryType?: "equality" | "range";
    rangeOptions?: RangeOptions;
}

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"
    | "Range"

The algorithm to use for encryption.

OptionalcontentionFactor

contentionFactor?: number | bigint

The contention factor.

OptionalkeyAltName

keyAltName?: string

A unique string name corresponding to an already existing dataKey.

OptionalkeyId

keyId?: Binary

The id of the Binary dataKey to use for encryption

OptionalqueryType

queryType?: "equality" | "range"

The query type.

OptionalrangeOptions

rangeOptions?: RangeOptions

The index options for a Queryable Encryption field supporting "range" queries.

Settings

Member Visibility

On This Page

Properties