MongoDB\Driver\ClientEncryption::deleteKey
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::deleteKey — Deletes a key document
Description
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
- 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.
add a note
User Contributed Notes
There are no user contributed notes for this page.
