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.base

class Base

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:

• self (Any)

• kwargs (Any)

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 Repository

Bases: Generic[TRow]

__init__(session_factory, /)

count()

async create(values, /, *, session)

Parameters:

values (dict)

delete()

async find_one(values, /, session, **select_kwargs)

Parameters:

values (dict)

Return type:

TRow

async find_one_by_id(id, /, session=None, **select_kwargs)

Parameters:

id (str)

Return type:

TRow

async find_or_create_one(values, /, session, defaults=None, **select_kwargs)

Parameters:

values (dict)

Return type:

TRow

select()

Type: TRow = None

with_session(f)

Decorates a method to ensure it is called with a sql alchemy session, if it is not, then create one to wrap the call.

Parameters:

f

Returns: