MongoDB\Driver\ClientEncryption::encrypt

Список параметров

value

Значение для шифрования. Метод может зашифровать любые данные, которые могут быть записаны в MongoDB.

options

Encryption options

Опция	Тип	Описание
algorithm	string	Алгоритм шифрования, который будет использоваться. Опция обязательна. Укажите одну из следующих констант ClientEncryption: MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE
contentionFactor	int	Коэффициент конкуренции для оценки запросов с индексированными зашифрованными полезными нагрузками. Опция применяется и может быть указана только тогда, когда опция algorithm равна MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED или MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
keyAltName	string	Идентифицирует документ коллекции хранилища ключей по keyAltName. Опция является взаимоисключающей с keyId и требуется ровно один.
keyId	MongoDB\BSON\Binary	Идентифицирует ключ данных по _id. Значением является UUID (двоичный подтип 4). Опция является взаимоисключающей с keyAltName и требуется ровно один.
queryType	string	Тип запроса для оценки запросов с индексированными, зашифрованными полезными нагрузками. Укажите одну из следующих констант ClientEncryption: MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE Опция применяется и может быть указана только тогда, когда опция algorithm равна MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED или MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
rangeOpts	array	Опции индекса для шифруемого поля с поддержкой запросов «range». Параметры, которые приводят следующие абзацы, должны соответствовать значениям, которые установили в параметре encryptedFields целевой коллекции. Для BSON-полей с типом double и decimal128 требуется либо установить все опции min, max и precision, либо все отключить. Опции индекса диапазона Опция Тип Описание min mixed Обязательна, если опцию precision установили. Минимальное BSON-значение в диапазоне. max mixed Обязательна, если опцию precision установили. Максимальное BSON-значение в диапазоне. sparsity int Обязательна. Положительное 64-битное целое число. precision int Небязательна. Положительное 32-битное целое число, которое указывает точность для явного шифрования. Разрешается устанавливать только для BSON-полей с типом double или decimal128. trimFactor int Обязательна. Положительное 32-битное целое число.