MongoDB\Driver\ClientEncryption::removeKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::removeKeyAltName — Removes an alternate name from a key document

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

Removes keyAltName from the set of alternate names for the key document with the given UUID keyId.

keyId: A MongoDB\BSON\Binary instance with subtype 4 (UUID) identifying the key document.
keyAltName: Alternate name to remove from the key document.

Returns the previous version of the key document, or null if no document matched.

Lança MongoDB\Driver\Exception\InvalidArgumentException no caso de erros ao interpretar parâmetros.
Lança MongoDB\Driver\Exception\ConnectionException se a conexão com o servidor falhar (por razões outras que autenticação).
Lança MongoDB\Driver\Exception\AuthenticationException se a autenticação é necessária e falha.
Throws MongoDB\Driver\Exception\RuntimeException on other errors.

There are no user contributed notes for this page.