MongoDB\Driver\ClientEncryption::addKeyAltName

    (mongodb >=1.15.0)

    MongoDB\Driver\ClientEncryption::addKeyAltName — Adds an alternate name to a key document

    Description

    finalpublicMongoDB\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.

    Parameters

    keyId

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

    keyAltName

    Alternate name to add to the key document.

    Return Values

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

    Errors/Exceptions

    See Also

    To Top