« MongoDB\Driver\ClientEncryption
MongoDB\Driver\ClientEncryption::__construct »

MongoDB\Driver\ClientEncryption::addKeyAltName

(mongodb >=1.15.0)

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

説明

final public function 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.

パラメータ

keyId

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

keyAltName

Alternate name to add to the key document.

戻り値

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

エラー / 例外

参考

関連キーワード:
MongoDB   Driver   document   ClientEncryption   alternate   Adds   Throws   Exception   addKeyAltName   keyId   keyAltName   Binary   errors   fails   authentication   construct   mongodb   final   names   given   instance   subtype   identifying   Alternate   previous
関連する関数・ページ:
mongodb-driver-clientencryption.removekeyaltname   mongodb-driver-clientencryption.getkeybyaltname   mongodb-driver-clientencryption.getkey   mongodb-driver-clientencryption.deletekey   mongodb-driver-clientencryption.decrypt   mongodb-driver-clientencryption.getkeys