Overview
KB
Technical FAQ
PHP Manual
CSS2 Manual
HTML Manual
JS Guide
JS Reference
PhpDock Manual
Nu-Coder Manual
PhpExpress Manual
PHP Joomla
Development
Learn PHP
 
<MongoDB\Driver\ClientEncryption::encryptExpressionMongoDB\Driver\ClientEncryption::getKeyByAltName>
^MongoDB\Driver\ClientEncryptionLast updated: Mon, 26 Oct 2026

MongoDB\Driver\ClientEncryption::getKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::getKey — Gets a key document

Description

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

Finds a single key document in the key vault collection with the given UUID keyId.

Parameters

keyId

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

Return Values

Returns the key document, or null if no document matched.

Errors/Exceptions


<MongoDB\Driver\ClientEncryption::encryptExpressionMongoDB\Driver\ClientEncryption::getKeyByAltName>
^MongoDB\Driver\ClientEncryptionLast updated: Mon, 26 Oct 2026