MongoDB\Driver\ClientEncryption
PHP マニュアル

MongoDB\Driver\ClientEncryption::getKeyByAltName

Gets a key document by an alternate name

説明

final public objectnull MongoDB\Driver\ClientEncryption::getKeyByAltName(string $keyAltName)

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
  • MongoDB\Driver\ClientEncryption::removeKeyAltName