MongoDB\Driver\ClientEncryption::encrypt

Parameters

value

The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.

options

Encryption options

Option	Type	Description
algorithm	string	The encryption algorithm to be used. This option is required. Specify one of the following ClientEncryption constants: MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED
contentionFactor	int	The contention factor for evaluating queries with indexed, encrypted payloads. This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. Note: Queryable Encryption is in public preview and available for evaluation purposes. It is not yet recommended for production deployments as breaking changes may be introduced. See the » Queryable Encryption Preview blog post for more information.
keyAltName	string	Identifies a key vault collection document by keyAltName. This option is mutually exclusive with keyId and exactly one is required.
keyId	MongoDB\BSON\Binary	Identifies a data key by _id. The value is a UUID (binary subtype 4). This option is mutually exclusive with keyAltName and exactly one is required.
queryType	int	The query type for evaluating queries with indexed, encrypted payloads. Specify one of the following ClientEncryption constants: MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. Note: Queryable Encryption is in public preview and available for evaluation purposes. It is not yet recommended for production deployments as breaking changes may be introduced. See the » Queryable Encryption Preview blog post for more information.