MongoDB\Driver\ClientEncryption::addKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::addKeyAltName — Añade un nombre alternativo a un documento clave

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

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

keyId: Una instancia MongoDB\BSON\Binary con el subtipo 4 (UUID) que identifica el documento clave.
keyAltName: Nombre alternativo a añadir al documento clave.

Devuelve la versión anterior del documento clave, o null si no se encuentra ningún documento correspondiente.

Lanza una MongoDB\Driver\Exception\InvalidArgumentException en errores de análisis de argumentos.
Lanza una MongoDB\Driver\Exception\ConnectionException si la conexión al servidor falla (por razones diferentes a la autenticación).
Lanza una MongoDB\Driver\Exception\AuthenticationException si la autenticación es necesaria y falla.
Lanza una MongoDB\Driver\Exception\RuntimeException en caso de otros errores.

MongoDB\Driver\ClientEncryption::getKeyByAltName() - Devuelve un documento clave por un nombre alternativo
MongoDB\Driver\ClientEncryption::removeKeyAltName() - Elimina un nombre alternativo de un documento clave

There are no user contributed notes for this page.