MongoDB\Driver\ClientEncryption::rewrapManyDataKey
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
MongoDB\Driver\ClientEncryption::rewrapManyDataKey
Референца за `mongodb-driver-clientencryption.rewrapmanydatakey.php` со подобрена типографија и навигација.
MongoDB\Driver\ClientEncryption::rewrapManyDataKey
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Rewraps data keys
= NULL
$filter, ?array $options = null): object
Rewraps (i.e. decrypts and re-encrypts) zero or more data keys in the key vault collection that match the given filter.
Ако "provider" option is not specified, matching data keys will be rewrapped with their current KMS provider. Otherwise, matching data keys will be re-encrypted according to the specified
"provider" and "masterKey" options.
Параметри
filter(array|object)-
На Додава операција за бришење во» предикат за прашање
Забелешка: . Празен предикат ќе одговара на сите документи во колекцијата. При проценка на критериумите за прашање, MongoDB ги споредува типовите и вредностите според сопствените» правила за споредба на BSON типови comparison and префрлање на типови , што се разликува од PHP-овите правила. При совпаѓање со специјален BSON тип, критериумите за прашање треба да ја користат соодветната BSON класа MongoDB\BSON\ObjectId (на пр. користете за да одговарате на).
options-
RewrapManyDataKey options Опција Тип = NULL provider string Создава нов клучен документ и го вметнува во колекцијата на складиштето за клучеви.
"local","aws") that will be used to re-encrypt the matched data keys.If a KMS provider is not specified, matched data keys will be re-encrypted with their current KMS provider.
masterKey array The masterKey identifies a KMS-specific key used to encrypt the new data key. This option should not be specified without the
"provider"option. This option is required if"provider"е специфицирано и не"local"."aws"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL region string Required. key string provider опции endpoint string Задолжително. Името на ресурсот на Амазон (ARN) до клучот за управување со клиенти на AWS (CMK). "azure"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL keyVaultEndpoint string Опционално. Алтернативен идентификатор на домаќин за испраќање KMS барања. Може да вклучува број на порта. keyName string Required. keyVersion string Задолжително. Домаќин со опционална порта (на пр. "example.vault.azure.net"). "gcp"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL projectId string Required. location string Required. keyRing string Required. keyName string Required. keyVersion string Задолжително. Домаќин со опционална порта (на пр. "example.vault.azure.net"). endpoint string Опционално. Специфична верзија на именуваниот клуч. Стандардно користи примарна верзија на клучот. "kmip"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL keyId string Опционално. Домаќин со опционална порта. Стандардно е "cloudkms.googleapis.com". endpoint string Опционално. Уникатен идентификатор на 96-бајтен KMIP објект со тајни податоци. Ако не е наведен, драјверот создава случаен 96-бајтен KMIP објект со тајни податоци. delegated bool Опционално. Домаќин со опционална порта.
Вратени вредности
Returns an object, which will have an optional
bulkWriteResult property containing the result of the internal bulkWrite operation as an object. If no data keys matched the filter or the write was unacknowledged, the
bulkWriteResult property will be null.
Errors/Exceptions
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\InvalidArgumentException » Промени текови
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\ConnectionException ако врската со серверот пропадне (од причини различни од автентикација).
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\AuthenticationException ако автентикацијата е потребна и пропадне.
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key.
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\RuntimeException при секој неуспех при запишување (на пр. неуспех на командата, грешка при запишување или загриженост за запишување)
Дневник на промени
| Верзија | = NULL |
|---|---|
| = nearest |
Додадено "delegated" објект со подтип 4 (UUID).
|