Flask-SQLAlchemy操作数据库

python编程快速上手（持续更新中…）

---

Flask-SQLAlchemy扩展

SQLALchemy 实际上是对数据库的抽象，让开发者不用直接和 SQL 语句打交道，而是通过 Python 对象来操作数据库，在舍弃一些性能开销的同时，换来的是开发效率的较大提升

SQLAlchemy是一个关系型数据库框架，它提供了高层的ORM和底层的原生数据库的操作。flask-sqlalchemy是一个简化了SQLAlchemy操作的flask扩展。

安装 flask-sqlalchemy

pip install flask-sqlalchemy

如果连接的是mysql数据库,需要安装mysqldb

pip install flask-mysqldb

使用Flask-SQLAlchemy管理数据库

在Flask-SQLAlchemy中，数据库使用URL指定，而且程序使用的数据库必须保存到Flask配置对象的SQLALCHEMY_DATABASE_URI键中。

Flask的数据库设置：

app.config[‘SQLALCHEMY_DATABASE_URI’] = ‘mysql://root:[email protected]:3306/test’

其他设置：

#动态追踪修改设置，如未设置只会提示警告, 不建议开启
app.config[‘SQLALCHEMY_TRACK_MODIFICATIONS’] = False# 查询时会显示原始SQL语句
app.config[‘SQLALCHEMY_ECHO’] = True

名字	备注
SQLALCHEMY_DATABASE_URI	用于连接的数据库 URI 。例如:sqlite:tmp/test.dbmysql://username:password@server/db
SQLALCHEMY_BINDS	一个映射 binds 到连接 URI 的字典。更多 binds 的信息见用 Binds 操作多个数据库。
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 小时。

常用的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	二进制文件

常用的SQLAlchemy列选项

选项名	说明
primary_key	如果为True，代表表的主键
unique	如果为True，代表这列不允许出现重复的值
index	如果为True，为这列创建索引，提高查询效率
nullable	如果为True，允许有空值，如果为False，不允许有空值
default	为这列定义默认值

常用的SQLAlchemy关系选项

选项名	说明
backref	在关系的另一模型中添加反向引用
primary join	明确指定两个模型之间使用的联结条件
uselist	如果为False，不使用列表，而使用标量值
order_by	指定关系中记录的排序方式
secondary	指定多对多中记录的排序方式
secondary join	在SQLAlchemy中无法自行决定时，指定多对多关系中的二级联结条件

增删改操作

1. 基本概念

在Flask-SQLAlchemy中，插入、修改、删除操作，均由数据库会话管理。

会话用db.session表示。在准备把数据写入数据库前，要先将数据添加到会话中然后调用 commit() 方法提交会话。

在Flask-SQLAlchemy中，查询操作是通过query对象操作数据。

最基本的查询是返回表中所有数据，可以通过过滤器进行更精确的数据库查询。
db.session.add(role) 添加到数据库的session中
db.session.add_all([user1, user2]) 添加多个信息到session中
db.session.commit() 提交数据库的修改(包括增/删/改)
db.session.rollback() 数据库的回滚操作
db.session.delete(user) 删除数据库(需跟上commit)

2.在视图函数中定义模型类

from flask import Flaskfrom flask_sqlalchemy import SQLAlchemy


app = Flask(__name__)
#设置连接数据库的URL
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:[email protected]:3306/Flask_test'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False#查询时会显示原始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(32), unique=True)
    user = db.relationship('User', backref='role')

    #repr()方法显示一个可读字符串
    def __repr__(self):
        return '' % (self.name, self.id)
class User(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(32), unique=True, index=True)
    email = db.Column(db.String(32),unique=True)
    password = db.Column(db.String(32))
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

    def __repr__(self):
        return '' % (self.name, self.id, self.email, self.password)
if __name__ == '__main__':

    # 创建表：
    db.create_all()
    # 删除表
    db.drop_all()

    app.run(debug=True)

数据的增删改

```python
# 进入ipython一次执行
In [1]: from demo3_sqlalchemy import *

# 添加一条Role数据
In [2]: role = Role(name='admin')
In [3]: db.session.add(role)
In [4]: db.session.commit()

# 添加一条User数据, 数据有误可以使用回滚, 将add的对象从session移除
In [5]: user = User(name='zhangsan')
In [6]: db.session.add(user)
In [7]: db.session.rollback()
In [9]: user.role_id = 1
In [6]: db.session.add(user)
In [4]: db.session.commit()

# 修改数据
In [13]: user.name = 'lisi'
In [14]: db.session.commit()

# 删除数据
In [16]: db.session.delete(user)
In [17]: db.session.commit()

3 模型之间的关联

class Role(db.Model):
...#关键代码
user = db.relationship('User', backref='role')
...
class User(db.Model):
...
role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

其中realtionship描述了Role和User的关系。在此文中，第一个参数为对应参照的类"User"

第二个参数backref为类User申明新属性的方法

In [1]: from demo3_sqlalchemy import *

In [2]: role = Role(name='admin')

In [3]: db.session.add(role)

In [4]: db.session.commit()

In [5]: user1 = User(name='zs', role_id=role.id)

In [6]: user2 = User(name='ls', role_id=role.id)

In [7]: db.session.add_all([user1, user2])

In [8]: db.session.commit()


# 此时就可以通过角色直接查询到用户信息
In [9]: role.users
Out[9]: [, ]

# 此时就可以通过用户直接查询到角色信息
In [10]: user1.role
Out[10]: 

In [11]: user2.role
Out[11]: 

# 此时就可以通过角色直接查询到用户信息

查询操作

1 常用的SQLAlchemy查询过滤器

过滤器	说明
filter()	把过滤器添加到原查询上，返回一个新查询
filter_by()	把等值过滤器添加到原查询上，返回一个新查询
limit	使用指定的值限定原查询返回的结果
offset()	偏移原查询返回的结果，返回一个新查询
order_by()	根据指定条件对原查询结果进行排序，返回一个新查询
group_by()	根据指定条件对原查询结果进行分组，返回一个新查询

2 常用的SQLAlchemy查询执行器

方法	说明
all()	以列表形式返回查询的所有结果
first()	返回查询的第一个结果，如果未查到，返回None
first_or_404()	返回查询的第一个结果，如果未查到，返回404
get()	返回指定主键对应的行，如不存在，返回None
get_or_404()	返回指定主键对应的行，如不存在，返回404
count()	返回查询结果的数量
paginate()	返回一个Paginate对象，它包含指定范围内的结果

3. 示例

3.1 插入角色数据

ro1 = Role(name=‘admin’)
db.session.add(ro1)
db.session.commit()
#再次插入一条数据
ro2 = Role(name=‘user’)
db.session.add(ro2)
db.session.commit()

3.2 一次插入多条数据

us1 = User(name=‘wang’,email=‘[email protected]’,password=‘123456’,role_id=ro1.id)
us2 = User(name=‘zhang’,email=‘[email protected]’,password=‘201512’,role_id=ro2.id)
us3 = User(name=‘chen’,email=‘[email protected]’,password=‘987654’,role_id=ro2.id)
us4 = User(name=‘zhou’,email=‘[email protected]’,password=‘456789’,role_id=ro1.id)
us5 = User(name=‘tang’,email=‘[email protected]’,password=‘158104’,role_id=ro2.id)
us6 = User(name=‘wu’,email=‘[email protected]’,password=‘5623514’,role_id=ro2.id)
us7 = User(name=‘qian’,email=‘[email protected]’,password=‘1543567’,role_id=ro1.id)
us8 = User(name=‘liu’,email=‘[email protected]’,password=‘867322’,role_id=ro1.id)
us9 = User(name=‘li’,email=‘[email protected]’,password=‘4526342’,role_id=ro2.id)
us10 = User(name=‘sun’,email=‘[email protected]’,password=‘235523’,role_id=ro2.id)
db.session.add_all([us1,us2,us3,us4,us5,us6,us7,us8,us9,us10])
db.session.commit()

2.3 查询演练
完成以下查询

1. 查询所有用户数据
2. 查询有多少个用户
3. 查询第1个用户
4. 查询id为4的用户[3种方式]

1. 查询所有用户数据# all()返回查询到的所有对象
   User.query.all()

2. 查询有多少个用户
   User.query.count()

3. 查询第1个用户
   User.query.first()

4. 查询id为4的用户[3种方式]# filter_by直接用属性名，比较用=, filter用类名.属性名，比较用># filter_by用于查询简单的列名，不支持比较运算符# filter比filter_by的功能更强大，支持>>比>较运算符，支持or_、in_等语法。
   User.query.get(4)
   User.query.filter_by(id=4).first() #属性 =
   User.query.filter(User.id4).first() #对象名.属性 ==
   User.query.filter_by(id=4).first() #属性 =