MongoDB\Driver\ClientEncryption::addKeyAltName
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::addKeyAltName — Добавляет альтернативное имя к документу с ключом
Описание
final public MongoDB\Driver\ClientEncryption::addKeyAltName(MongoDB\BSON\Binary
$keyId, string $keyAltName): ?object
Добавляет параметр keyAltName в набор альтернативных имён
для документа с ключом с заданным UUID keyId.
Список параметров
-
keyId -
Экземпляр MongoDB\BSON\Binary с подтипом 4 (UUID), идентифицирующий документ с ключом.
-
keyAltName -
Альтернативное имя для добавления в документ с ключом.
Возвращаемые значения
Возвращает предыдущую версию документа с ключом или null,
если ни один документ не был найден.
Ошибки
- При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.
- При неудачном соединении с сервером (кроме ошибок аутентификации), бросает исключение MongoDB\Driver\Exception\ConnectionException.
- При неудачной аутентификации бросает исключение MongoDB\Driver\Exception\AuthenticationException.
- Выбрасывает исключение MongoDB\Driver\Exception\RuntimeException в случае возникновения прочих ошибок.
Смотрите также
- MongoDB\Driver\ClientEncryption::getKeyByAltName() - Получает документ с ключом по альтернативному имени
- MongoDB\Driver\ClientEncryption::removeKeyAltName() - Удаляет альтернативное имя из документа с ключом
add a note
User Contributed Notes
There are no user contributed notes for this page.
