MongoDB\Driver\ClientEncryption
PHP Manual

MongoDB\Driver\ClientEncryption::getKey

Gets a key document

Description

final public objectnull MongoDB\Driver\ClientEncryption::getKey(MongoDB\BSON\Binary $keyId)

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

  • 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.