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() - Видаляє альтернативне ім'я з документа з ключем