MongoDB\Driver\ClientEncryption::deleteKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::deleteKeyDeletes a key document

Description

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

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

Parameters

keyId

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

Return Values

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

Errors/Exceptions

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top