MongoDB\Driver\ClientEncryption::getKey

(mongodb >=1.15.0)

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

説明

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.

パラメータ

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

戻り値

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

エラー / 例外

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.

関連キーワード:

MongoDB Driver document ClientEncryption Throws Exception Gets getKey keyId Binary errors fails authentication encryptExpression getKeyByAltName mongodb final Finds single vault collection given instance subtype identifying

関連する関数・ページ:

mongodb-driver-clientencryption.deletekey mongodb-driver-clientencryption.getkeybyaltname mongodb-driver-clientencryption.addkeyaltname mongodb-driver-clientencryption.removekeyaltname mongodb-driver-clientencryption.getkeys mongodb-driver-clientencryption.decrypt