MongoDB\Driver\ClientEncryption::addKeyAltName

MongoDB\Driver\ClientEncryption::addKeyAltName

Añade un nombre alternativo a un documento de clave

Descripción#

php final public MongoDB\Driver\ClientEncryption::addKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): objectphp

Añade keyAltName al conjunto de nombres alternativos para el documento de clave con el UUID dado keyId.

Parámetros#

keyId
Una instancia de MongoDB\BSON\Binary con subtipo 4 (UUID) que identifica el documento de clave.

keyAltName
Nombre alternativo que se añadirá al documento de clave.

Valores devueltos#

Devuelve la versión anterior del documento de clave, o null si no se encontró ningún documento coincidente.

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::getKeyByAltName

MongoDB\Driver\ClientEncryption::removeKeyAltName