Flask-SQLAlchemy
SQLAlchemy是一个关系型数据库框架，它提供了高层的 ORM 和底层的原生数据库的操作。flask-sqlalchemy 是一个简化了 SQLAlchemy 操作的flask扩展。
文档地址：http://docs.jinkan.org/docs/flask-sqlalchemy
1、安装及设置
# 安装 flask-sqlalchemy
pip install flask-sqlalchemy
# 如果连接的是 mysql 数据库，需要安装 mysqldb
pip install flask-mysqldb
2、数据库连接设置
app.config[‘SQLALCHEMY_DATABASE_URI‘] = ‘mysql://root:mysql@127.0.0.1:3306/test‘
# oracle://scott:tiger@127.0.0.1:1521/test
# mysql://scott:tiger@localhost/mydatabase
# postgresql://scott:tiger@localhost/mydatabase
# sqlite:////absolute/path/to/foo.db 注意开头四个斜杠
# 动态追踪修改设置，如未设置只会提示警告
app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS‘] = True
#查询时会显示原始SQL语句
app.config[‘SQLALCHEMY_ECHO‘] = True
| 名字 |
备注 |
| SQLALCHEMY_DATABASE_URI |
用于连接的数据库 URI 。例如:sqlite:////tmp/test.dbmysql://username:password@server/db |
| SQLALCHEMY_BINDS |
一个映射 binds 到连接 URI 的字典。 |
| SQLALCHEMY_ECHO |
如果设置为Ture， SQLAlchemy 会记录所有 发给 stderr 的语句，这对调试有用。(打印sql语句) |
| SQLALCHEMY_RECORD_QUERIES |
可以用于显式地禁用或启用查询记录。查询记录 在调试或测试模式自动启用。更多信息见get_debug_queries()。 |
| SQLALCHEMY_NATIVE_UNICODE |
可以用于显式禁用原生 unicode 支持。当使用 不合适的指定无编码的数据库默认值时，这对于 一些数据库适配器是必须的（比如 Ubuntu 上 某些版本的 PostgreSQL ）。 |
| SQLALCHEMY_POOL_SIZE |
数据库连接池的大小。默认是引擎默认值（通常 是 5 ） |
| SQLALCHEMY_POOL_TIMEOUT |
设定连接池的连接超时时间。默认是 10 。 |
| SQLALCHEMY_POOL_RECYCLE |
多少秒后自动回收连接。这对 MySQL 是必要的， 它默认移除闲置多于 8 小时的连接。注意如果 使用了 MySQL ， Flask-SQLALchemy 自动设定 这个值为 2 小时。 |
3、常用的SQLAlchemy字段类型
| 类型名 |
python中类型 |
说明 |
| Integer |
int |
普通整数，一般是32位 |
| SmallInteger |
int |
取值范围小的整数，一般是16位 |
| BigInteger |
int或long |
不限制精度的整数 |
| Float |
float |
浮点数 |
| Numeric |
decimal.Decimal |
普通整数，一般是32位 |
| String |
str |
变长字符串 |
| Text |
str |
变长字符串，对较长或不限长度的字符串做了优化 |
| Unicode |
unicode |
变长Unicode字符串 |
| UnicodeText |
unicode |
变长Unicode字符串，对较长或不限长度的字符串做了优化 |
| Boolean |
bool |
布尔值 |
| Date |
datetime.date |
时间 |
| Time |
datetime.datetime |
日期和时间 |
| LargeBinary |
str |
二进制文件 |
4、常用的SQLAlchemy列选项
| 选项名 |
说明 |
| primary_key |
如果为True，代表表的主键 |
| unique |
如果为True，代表这列不允许出现重复的值 |
| index |
如果为True，为这列创建索引，提高查询效率 |
| nullable |
如果为True，允许有空值，如果为False，不允许有空值 |
| default |
为这列定义默认值 |
5、常用的SQLAlchemy关系选项
| 选项名 |
说明 |
| backref |
在关系的另一模型中添加反向引用 |
| primary join |
明确指定两个模型之间使用的联结条件 |
| uselist |
如果为False，不使用列表，而使用标量值 |
| order_by |
指定关系中记录的排序方式 |
| secondary |
指定多对多关系中关系表的名字 |
| secondary join |
在SQLAlchemy中无法自行决定时，指定多对多关系中的二级联结条件 |
6、数据库基本操作
6.1在视图函数中定义模型类(定义之前需在数据库创建test数据库)
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
#设置连接数据库的URL
app.config[‘SQLALCHEMY_DATABASE_URI‘] = ‘mysql://root:mysql@127.0.0.1:3306/test‘
app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS‘] = True
#查询时会显示原始SQL语句
app.config[‘SQLALCHEMY_ECHO‘] = True
db = SQLAlchemy(app)
class Role(db.Model):
# 定义表名
__tablename__ = ‘roles‘
# 定义列对象
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64), unique=True)
us = db.relationship(‘User‘, backref=‘role‘)
#repr()方法显示一个可读字符串
def __repr__(self):
return ‘Role:%s‘% self.name
class User(db.Model):
__tablename__ = ‘users‘
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(64), unique=True, index=True)
email = db.Column(db.String(64),unique=True)
password = db.Column(db.String(64))
role_id = db.Column(db.Integer, db.ForeignKey(‘roles.id‘))
def __repr__(self):
return ‘User:%s‘%self.name
if __name__ == ‘__main__‘:
app.run(debug=True)
6.2模型之间的关联
一对多
class Role(db.Model):
...
#关键代码
us = db.relationship(‘User‘, backref=‘role‘, lazy=‘dynamic‘)
...
class User(db.Model):
...
role_id = db.Column(db.Integer, db.ForeignKey(‘roles.id‘))
- 其中realtionship描述了Role和User的关系。在此文中，第一个参数为对应参照的类"User"
- 第二个参数backref为类User申明新属性的方法
- 第三个参数lazy决定了什么时候SQLALchemy从数据库中加载数据
- 如果设置为子查询方式(subquery)，则会在加载完Role对象后，就立即加载与其关联的对象，这样会让总查询数量减少，但如果返回的条目数量很多，就会比较慢
- 设置为 subquery 的话，role.users 返回所有数据列表
- 另外,也可以设置为动态方式(dynamic)，这样关联对象会在被使用的时候再进行加载，并且在返回前进行过滤，如果返回的对象数很多，或者未来会变得很多，那最好采用这种方式
- 设置为 dynamic 的话，role.users 返回查询对象，并没有做真正的查询，可以利用查询对象做其他逻辑，比如：先排序再返回结果
多对多
registrations = db.Table(‘registrations‘,
db.Column(‘student_id‘, db.Integer, db.ForeignKey(‘students.id‘)),
db.Column(‘course_id‘, db.Integer, db.ForeignKey(‘courses.id‘))
)
class Course(db.Model):
...
class Student(db.Model):
...
courses = db.relationship(‘Course‘,secondary=registrations,
backref=‘students‘,
lazy=‘dynamic‘)
6.3 常用的SQLAlchemy查询过滤器
| 过滤器 |
说明 |
| filter() |
把过滤器添加到原查询上，返回一个新查询 |
| filter_by() |
把等值过滤器添加到原查询上，返回一个新查询 |
| limit |
使用指定的值限定原查询返回的结果 |
| offset() |
偏移原查询返回的结果，返回一个新查询 |
| order_by() |
根据指定条件对原查询结果进行排序，返回一个新查询 |
| group_by() |
根据指定条件对原查询结果进行分组，返回一个新查询 |
6.4 常用的SQLAlchemy查询执行器
| 方法 |
说明 |
| all() |
以列表形式返回查询的所有结果 |
| first() |
返回查询的第一个结果，如果未查到，返回None |
| first_or_404() |
返回查询的第一个结果，如果未查到，返回404 |
| get() |
返回指定主键对应的行，如不存在，返回None |
| get_or_404() |
返回指定主键对应的行，如不存在，返回404 |
| count() |
返回查询结果的数量 |
| paginate() |
返回一个Paginate对象，它包含指定范围内的结果 |
Flask-SQLAlchemy详解