MongoDB\Driver\ClientEncryption::addKeyAltName
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::addKeyAltName — Adds an alternate name to a key document
Description
final public MongoDB\Driver\ClientEncryption::addKeyAltName(MongoDB\BSON\Binary
$keyId, string $keyAltName): ?object
Adds keyAltName to the set of alternate names for the
key document with the given UUID keyId.
Liste de paramètres
-
keyId -
A MongoDB\BSON\Binary instance with subtype 4 (UUID) identifying the key document.
-
keyAltName -
Alternate name to add to the key document.
Valeurs de retour
Returns the previous version of the key document, or null if no document
matched.
Erreurs / Exceptions
- Lance une exception MongoDB\Driver\AuthenticationException si une identification est nécessaire mais qu'elle échoue
- Lance une exception MongoDB\Driver\ConnectionException si la connexion au serveur échoue pour une autre raison qu'en raison d'un problème d'identification
- Throws MongoDB\Driver\Exception\RuntimeException on other errors.
Voir aussi
- MongoDB\Driver\ClientEncryption::getKeyByAltName() - Gets a key document by an alternate name
- MongoDB\Driver\ClientEncryption::removeKeyAltName() - Removes an alternate name from a key document
add a note
User Contributed Notes
There are no user contributed notes for this page.
