(mongodb >=1.16.0)
MongoDB\Driver\ClientEncryption::encryptExpression — Encrypts a match or aggregate expression
$expr
, ?array $options
= null
): objectEncrypts a match or aggregate expression to query a range index.
To query with a range encrypted payload, the MongoDB\Driver\Manager must be configured with the "autoEncryption"
driver option. The "bypassQueryAnalysis"
auto encryption option may be true
. The "bypassAutoEncryption"
auto encryption option must be false
.
Note:
The range algorithm is experimental only. It is not intended for public use.
The PHP driver does not yet support range queries for decimal128 BSON field types.
expr
The match or aggregate expression to be encrypted. Expressions must use at
least one of the $gt
, $gte
,
$lt
, or $lte
operators. A top-level
$and
operator is required, even if only a single
comparison operator is used.
An example of a supported match expression (applies to queries and the
$match
aggregation stage) is as follows:
[ '$and' => [ [ '<field>' => [ '$gt' => '<value1>' ] ], [ '<field>' => [ '$lte' => '<value2>' ] ], ], ]
An example of a supported aggregate expression is as follows:
[ '$and' => [ [ '$gte' => [ '<fieldPath>', '<value1>' ] ], [ '$lt' => [ '<fieldPath>', '<value2>' ] ], ], ]
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 expression as an object.