(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
.
Зауваження:
The range algorithm is experimental only. It is not intended for public use.
The extension 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
Параметр | Тип | Опис | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
algorithm | string |
Алгоритм, що потрібно використати. Цей параметр обов'язковий. Дозволено вказувати одну з констант ClientEncryption:
|
||||||||||||||||||
contentionFactor | int |
Фактор конкуренції виконання запитів із індексованим зашифрованим корисним навантаженням.
Цей параметр застосовується тільки, якщо параметр
|
||||||||||||||||||
keyAltName | string |
Визначає назву документа колекції з сховищем ключів за
|
||||||||||||||||||
keyId | MongoDB\BSON\Binary |
Визначає ключ даних за |
||||||||||||||||||
queryType | string |
Тип запиту з індексованим зашифорваним корисним навантаженням. Дозволено вказувати одну з констант ClientEncryption:
Цей параметр застововується тільки, якщо параметр
|
||||||||||||||||||
rangeOpts | array |
Параметри індексу для запиту зашифрованого поля, яке підтримує
"range"-запити. Параметри, що нижче, мають відповідати набору
значень в
|
Returns the encrypted expression as an object.