MongoDB\Driver\ClientEncryption::deleteKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::deleteKey — Deletes a key document

説明

final public function MongoDB\Driver\ClientEncryption::deleteKey(MongoDB\BSON\Binary $keyId): object

Removes the key document with the given UUID keyId from the key vault collection.

パラメータ

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

戻り値

Returns the result of the internal deleteOne operation on the key vault collection.

エラー / 例外

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).
Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.
Throws MongoDB\Driver\Exception\RuntimeException on other errors.

関連キーワード:

MongoDB Driver ClientEncryption document Throws Exception Deletes deleteKey keyId Binary vault collection errors fails authentication decrypt encrypt mongodb final Removes given instance subtype identifying internal

関連する関数・ページ:

mongodb-driver-clientencryption.getkey mongodb-driver-clientencryption.removekeyaltname mongodb-driver-clientencryption.decrypt mongodb-driver-clientencryption.addkeyaltname mongodb-driver-clientencryption.getkeys mongodb-driver-clientencryption.getkeybyaltname