MongoDB\Driver\ClientEncryption::addKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::addKeyAltName — Ajoute un nom alternatif à un document clé

Description

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

Ajoute keyAltName à l'ensemble des noms alternatifs pour le document clé avec l'UUID donné keyId.

Liste de paramètres

keyId
Une instance MongoDB\BSON\Binary avec le sous-type 4 (UUID) identifiant le document clé.
keyAltName
Nom alternatif à ajouter au document clé.

Valeurs de retour

Renvoie la version précédente du document clé, ou null si aucun document correspondant n'a été trouvé.

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
  • Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs.

Voir aussi