Удаляет альтернативное имя из документа с ключом

# MongoDB\Driver\ClientEncryption::removeKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::removeKeyAltName — Удаляет альтернативное имя из документа с ключом

### Описание

final public function MongoDB\Driver\ClientEncryption::removeKeyAltName(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::addKeyAltName() - Добавляет альтернативное имя к документу с ключом
- MongoDB\Driver\ClientEncryption::getKeyByAltName() - Получает документ с ключом по альтернативному имени

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open