rwskit.sqlalchemy

Utilities for working with SqlAlchemy.

Attributes

log
B	A type extending DeclarativeBase.
SqlOperator	The supported SQL operators for use in an SqlBinaryExpression.

Classes

BaseModel	A base class for creating declarative SqlAlchemy models from.
SqlBinaryExpression	A class that represents the basic binary expression for an SQL column.
SqlSelectionCriteria	A class that represents a conjunction of SqlBinaryExpression.

Module Contents

rwskit.sqlalchemy.log

rwskit.sqlalchemy.B

A type extending DeclarativeBase.

rwskit.sqlalchemy.SqlOperator

The supported SQL operators for use in an SqlBinaryExpression.

class rwskit.sqlalchemy.BaseModel

Bases: sqlalchemy.orm.DeclarativeBase

A base class for creating declarative SqlAlchemy models from.

This class provides functionality for finding any model derived from this clas by their table name.

__abstract__ = True

__tablename__()

classmethod find_by_table_name(table_name: str) → Type[BaseModel] | None

Find a model derived from this class by its table name.

Parameters:

table_name (str) – The name of the table whose model class you want to find.

Returns:

Returns the model class if the table is found, otherwise None.

Return type:

Type[FindByNameBase], optional

class rwskit.sqlalchemy.SqlBinaryExpression

Bases: rwskit.config.YamlConfig

A class that represents the basic binary expression for an SQL column.

column: str

The column name.

operator: SqlOperator

The operator to compare the column and value with.

value: Any

The value used as a comparison.

__post_init__()

__call__(model_or_table: Type[B] | sqlalchemy.Table) → sqlalchemy.BinaryExpression

to_expression(model_or_table: Type[B] | sqlalchemy.Table) → sqlalchemy.BinaryExpression

Return a clause that can be used with an SqlAlchemy where statement.

Parameters:

model_or_table (sqlalchemy.Table) – The table object that contains the column.

Returns:

The corresponding SqlAlchemy binary expression.

Return type:

BinaryExpression

class rwskit.sqlalchemy.SqlSelectionCriteria

Bases: rwskit.config.YamlConfig

A class that represents a conjunction of SqlBinaryExpression.

expressions: list[SqlBinaryExpression]

The list of binary expressions that will be used to filter the query.

__post_init__()

to_conjunction(table: sqlalchemy.Table) → sqlalchemy.BinaryExpression | sqlalchemy.BooleanClauseList

Return a conjunction of binary expressions that can be used with an SqlAlchemy where statement.