Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

harp_apps.sqlalchemy_storage.models

class Base[source]

Bases: AsyncAttrs, DeclarativeBase

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

Parameters:
Return type:

None

metadata: ClassVar[MetaData] = MetaData()

Refers to the _schema.MetaData collection that will be used for new _schema.Table objects.

See also

orm_declarative_metadata

registry: ClassVar[_RegistryType] = <sqlalchemy.orm.decl_api.registry object>

Refers to the _orm.registry in use where new _orm.Mapper objects will be associated.

class Blob[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

content_type
created_at
data
id
class BlobsRepository[source]

Bases: Repository[Blob]

Type

alias of Blob

count_orphans()[source]
async create(values, /, *, session)[source]
Parameters:

values (dict | Blob)

delete_orphans()[source]
class FlagsRepository[source]

Bases: Repository

Type

alias of UserFlag

class Message[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

classmethod from_models(transaction, message, headers, content)[source]
to_model()[source]
body
created_at
headers
id
kind
summary
transaction: Mapped[Transaction]
transaction_id
class MessagesRepository[source]

Bases: Repository[Message]

Type

alias of Message

async create(values, /, *, session)[source]
Parameters:

values (dict | Message)

class Metric[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id
name
class MetricValue[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

created_at
metric: Mapped[Metric]
metric_id
value
class MetricValuesRepository[source]

Bases: Repository[MetricValue]

Type

alias of MetricValue

class MetricsRepository[source]

Bases: Repository[Metric]

Type

alias of Metric

__init__(session_factory, /)[source]
async insert_values(values, /, session)[source]
Parameters:

values (dict)

class Tag[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id
name
class TagValue[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id
tag: Mapped[Tag]
tag_id
value
class TagValuesRepository[source]

Bases: Repository[TagValue]

Type

alias of TagValue

class TagsRepository[source]

Bases: Repository[Tag]

Type

alias of Tag

class Transaction[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

to_model(with_user_flags=False)[source]
elapsed
endpoint
finished_at
flags: Mapped[List[UserFlag]]
id
messages: Mapped[List[Message]]
started_at
property tags
tpdex
type
x_cached
x_method
x_no_cache
x_status_class
class TransactionsRepository[source]

Bases: Repository[Transaction]

Type

alias of Transaction

__init__(session_factory, /, tags=None, tag_values=None)[source]
async create(values, /, *, session=None)[source]
Parameters:

values (dict | Transaction)

delete_old(old_after)[source]
Parameters:

old_after (timedelta)

select(*, with_messages=False, with_user_flags=False, with_tags=False)[source]
async set_tags(transaction, tags, /, *, session=None)[source]
Parameters:
class User[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

flags: Mapped[List[UserFlag]]
id
username
class UserFlag[source]

Bases: Base

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id
transaction: Mapped[Transaction]
transaction_id
type
user: Mapped[User]
user_id
class UsersRepository[source]

Bases: Repository

Type

alias of User

async find_one_by_username(username)[source]
Parameters:

username (str)

Return type:

User

Submodules