Flask使用SQLAlchemy实现持久化数据

项目引入flask-sqlalchemy

首先，安装flask-sqlalchemy扩展：

$pip install flask-sqlalchemy

然后，在项目中导入SQLAlchemy类，并实例化应用程序使用的数据库(以mysql为例)：

from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://account:password@hostname/database'
db = SQLAlchemy(app)

db对象是SQLAlchemy类的实例，表示程序使用的数据库，同时还获得了Flask-SQLAlchemy提供的所有功能。

ORM简介及模型定义

在Python中，可以使用数据库相应的包直接操作数据库，如PyMySQL操作MySQL数据库，还有一些数据库抽象层代码包供选择，如这里要讨论的SQLAlchemy。该抽象包直接处理高等级的Python对象，而不用处理如表这样的数据库实体。
抽象层，就是所谓的对象关系映射（ORM），其最大的优势就是：能在用户不知觉的情况下把高层的面向对象操作转换成低层的数据库指令，极大简化代码编写。SQLAlchemy就是已与Flask很好集成的更高层抽象例子，其还支持多种关系型数据库引擎。

基于SQLAlchemy的模型定义：

class Roles(db.Model):
    __tablename__ = 'roles'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), unique=True)
    users = db.relationship('Users', backref='role')

class Users(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(64), unique=True, index=True)
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

__tablename__定义在数据库中使用的表名；

db.Column类构造函数的第1个参数是数据库表列（也是模型属性）的类型，其余的参数指定属性（数据库表列）的配置选项。

2.1 常用的SQLAlchemy列类型

2.2 常用的SQLAlchemy列选项

表关系类型及编码实现

关系型数据库使用关系把不同表中的行联系起来。以上述模型定义代码为例，假设角色对用户是一对多的关系（即1个角色可属于多个用户，而每个用户只能有1个角色）。

一对多关系（多对一关系）

在“多”的一方，使用外键定义关系
如在Users模型中，定义role_id列为外键，给db.Column构造函数传递db.ForeignKey()参数，并将roles.id作为db.ForeignKey()的参数，其表明role_id列的值是roles表中行的id值。
在“一”的一方，基于面向对象的视角创建代表实例（记录或行）的属性，如上述的users = db.relationship(‘Users', backref=‘role')
db.relationship()的第1个参数表明这个关系的另一端是哪个模型，backref参数向Users模型添加一个role属性，从而定义反向关系。通过这一属性（role）可以替代role_id访问Roles模型，此时将获取的是模型对象，而不是外键的值。
如何理解上述这段话，可以从下面2句代码加深：

 users = inst_role.users
 user_role = user.role

通过第1句代码，可以直接获得特定角色实例（inst_role）相对应的所有users对象，且是以列表形式返回。
通过第2句代码，可以通过user实例直接获得该user所对应的role对象（1行记录，而不是Users模式定义的role_id字段值）。

一对一关系

要定义一对一的关系，只需基于一对多的模型定义基础上，给db.relationship()函数多传一个关键字表示关系选项：
users = db.relationship(‘Users', backref=‘role', userlist=False)
一对多与一对一在编码时，有个点需特别注意：当通过“一”的实例（db.relationship定义方）获取多的一方的对象时：

• 一对多：users = inst_role.users返回的是对象列表
• 一对一：users = inst_role.users返回的就是对象，而非列表

多对多关系

Pending…

数据库基本操作

在Flask-SQLAlchemy中，对数据库所做的改动均是通过数据库“会话”进行管理的，会话用db.session表示。如需用db.session.commit()提交对记录的修改，始终把数据库相关改动放在会话中提交，可避免因部分更新异常导致数据库中数据的不一致性。

插入

    admin_role = Roles(name='Admin')
    mod_role = Roles(name='Moderator')
    john = Users(username='liyu', role=admin_role)
    david = Users(username='liji', role=admin_role)
    db.session.add(admin_role)
    db.session.add(mod_role)
    db.session.add(john)
    db.session.add(david)
    db.session.commit()

前4行代码，实例化2种角色及2个用户对象（映射至数据库即是给记录的字段赋值）
5~7行代码就是将新增角色及用户操作放在了1个session中，最后再统一提交（commit），可防止因其中某条语句异常而更新部分从而导致数据的不一致性。该操作就是将多个原子操作组成一个事务，如果某条更新失败就会导致整个会话失效。
5~7行还可简写成： db.session.add([admin_role, mod_role, john, david])

更新

在Flask-SQLAlchemy中，一条记录表示为一个对象；记录的字段表示为对象的属性，因此要更新字段值，实际上就是对对象的属性赋值：

admin_role.name = 'Administrator'
db.session.add(admin_role)
db.session.commit()

查询

查询表中所有记录：模式.query.all()

eg. Roles.query.all()

使用过滤器进行更精确查询

2.1 filter与filter_by区别

2.1.1 语法区别

filter需要用“类名.属性名”且需用==比较，而filter_by直接用属性名，比较用=

users = Users.query.filter(Users.id == 1).all()
users =  Users.query.filter_by(id = 1).all()

2.1.2 组合查询

filter不支持组合查询，只能连续用filter来实现，而filter_by支持组合查询(下面2条语句效果一样)

users = Users.query.filter(Users.id == 1).filter(Users.username == 'xxx').all()
users =  Users.query.filter_by(id = 1, username='xxx').all()
# filter_by也支持连续使用

注：如果要查看SQLAlchemy为查询生成的原生SQL查询语句，只需把query对象转换成字符串： str(Users.query.filter_by(role=admin_role))

删除

执行查询

在查询上应用指定的过滤器后，通过调用all()触发执行查询，常见的触发执行方法有： 

4.1 一对多

4.1.1 从“一”获取对应的所有多端对象

users = inst_role.users //直接通过角色对象的users属性获取所有属于该角色的用户对象
role = inst_user.role  //直接通过用户实例的role属性获取该用户所属的角色对象，注意这里获取的是角色对象，而不仅是角色ID

注：inst_role.users获取对象时，隐含了调用all()方法触发执行，但如果像加一些过滤器（如排序），则需要在db.relationship中添加lazy='dynamic'关键字参数。然后即可引入过滤器：inst_role.users.order_by(Users.username)

4.2 多对多

Pending…

在Flask-SQLAlchemy中，删除数据库记录，可映射至删除代表该记录的对象：

db.session.delete(mod_role)
db.session.commit()

参考资料

到此这篇关于Flask使用SQLAlchemy实现持久化数据的文章就介绍到这了,更多相关Flask SQLAlchemy持久化数据内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！