php8.5
/
Download
Home/ Manual/ driver / clientencryption/ MongoDB\Driver\ClientEncryption::removeKeyAltName

MongoDB\Driver\ClientEncryption::removeKeyAltName

PHP function Edit on GitHub ✎

(mongodb >=1.15.0)

Removes an alternate name from a key document

Description

MongoDB\Driver\ClientEncryption::removeKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): object|null

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

Parameters

keyId

A MongoDB\BSON\Binary instance with subtype 4 (UUID) identifying the key document.

keyAltName

Alternate name to remove from the key document.

Return Values

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

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\RuntimeException on other errors.

See Also

Source: reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml · from the official PHP manual (php/doc-en)