(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.
Nota:
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
| Opção | Tipo | Descrição | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| algorithm | string |
O algoritmo de criptografia a ser usado. Esta opção é obrigatória. Especifique uma das seguintes constantes ClientEncryption:
|
|||||||||||||||
| contentionFactor | int |
O fator de contenção para avaliar consultas com cargas indexadas e criptografadas.
Esta opção só se aplica e só pode ser especificada quando
|
|||||||||||||||
| keyAltName | string |
Identifica um documento de coleção de cofres de chaves por
|
|||||||||||||||
| keyId | MongoDB\BSON\Binary |
Identifica uma chave de dados por |
|||||||||||||||
| queryType | string |
O tipo de consulta para avaliar consultas com cargas indexadas e criptografadas. Especifique uma das seguintes constantes ClientEncryption:
Esta opção só se aplica e só pode ser especificada quando
|
|||||||||||||||
| rangeOpts | array |
Opções de índice para um campo de criptografia consultável compatível
com consultas "rangePreview". As opções abaixo devem corresponder aos valores definidos
nos
|
Returns the encrypted expression as an object.