(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Encrypt a value
$value
, ?array $options
= null
): MongoDB\BSON\BinaryEncrypts the value.
value
The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.
options
Option | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
algorithm | string |
L'algorithme de chiffrement à utiliser. Cette option est requise. Spécifiez l'une des constantes suivantes de ClientEncryption :
|
|||||||||||||||
contentionFactor | int |
Le facteur de contention pour évaluer les requêtes avec des charges utiles chiffrées indexées.
Cette option s'applique uniquement et ne peut être spécifiée que lorsque
|
|||||||||||||||
keyAltName | string |
Identifie un document de collection de coffre à clés par |
|||||||||||||||
keyId | MongoDB\BSON\Binary |
Identifie une clé de données par |
|||||||||||||||
queryType | string |
Le type de requête pour évaluer les requêtes avec des charges utiles chiffrées indexées. Spécifiez l'une des constantes suivantes de ClientEncryption :
Cette option s'applique uniquement et ne peut être spécifiée que lorsque
|
|||||||||||||||
rangeOpts | array |
Options d'index pour un champ de chiffrement interrogeable prenant en charge les requêtes "rangePreview". Les options ci-dessous doivent correspondre
aux valeurs définies dans
|
Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.
Version | Description |
---|---|
PECL mongodb 1.14.0 |
Added the "contentionFactor" and
"queryType" options.
|