MongoDB\Driver\ClientEncryption::encrypt
(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
Beschreibung
$value, array $options = ?): MongoDB\BSON\BinaryEncrypts the value.
Parameter-Liste
-
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_DETERMINISTICMongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOMMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXEDMongoDB\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
algorithmisMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.Hinweis: 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 withkeyIdand 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 withkeyAltNameand 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
algorithmisMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.Hinweis: 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.
Rückgabewerte
Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.
Fehler/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while encrypting the value
Changelog
| Version | Beschreibung |
|---|---|
| PECL mongodb 1.14.0 |
Added the "contentionFactor" and
"queryType" options.
|
Siehe auch
- MongoDB\Driver\ClientEncryption::decrypt() - Decrypt a value
