MongoDB\Driver\ClientEncryption::decrypt

Decrypt a value

Description

final public mixed MongoDB\Driver\ClientEncryption::decrypt(MongoDB\BSON\Binary $value)

Decrypts the value.

Parameters

value

A MongoDB\BSON\Binary instance with subtype 6 containing the encrypted value.

Return Values

Returns the decrypted value as it was passed to MongoDB\Driver\ClientEncryption::encrypt.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
  • Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting the value

See Also

  • MongoDB\Driver\ClientEncryption::encrypt