harp_apps.storage.types.storage

class IStorage

Bases: Protocol

__init__(*args, **kwargs)

async create_users_once_ready(users)

Create users.

Parameters:

users (Iterable[str])

async finalize()

Coroutine function to finalize the instance. Should release resources, close files etc… The caller should make sure to call finalize on all cases where the instance is not needed anymore to get a clean shutdown.

async get_facet_meta(name)

Retrieve a facet’s metadata, by name.

async get_transaction(id, *, username)

Find a transaction, by id.

Parameters:

• id (str)

• username (str)

async get_transaction_list(*, username, with_messages=False, filters=None, page=1, cursor='', text_search='')

Find transactions, using optional filters, for example to be displayed in the dashboard.

Parameters:

• username (str)

• page (int)

• cursor (str)

• text_search (str)

async get_usage()

Get storage usage.

async initialize()

Coroutine function to initialize the instance.

async set_user_flag(*, transaction_id, username, flag, value=True)

Sets or unsets a user flag on a transaction.

Parameters:

• transaction_id (str)

• username (str)

• flag (int)

async transactions_grouped_by_time_bucket(*, endpoint, time_bucket, start_datetime)

Parameters:

• endpoint (str | None)

• time_bucket (str)

• start_datetime (datetime)

Return type:

list[TransactionsGroupedByTimeBucket]