IDataStoreORM interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This is the default query interface for the credential data stored by a Veramo agent.

Plugins implementing this interface are expected to implement this simple query functionality to filter the data that was saved using IDataStore.

If this interface is implemented by a different plugin than IDataStore, then both plugins MUST use the same media for data storage.

Signature:

export interface IDataStoreORM extends IPluginMethodMap

Extends: IPluginMethodMap

Methods

Method	Description
dataStoreORMGetIdentifiers(args, context)	(BETA) Tries to obtain a list of IIdentifiers that match the given filter. The origin of these identifiers is from any credential / presentation or message that was successfully processed by this agent. If the same database is used for implementations of AbstractDIDStore, then these identifiers can also come from didManagerCreate or didManagerImport operations.
dataStoreORMGetIdentifiersCount(args, context)	(BETA) Tries to obtain a count of IIdentifiers that match the given filter. The origin of these identifiers is from any credential / presentation or message that was successfully processed by this agent. If the same database is used for implementations of AbstractDIDStore, then these identifiers can also come from didManagerCreate or didManagerImport operations.
dataStoreORMGetMessages(args, context)	(BETA) Returns a list of IMessages that match the given filter. These are messages that were stored using dataStoreSaveMessage.
dataStoreORMGetMessagesCount(args, context)	(BETA) Returns a count of IMessages that match the given filter. These are messages that were stored using dataStoreSaveMessage.
dataStoreORMGetVerifiableCredentials(args, context)	(BETA) Returns a list of UniqueVerifiableCredentials that match the given filter based on the top level properties of a credential. These are VerifiableCredentials that were stored using dataStoreSaveVerifiableCredential.
dataStoreORMGetVerifiableCredentialsByClaims(args, context)	(BETA) Returns a list of UniqueVerifiableCredentials that match the given filter based on the claims they contain. These are VerifiableCredentials that were stored using dataStoreSaveVerifiableCredential.
dataStoreORMGetVerifiableCredentialsByClaimsCount(args, context)	(BETA) Returns a count of UniqueVerifiableCredentials that match the given filter based on the claims they contain. These are VerifiableCredentials that were stored using dataStoreSaveVerifiableCredential.
dataStoreORMGetVerifiableCredentialsCount(args, context)	(BETA) Returns a count of UniqueVerifiableCredentials that match the given filter based on the top level properties of a credential. These are VerifiableCredentials that were stored using dataStoreSaveVerifiableCredential.
dataStoreORMGetVerifiablePresentations(args, context)	(BETA) Returns a list of UniqueVerifiablePresentations that match the given filter based on the top level properties of a presentation. These are VerifiablePresentations that were stored using dataStoreSaveVerifiablePresentation.
dataStoreORMGetVerifiablePresentationsCount(args, context)	(BETA) Returns a count of UniqueVerifiablePresentations that match the given filter based on the top level properties of a presentation. These are VerifiablePresentations that were stored using dataStoreSaveVerifiablePresentation.