Reference

class frankfurt.Database(dsn: str, models: Optional[List[frankfurt.models.Model]] = None, debug=False, pool_kwargs=None)

Database instance to interact with asyncpg.

models = None

Keep track of all the models defined in this database.

class frankfurt.fields.Action

An enumeration.

class frankfurt.models.Meta(name: str, abstract: bool = False, fields: OrderedDict[str, frankfurt.fields.BaseField] = <factory>, columns: List[str] = <factory>, primary_key: List[str] = <factory>, polymorphic_bases: List[str] = <factory>, polymorphic_on: Union[str, NoneType] = None, polymorphic_identity: Union[Any, NoneType] = None, parents: List[frankfurt.models.BaseModel] = <factory>)

class frankfurt.sql.ColumnClause(data_type: str, constraint: Union[frankfurt.sql.ColumnConstraint, NoneType] = None)

class frankfurt.sql.ColumnConstraint(not_null: bool = False, primary_key: bool = False, references: Union[frankfurt.sql.ColumnConstraintReference, NoneType] = None, unique: bool = False)

class frankfurt.sql.ColumnConstraintReference(reftable: str, refcolumn: Union[str, NoneType] = None, on_delete: Union[str, NoneType] = None, on_update: Union[str, NoneType] = None)

class frankfurt.sql.Command

class frankfurt.sql.ExpressionColumnName(name: str)

class frankfurt.sql.ExpressionLiteralValue(value: Any)

class frankfurt.sql.PartialCreateTable(table_name: str, _columns: Dict[str, frankfurt.sql.ColumnClause] = <factory>, _constraints: List[frankfurt.sql.TableConstraint] = <factory>)

class frankfurt.sql.PartialDelete(table_name: str, mapper: Union[<built-in function callable>, NoneType] = None)

class frankfurt.sql.PartialInsert(table_name: str, mapper: Optional[callable] = None)

Construct an INSERT command and execute it when awaited.

class frankfurt.sql.PartialSelect(table_name: str, mapper: Union[<built-in function callable>, NoneType] = None)

class frankfurt.sql.PartialUpdate(table_name: str, mapper: Union[<built-in function callable>, NoneType] = None)

class frankfurt.sql.ReturningClause(names: List[str] = <factory>)

class frankfurt.sql.ReturningMixin

class frankfurt.sql.SelectClause(names: List[str] = <factory>)

class frankfurt.sql.SelectMixin

class frankfurt.sql.SetClause(values: Dict[str, Any] = <factory>)

class frankfurt.sql.SetMixin

class frankfurt.sql.StatementContext(values: List[Any] = <factory>)

class frankfurt.sql.TableConstraint

class frankfurt.sql.TableConstraintPrimaryKey(keys: List[str] = <factory>)

class frankfurt.sql.ValuesClause(values: Dict[str, Any] = <factory>)

class frankfurt.sql.ValuesMixin

class frankfurt.sql.WhereClause

class frankfurt.sql.WhereClauseAnd(parts: List[frankfurt.sql.WhereClause] = <factory>)

class frankfurt.sql.WhereClauseEquality(lhs: Union[frankfurt.sql.Expression, str], rhs: Union[frankfurt.sql.Expression, str])

class frankfurt.sql.WhereMixin