Получает документ с ключом по альтернативному имени

# MongoDB\Driver\ClientEncryption::getKeyByAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::getKeyByAltName — Получает документ с ключом по альтернативному имени

### Описание

final public function MongoDB\Driver\ClientEncryption::getKeyByAltName(string `$keyAltName`): ?object

Находит единственный документ с ключом в коллекции хранилища ключей с заданным альтернативным именем `keyAltName`.

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

`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::removeKeyAltName() - Удаляет альтернативное имя из документа с ключом

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