Documentación offline PHP master

MongoDB\Driver\ClientEncryption::deleteKey

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

MongoDB\Driver\ClientEncryption::deleteKey

Elimina un documento de clave

Descripción#

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

Elimina el documento de clave con el UUID keyId dado de la colección de almacén de claves.

Parámetros#

keyId
Una instancia de MongoDB\BSON\Binary con subtipo 4 (UUID) que identifica el documento de clave.

Valores devueltos#

Devuelve el resultado de la operación interna deleteOne en la colección de almacén de claves.

Errores/Excepciones#

Lanza una excepción

MongoDB\Driver\Exception\InvalidArgumentException

en caso de error durante el análisis de un argumento.

Lanza una excepción

MongoDB\Driver\Exception\ConnectionException

si la conexión al servidor falla por una razón distinta a un problema de identificación

Lanza una excepción

MongoDB\Driver\Exception\AuthenticationException

si se requiere una identificación pero falla

Lanza

MongoDB\Driver\Exception\RuntimeException

en caso de otros errores.