pt

Pretty Table support. Allow you quickly print query result in ascii table.

from_everything()

中文文档

因为 PrettyTable 只能通过 from_db_cursor 来创建, 也就是说要求返回 ResultProxy, 而不是 ORM 对象的列表. 所以在 from_object(), from_query() 这些使用 session.query(Entity) 的函数中, 我们需要用特殊技巧, 让 session.query 最终返回 ResultProxy.

sqlalchemy_mate.pt.from_text_clause(t: sqlalchemy.sql.elements.TextClause, engine: sqlalchemy.engine.base.Engine, **kwargs) → prettytable.prettytable.PrettyTable[source]

Execute a query in form of texture clause, return the result in form of PrettyTable.

sqlalchemy_mate.pt.from_stmt(stmt: sqlalchemy.sql.selectable.Select, engine: sqlalchemy.engine.base.Engine, **kwargs) → prettytable.prettytable.PrettyTable[source]

Create a prettytable.PrettyTable from sqlalchemy.select.

Parameters

  • sql – a sqlalchemy.sql.selectable.Select object.

  • engine – an sqlalchemy.engine.base.Engine object.

中文文档

将 sqlalchemy 的 sql expression query 结果放入 prettytable 中.

sqlalchemy_mate.pt.from_table(table: sqlalchemy.sql.schema.Table, engine: sqlalchemy.engine.base.Engine, limit: Optional[int] = None, **kwargs) → prettytable.prettytable.PrettyTable[source]

Select data in a database table and put into prettytable.

Create a prettytable.PrettyTable from sqlalchemy.Table.

Parameters

  • table – a sqlalchemy.sql.schema.Table object

  • engine – the engine or session used to execute the query.

  • limit – int, limit rows to return.

中文文档

将数据表中的数据放入 PrettyTable 中.

sqlalchemy_mate.pt.from_model(orm_class, engine_or_session: Union[sqlalchemy.engine.base.Engine, sqlalchemy.orm.session.Session], limit: Optional[int] = None, **kwargs)[source]

Select data from the table defined by a ORM class, and put into prettytable

Parameters

  • orm_class – an orm class inherit from sqlalchemy.ext.declarative.declarative_base()

  • engine_or_session – the engine or session used to execute the query.

  • limit – int, limit rows to return.

中文文档

将数据对象的数据放入 PrettyTable 中.

常用于快速预览某个对象背后的数据.

sqlalchemy_mate.pt.from_dict_list(data: List[dict]) → prettytable.prettytable.PrettyTable[source]

Construct a Prettytable from list of dictionary.

sqlalchemy_mate.pt.from_everything(everything: Union[sqlalchemy.sql.elements.TextClause, sqlalchemy.sql.selectable.Select, sqlalchemy.sql.schema.Table, List[dict], sqlalchemy.orm.decl_api.DeclarativeMeta], engine_or_session: Optional[Union[sqlalchemy.engine.base.Engine, sqlalchemy.orm.session.Session]] = None, limit: Optional[int] = None, **kwargs)[source]

Construct a Prettytable from any kinds of sqlalchemy query.

Return type

PrettyTable

Usage:

from sqlalchemy import select

sql = select([t_user])
print(from_everything(sql, engine))

query = session.query(User)
print(from_everything(query, session))

session.query(User)