附录1:主要接口
主要接口说明如下:
create_engine(url, **kwargs)
此方法用于创建新的 Engine 实例。
参数说明如下:
关键字 | 参数说明 |
---|---|
url | 指示数据库和连接参数的字符串 |
case_sensitive | 如果为false,则结果列名称将以不区分大小写的方式匹配 |
connect_args | 将直接传递给DBAPI的选项字典 |
echo=False | 如果为真,引擎将记录所有语句以及 repr() 其参数列表的默认日志处理程序 |
echo_pool=False | 如果为true,则连接池将记录信息输出 |
调用示例见附录2。
ccreate_all(bind=None, tables=None, checkfirst=True)
此方法创建存储在此元数据中的所有表。
参数说明如下:
关键字 | 参数说明 |
---|---|
bind | 用于访问数据库;如果没有,则对此使用现有绑定 MetaData |
tables | 可选列表 Table 对象 |
checkfirst | 默认为true,不为目标数据库中已存在的表发出creates。 |
调用示例见附录2。
drop_all(bind=None, tables=None, checkfirst=True)
此方法根据类创建表。
参数说明如下:
关键字 | 参数说明 |
---|---|
bind | 用于访问数据库;如果没有,则对此使用现有绑定 MetaData |
tables | 可选列表 Table 对象 |
checkfirst | 默认值为true,仅对确认存在于目标数据库中的表发出drops |
调用示例见附录2。
session.add(instance, _warn=True)
此方法将对象放置在 Session 。它的状态将在下次刷新操作时保留到数据库中。
参数说明如下:
关键字 | 参数说明 |
---|---|
instance | 需要添加的实例对象 |
调用示例见附录2。
Session.commit()
刷新挂起的更改并提交当前事务。如果没有正在进行的事务,该方法将首先“自动注册”一个新事务并提交。
调用示例见附录2。
Query.filter(*criterion)
将给定的筛选条件应用于 Query ,使用SQL表达式。
参数说明如下:
关键字 | 参数说明 |
---|---|
criterion | 筛选条件 |
调用示例见附录2。
Query.first()
此方法返回此操作的第一个结果 Query 如果结果不包含任何行,则为“无”。
调用示例见附录2。
Query.all()
此方法返回由此表示的结果 Query 作为一个列表。这将导致执行底层SQL语句。
调用示例见附录2。