Edit Report a Bug

    MongoDB\Driver\ClientEncryption::getKey

    (mongodb >=1.15.0)

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

    Description

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

    Finds a single key document in the key vault collection with the given UUID keyId.

    Liste de paramètres

    keyId

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

    Valeurs de retour

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

    Erreurs / Exceptions

    • Lance une exception MongoDB\Driver\AuthenticationException si une identification est nécessaire mais qu'elle échoue
    • Lance une exception MongoDB\Driver\ConnectionException si la connexion au serveur échoue pour une autre raison qu'en raison d'un problème d'identification
    • Throws MongoDB\Driver\Exception\RuntimeException on other errors.
    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top