PHP Manual
MongoDB\Driver\ClientEncryption
Gets a key document by an alternate name

MongoDB\Driver\ClientEncryption::getKeyByAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::getKeyByAltName — Gets a key document by an alternate name

説明

final public function MongoDB\Driver\ClientEncryption::getKeyByAltName(string $keyAltName): ?object

Finds a single key document in the key vault collection with the given alternate name keyAltName.

パラメータ

keyAltName: Alternate name for 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\ClientEncryption::addKeyAltName() - Adds an alternate name to a key document
MongoDB\Driver\ClientEncryption::removeKeyAltName() - Removes an alternate name from a key document

関連キーワード:

MongoDB Driver document ClientEncryption alternate Throws Exception Gets getKeyByAltName keyAltName errors fails authentication getKey getKeys mongodb final Finds single vault collection given Alternate matched InvalidArgumentException

関連する関数・ページ:

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