flask_sqlalchemy原生sql分页 flask sqlalchemy教程

对数据库基本操作

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

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

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

• 最基本的查询是返回表中所有数据，可以通过过滤器进行更精确的数据库查询。

一、定义模型类

表关系为一对多

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

#设置连接数据库的URL
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:123456@127.0.0.1:3306/test'
#设置数据库追踪信息,压制警告
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = True
#创建SQLAlchemy对象,读取app中配置信息
db = SQLAlchemy(app)
#定义角色模型(一方) 模型类必须继承db.Model
class Role(db.Model):
    # 定义表名，不写此段表名默认为类名小写
    __tablename__ = 'roles'
    # 定义列对象，即sql中字段
    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__':
    #删除所有和db相关联的表
    db.drop_all()
    #创建所有和db相关联的表
    db.create_all()
    app.run(debug=True)

二、关键代码格式,说明

• 一对多关系

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)，这样关联对象会在被使用的时候再进行加载，并且在返回前进行过滤，如果返回的对象数很多，或者未来会变得很多，那最好采用这种方式 

 

三、常见的操作语句

• db.session.add(obj) 添加对象
• db.session.add_all([obj1,obj2,..]) 添加多个对象
• db.session.delete(obj) 删除对象
• db.session.commit() 提交会话
• db.session.rollback() 回滚
• db.session.remove() 移除会话

四、常用的SQLAlchemy查询过滤器

• 用来过滤数据,返回查询的结果集

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

 

五、常用的SQLAlchemy查询执行器

• 用来执行结果集,得到具体数据

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

 六、完整操作

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

#配置信息
app.config["SQLALCHEMY_DATABASE_URI"] = "mysql+pymysql://root:123456@127.0.0.1:3306/test"
#设置压制警告信息,如果True会追踪数据库变化,会增加显著开销,所以建议设置为False
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False

#创建SQLAlchemy类对象,关联app
db = SQLAlchemy(app)

#编写模型类,继承db.Model
#角色,用户之间的关系
class Role(db.Model):
    __tablename__ = "roles" #指定表名称
    #参数1:表示整数类型,  参数2:表示主键
    id = db.Column(db.Integer,primary_key=True)
    #角色名唯一的
    name = db.Column(db.String(64),unique=True)


    #需要设置关系属性relationship(不会产生字段),设置在一方
    #给Role添加了users关系属性, 查询格式: role.users
    #给User添加了role关系属性(反向引用),查询格式: user.role
    users = db.relationship('User',backref='role')

    #为了方便的看到对象输出的内容__repr__, 如果是普通类__str__
    def __repr__(self):
        return "<Role:%s>"%self.name

# 用户(多方)
class User(db.Model):
    __tablename__ = "users"  # 指定表名称
    #参数1:表示整数类型,  参数2:表示主键
    id = db.Column(db.Integer,primary_key=True)
    #用户名唯一的
    name = db.Column(db.String(64),unique=True)
    #邮箱密码
    email = db.Column(db.String(64),unique=True)
    password = db.Column(db.String(64))

    #外键
    role_id = db.Column(db.Integer,db.ForeignKey(Role.id))

    #为了方便的看到对象输出的内容__repr__, 如果是普通类__str__
    def __repr__(self):
        return "<User:%s,%s,%s,%s>"%(self.id,self.name,self.email,self.password)

if __name__ == '__main__':

    #为了演示方便,先删除数据库表,和模型类关联的表
    db.drop_all()

    #创建表,所有继承自dbModel的表
    db.create_all()

    #创建测试数据
    ro1 = Role(name='admin')
    db.session.add(ro1)
    db.session.commit()
    # 再次插入一条数据
    ro2 = Role(name='user')
    db.session.add(ro2)
    db.session.commit()

    #多条用户数据
    us1 = User(name='wang', email='[e-mail]', password='123456', role_id=ro1.id)
    us2 = User(name='zhang', email='[e-mail]', password='201512', role_id=ro2.id)
    us3 = User(name='chen', email='[e-mail]', password='987654', role_id=ro2.id)
    us4 = User(name='zhou', email='[e-mail]', password='456789', role_id=ro1.id)
    us5 = User(name='tang', email='[e-mail]', password='158104', role_id=ro2.id)
    us6 = User(name='wu', email='[e-mail]', password='5623514', role_id=ro2.id)
    us7 = User(name='qian', email='[e-mail]', password='1543567', role_id=ro1.id)
    us8 = User(name='liu', email='[e-mail]', password='867322', role_id=ro1.id)
    us9 = User(name='li', email='[e-mail]', password='4526342', role_id=ro2.id)
    us10 = User(name='sun', email='[e-mail]', password='235523', role_id=ro2.id)
    db.session.add_all([us1, us2, us3, us4, us5, us6, us7, us8, us9, us10])
    db.session.commit()

    app.run(debug=True)