acapy_agent.storage package

Subpackages

• acapy_agent.storage.vc_holder package
  • Submodules
  • acapy_agent.storage.vc_holder.askar module
  • acapy_agent.storage.vc_holder.base module
    • IterVCRecordSearch
    • VCHolder
      • VCHolder.build_type_or_schema_query()
      • VCHolder.delete_credential()
      • VCHolder.retrieve_credential_by_given_id()
      • VCHolder.retrieve_credential_by_id()
      • VCHolder.search_credentials()
      • VCHolder.store_credential()
    • VCRecordSearch
      • VCRecordSearch.close()
      • VCRecordSearch.fetch()
  • acapy_agent.storage.vc_holder.kanon module
    • KanonVCHolder
      • KanonVCHolder.build_type_or_schema_query()
      • KanonVCHolder.delete_credential()
      • KanonVCHolder.retrieve_credential_by_given_id()
      • KanonVCHolder.retrieve_credential_by_id()
      • KanonVCHolder.search_credentials()
      • KanonVCHolder.store_credential()
    • KanonVCRecordSearch
      • KanonVCRecordSearch.close()
      • KanonVCRecordSearch.fetch()
    • storage_to_vc_record()
    • vc_to_storage_record()
  • acapy_agent.storage.vc_holder.vc_record module
    • VCRecord
      • VCRecord.Meta
      • VCRecord.serialize()
    • VCRecordSchema
      • VCRecordSchema.Meta
  • acapy_agent.storage.vc_holder.xform module
    • storage_to_vc_record()
    • vc_to_storage_record()

Submodules

acapy_agent.storage.askar module

acapy_agent.storage.base module

Abstract base classes for non-secrets storage.

class acapy_agent.storage.base.BaseStorage

Bases: ABC

Abstract stored records interface.

abstractmethod async add_record(record: StorageRecord)

Add a new record to the store.

Parameters:

record – StorageRecord to be stored

abstractmethod async delete_all_records(type_filter: str, tag_query: Mapping | None = None) → None

Remove all records matching a particular type filter and tag query.

Parameters:

• type_filter – The type of records to filter by.

• tag_query – An optional dictionary of tag filter clauses.

abstractmethod async delete_record(record: StorageRecord)

Delete an existing record.

Parameters:

record – StorageRecord to delete

abstractmethod async find_all_records(type_filter: str, tag_query: Mapping | None = None, order_by: str | None = None, descending: bool = False, options: Mapping | None = None) → Sequence[StorageRecord]

Retrieve all records matching a particular type filter and tag query.

Parameters:

• type_filter – The type of records to filter by.

• tag_query – An optional dictionary of tag filter clauses.

• order_by – An optional field by which to order the records.

• descending – Whether to order the records in descending order.

• options – Additional options for the query.

abstractmethod async find_paginated_records(type_filter: str, tag_query: Mapping | None = None, limit: int = 100, offset: int = 0, order_by: str | None = None, descending: bool = False) → Sequence[StorageRecord]

Retrieve a page of records matching a particular type filter and tag query.

Parameters:

• type_filter – The type of records to filter by

• tag_query – An optional dictionary of tag filter clauses

• limit – The maximum number of records to retrieve

• offset – The offset to start retrieving records from

• order_by – An optional field by which to order the records.

• descending – Whether to order the records in descending order.

Returns:

A sequence of StorageRecord matching the filter and query parameters.

async find_record(type_filter: str, tag_query: Mapping | None = None, options: Mapping | None = None) → StorageRecord

Find a record using a unique tag filter.

Parameters:

• type_filter – Filter string

• tag_query – Tags to query

• options – Dictionary of backend-specific options

abstractmethod async get_record(record_type: str, record_id: str, options: Mapping | None = None) → StorageRecord

Fetch a record from the store by type and ID.

Parameters:

• record_type – The record type

• record_id – The record id

• options – A dictionary of backend-specific options

Returns:

A StorageRecord instance

abstractmethod async update_record(record: StorageRecord, value: str, tags: Mapping)

Update an existing stored record’s value and tags.

Parameters:

• record – StorageRecord to update

• value – The new value

• tags – The new tags

class acapy_agent.storage.base.BaseStorageSearch

Bases: ABC

Abstract stored records search interface.

abstractmethod search_records(type_filter: str, tag_query: Mapping | None = None, page_size: int | None = None, options: Mapping | None = None) → BaseStorageSearchSession

Create a new record query.

Parameters:

• type_filter – Filter string

• tag_query – Tags to query

• page_size – Page size

• options – Dictionary of backend-specific options

Returns:

An instance of BaseStorageSearchSession

class acapy_agent.storage.base.BaseStorageSearchSession

Bases: ABC

Abstract stored records search session interface.

async close()

Dispose of the search query.

abstractmethod async fetch(max_count: int | None = None) → Sequence[StorageRecord]

Fetch the next list of results from the store.

Parameters:

max_count – Max number of records to return. If not provided, defaults to the backend’s preferred page size

Returns:

A list of StorageRecord instances

class acapy_agent.storage.base.IterSearch(search: BaseStorageSearchSession, page_size: int | None = None)

Bases: object

A generic record search async iterator.

acapy_agent.storage.base.validate_record(record: StorageRecord, *, delete=False)

Ensure that a record is ready to be saved/updated/deleted.

acapy_agent.storage.error module

Storage-related exceptions.

exception acapy_agent.storage.error.StorageDuplicateError(*args, error_code: str | None = None, **kwargs)

Bases: StorageError

Duplicate record found in storage.

exception acapy_agent.storage.error.StorageError(*args, error_code: str | None = None, **kwargs)

Bases: BaseError

Base class for Storage errors.

exception acapy_agent.storage.error.StorageNotFoundError(*args, error_code: str | None = None, **kwargs)

Bases: StorageError

Record not found in storage.

exception acapy_agent.storage.error.StorageSearchError(*args, error_code: str | None = None, **kwargs)

Bases: StorageError

General exception during record search.

acapy_agent.storage.kanon_storage module

Kanon storage implementation for non-secrets storage.

class acapy_agent.storage.kanon_storage.KanonStorage(session: Profile)

Bases: BaseStorage

Kanon Non-Secrets interface.

async add_record(record: StorageRecord, session: DBStoreSession | None = None)

Add a new record to storage.

async delete_all_records(type_filter: str, tag_query: Mapping | None = None, session: DBStoreSession | None = None)

Delete all records matching the type and tag query.

async delete_record(record: StorageRecord, session: DBStoreSession | None = None)

Delete a record from storage.

async find_all_records(type_filter: str, tag_query: Mapping | None = None, order_by: str | None = None, descending: bool = False, options: Mapping | None = None, session: DBStoreSession | None = None) → Sequence[StorageRecord]

Retrieve all records matching the type and tag query.

async find_paginated_records(type_filter: str, tag_query: Mapping | None = None, limit: int = 100, offset: int = 0, order_by: str | None = None, descending: bool = False) → Sequence[StorageRecord]

Retrieve paginated records using DBStore.scan.

async find_paginated_records_keyset(type_filter: str, tag_query: Mapping | None = None, last_id: int = None, limit: int = 100, order_by: str | None = None, descending: bool = False) → Sequence[StorageRecord]

Retrieve paginated records using DBStore.scan_keyset.

async find_record(type_filter: str, tag_query: Mapping, options: Mapping | None = None, session: DBStoreSession | None = None) → StorageRecord

Find a single record matching the type and tag query.

async get_record(record_type: str, record_id: str, options: Mapping | None = None, session: DBStoreSession | None = None) → StorageRecord

Retrieve a single record by type and ID.

property session: DBStoreSession

Get the database session.

async update_record(record: StorageRecord, value: str, tags: Mapping, session: DBStoreSession | None = None)

Update an existing record’s value and tags.

class acapy_agent.storage.kanon_storage.KanonStorageSearch(profile: Profile)

Bases: BaseStorageSearch

Kanon storage search interface.

search_records(type_filter: str, tag_query: Mapping | None = None, page_size: int | None = None, options: Mapping | None = None) → KanonStorageSearchSession

Search for records.

class acapy_agent.storage.kanon_storage.KanonStorageSearchSession(profile, type_filter: str, tag_query: Mapping, page_size: int | None = None, options: Mapping | None = None)

Bases: BaseStorageSearchSession

Kanon storage search session.

async close()

Close search session.

async fetch(max_count: int | None = None, offset: int | None = None) → Sequence[StorageRecord]

Fetch records.

property handle

Get search handle.

property opened: bool

Check if search is opened.

acapy_agent.storage.record module

Record instance stored and searchable by BaseStorage implementation.

class acapy_agent.storage.record.StorageRecord(type, value, tags: dict | None = None, id: str | None = None)

Bases: StorageRecord

Storage record class.

acapy_agent.storage.type module

Library version information.