MongoDB\Driver\ClientEncryption::getKeyByAltName

MongoDB\Driver\ClientEncryption::getKeyByAltName

Obtiene un documento de clave por un nombre alternativo

Descripción#

php final public MongoDB\Driver\ClientEncryption::getKeyByAltName(string $keyAltName): objectphp

Busca un único documento de clave en la colección de almacén de claves con el nombre alternativo keyAltName proporcionado.

Parámetros#

keyAltName
Nombre alternativo para el documento de clave.

Valores devueltos#

Devuelve el documento de clave, o null si no se encontró ningún documento.

Errores/Excepciones#

Lanza una excepción

MongoDB\Driver\Exception\InvalidArgumentException

en caso de error durante el análisis de un argumento.

Lanza una excepción

MongoDB\Driver\Exception\ConnectionException

si la conexión al servidor falla por una razón distinta a un problema de identificación

Lanza una excepción

MongoDB\Driver\Exception\AuthenticationException

si se requiere una identificación pero falla

Lanza

MongoDB\Driver\Exception\RuntimeException

en caso de otros errores.

Véase también#

MongoDB\Driver\ClientEncryption::addKeyAltName

MongoDB\Driver\ClientEncryption::removeKeyAltName