【Flask】SQLAlchemy

SQLAlchemy是什么

为什么使用orm

优点

• 有语法提示, 省去自己拼写SQL，保证SQL语法的正确性
• orm提供方言功能(dialect, 可以转换为多种数据库的语法), 减少学习成本
• 防止sql注入攻击
• 搭配数据迁移, 更新数据库方便
• 面向对象, 可读性强, 开发效率高

缺点

• 需要语法转换, 效率比原生sql低
• 复杂的查询往往语法比较复杂 (可以使用原生sql替换)

定义

SQLAlchemy是一个基于Python实现的ORM框架。该框架建立在 DB API之上，使用关系对象映射进行数据库操作，简言之便是：将类和对象转换成SQL，然后使用数据API执行SQL并获取执行结果。

安装

pip3 install sqlalchemy

组成部分

• Engine，框架的引擎
• Connection Pooling ，数据库连接池
• Dialect，选择连接数据库的DB API种类
• Schema/Types，架构和类型
• SQL Exprression Language，SQL表达式语言

SQLAlchemy本身无法操作数据库，其必须以来pymsql等第三方插件

MySQL-Python
    mysql+mysqldb://<user>:<password>@<host>[:<port>]/<dbname>
    
pymysql
    mysql+pymysql://<username>:<password>@<host>/<dbname>[?<options>]
    
MySQL-Connector
    mysql+mysqlconnector://<user>:<password>@<host>[:<port>]/<dbname>
    
cx_Oracle
    oracle+cx_oracle://user:pass@host:port/dbname[?key=value&key=value...]
    
更多：http://docs.sqlalchemy.org/en/latest/dialects/index.html

SQLAlchemy的使用

原生sql

from sqlalchemy import create_engine
from sqlalchemy.engine.base import Engine
from urllib import parse
import threading

user = "root"
password = "xxx@000"
pwd = parse.quote_plus(password)   # 解决密码中含@符导致报错
host = "127.0.0.1:"
# 第一步: 创建engine
engine = create_engine(
    f"mysql+pymysql://{user}:{pwd}@{host}3306/test1?charset=utf8",
    max_overflow=0,  # 超过连接池大小外最多创建的连接
    pool_size=5,  # 连接池大小
    pool_timeout=30,  # 池中没有线程最多等待的时间，否则报错
    pool_recycle=-1  # 多久之后对线程池中的线程进行一次连接的回收（重置）
)


# 第二步：使用
def task():
    conn = engine.raw_connection()  # 从连接池中取一个连接
    cursor = conn.cursor()
    sql = "select * from signer"
    cursor.execute(sql)
    print(cursor.fetchall())


if __name__ == '__main__':
    for i in range(20):
        t = threading.Thread(target=task)
        t.start()

使用orm映射数据表

import datetime
from sqlalchemy.ext.declarative import declarative_base
from model import engine  # 用的简单使用里面的engine
from sqlalchemy import Column, Integer, String, Text, ForeignKey, DateTime, UniqueConstraint, Index

Base = declarative_base()   # 基类

# 表模型
class Users(Base):
    __tablename__ = 'users'  # 数据库表名称， 必须写
    
    id = Column(Integer, primary_key=True)  # id 主键
    name = Column(String(32), index=True, nullable=False)  # name列，索引，不可为空
    email = Column(String(32), unique=True)
    # datetime.datetime.now不能加括号，加了括号，以后永远是当前时间
    ctime = Column(DateTime, default=datetime.datetime.now)
    extra = Column(Text, nullable=True)

    __table_args__ = (   # 可选
        UniqueConstraint('id', 'name', name='uix_id_name'),  # 联合唯一
        Index('ix_id_name', 'name', 'email'),  # 索引
    )

def init_db():
    """
    根据类创建继承base类的表
    :return:
    """

    Base.metadata.create_all(engine)


def drop_db():
    """
    根据类删除继承base类的表
    :return:
    """

    Base.metadata.drop_all(engine)


if __name__ == '__main__':
		# sqlalchemy 只支持 创建和删除表，不支持修改表(django orm支持)。sqlalchemy 需要借助第三方实现
    init_db()  # 创建表
    # drop_db()   # 删除表

外键关系

一对多(ForeignKey)

class Hobby(Base):
    __tablename__ = 'hobby'
    id = Column(Integer, primary_key=True)
    caption = Column(String(50), default='篮球')


class Person(Base):
    __tablename__ = 'person'
    nid = Column(Integer, primary_key=True)
    name = Column(String(32), index=True, nullable=True)
    # hobby指的是tablename而不是类名
    hobby_id = Column(Integer, ForeignKey("hobby.id"))
    
    # 跟数据库无关，不会新增字段，只用于快速链表操作
    # 类名，backref用于反向查询  参数 uselist=False , 设置就变成了一对一，其他和一对多一样
    hobby=relationship('Hobby',backref='pers')
    # hobby=relationship('Hobby',backref='pers', uselist=False)  # 一对一关系

多对多

class Boy2Girl(Base):
    __tablename__ = 'boy2girl'
    id = Column(Integer, primary_key=True, autoincrement=True)
    girl_id = Column(Integer, ForeignKey('girl.id'))
    boy_id = Column(Integer, ForeignKey('boy.id'))


class Girl(Base):
    __tablename__ = 'girl'
    id = Column(Integer, primary_key=True)
    name = Column(String(64), unique=True, nullable=False)


class Boy(Base):
    __tablename__ = 'boy'

    id = Column(Integer, primary_key=True, autoincrement=True)
    hostname = Column(String(64), unique=True, nullable=False)
    
    # 与生成表结构无关，仅用于查询方便,放在哪个单表中都可以
    servers = relationship('Girl', secondary='boy2girl', backref='boys')
    
'''
girl_id = Column(Integer, ForeignKey("hobby.id", ondelete='SET NULL'))  # 一般用SET NULL
外键约束
    1. RESTRICT：若子表中有父表对应的关联数据，删除父表对应数据，会阻止删除。默认项
    2. NO ACTION：在MySQL中，同RESTRICT。
    3. CASCADE：级联删除。
    4. SET NULL：父表对应数据被删除，子表对应数据项会设置为NULL。
'''

扩充：在 django 中，外键管理有个参数 db_contraint=False 用来在逻辑上关联表，但实体不建立约束。同样在SQLAlchemy 中也可以通过配值 relationship 参数来实现同样的效果

class Boy2Girl(Base):
    __tablename__ = 'boy2girl'
    id = Column(Integer, primary_key=True, autoincrement=True)
    girl_id = Column(Integer)  # 不用ForeignKey
    boy_id = Column(Integer)
    
    gitl = db.relationship(
        "Girl",
        # uselist=False,  # 一对一设置
        backref=backref("to_course", uselist=False),  # backref用于反向查询 uselist 作用同上
        lazy="subquery",    # 懒加载 用来指定sqlalchemy 什么时候加载数据
        primaryjoin="Girl.id==Boy2Girl.girl_id",  # 指定对应关系
        foreign_keys="Boy2Girl.girl_id"  # 指定表的外键字段
    )
'''
lazy 可选值
    select：就是访问到属性的时候，就会全部加载该属性的数据  默认值
    joined：对关联的两个表使用联接
    subquery：与joined类似，但使用子子查询
    dynamic：不加载记录，但提供加载记录的查询，也就是生成query对象
'''

使用orm操作记录

简单表操作

from sqlalchemy.orm import sessionmaker

from model import engine
from db_model import Users

# 定义一个 session， 以后操作数据都用 session 来执行
Session = sessionmaker(bind=engine)
session = Session()
# 创建User对象
usr = Users(name="yxh", email="152@11.com", extra="xxx")
# 通过 user对象 添加到session中 
session.add(usr)
# 提交，才会刷新到数据库中，不提交不会执行
session.commit()

基于scoped_session实现线程安全

session 如果是一个全局对象。那么在多线程的情况下，并发使用同一个变量 session 是不安全的，解决方案如下：

• 将session定义在局部，每一个view函数都定义一个session。 代码冗余，不推荐

• 基于scoped_session 实现线程安全。原理同 request对象，g对象一致。也是基于local，给每一个线程创造一个session

from sqlalchemy.orm import sessionmaker, scoped_session
from model import engine
from db_model import Users

# 定义一个 session
Session = sessionmaker(bind=engine)
# session = Session()
session = scoped_session(Session)  # 后续使用这个session就是线程安全的
# 创建User对象
usr = Users(name="yxh", email="152@11.com", extra="xxx")
# 通过 user对象 添加到session中
session.add(usr)
# 提交，才会刷新到数据库中，不提交不会执行
session.commit()

CRUD

创建（Create）、读取（Read）、更新（Update）和删除（Delete）

基础操作

from sqlalchemy.orm import sessionmaker, scoped_session
from sqlalchemy.sql import text
from model import engine
from db_model import Users

# 定义一个 session
Session = sessionmaker(bind=engine)
# session = Session()
session = scoped_session(Session)  # 后续使用这个session就是线程安全的

# 1  增加操作
obj1 = Users(name="yxh003")
session.add(obj1)
# 增加多个，不同对象
session.add_all([
    Users(name="yxh009"),
    Users(name="yxh008"),
])
session.commit()

# 2 删除操作---》查出来再删---》
session.query(Users).filter(Users.id > 2).delete()
session.commit()

# 3 修改操作--》查出来改  传字典
session.query(Users).filter(Users.id > 0).update({"name": "yxh"})
# 类似于django的F查询
# 字符串加
session.query(Users).filter(Users.id > 0).update({Users.name: Users.name + "099"}, synchronize_session=False)
# 数字加
session.query(Users).filter(Users.id > 0).update({"age": Users.age + 1}, synchronize_session="evaluate")
session.commit()

# 4 查询操作----》
r1 = session.query(Users).all()  # 查询所有
# 只取age列，把name重命名为xx
# select name as xx,age from user;
r2 = session.query(Users.name.label('xx'), Users.email).all()

# filter传的是表达式，filter_by传的是参数
r3 = session.query(Users).filter(Users.name == "yxh").all()
r3 = session.query(Users).filter(Users.id >= 1).all()
r4 = session.query(Users).filter_by(name='yxh').all()
r5 = session.query(Users).filter_by(name='yxh').first()
# :value 和:name 相当于占位符，用params传参数
r6 = session.query(Users).filter(text("id<:value and name=:name")).params(value=224, name='yxh').order_by(
    Users.id).all()
# 自定义查询sql
r7 = session.query(Users).from_statement(text("SELECT * FROM users where name=:name")).params(name='yxh').all()

# 执行原生sql
# 查询
cursor = session.execute("select * from users")
result = cursor.fetchall()
# 添加
cursor = session.execute('insert into users(name) values(:value)', params={"value": 'yxh'})
session.commit()
print(cursor.lastrowid)

进阶操作

from sqlalchemy.orm import sessionmaker, scoped_session
from sqlalchemy.sql import text, func
from sqlalchemy import and_, or_
from model import engine
from db_model import Users, Person, Favor

# 定义一个 session
Session = sessionmaker(bind=engine)
# session = Session()
session = scoped_session(Session)  # 后续使用这个session就是线程安全的

# 　条件
# select * form user where name =lqz
ret = session.query(Users).filter_by(name='lqz').all()

# 表达式，and条件连接
# select * from user where id >1 and name = lqz
ret = session.query(Users).filter(Users.id > 1, Users.name == 'lqz').all()

# select * from user where id between 1,3  and name = lqz
ret = session.query(Users).filter(Users.id.between(1, 3), Users.name == 'lqz').all()

# # 注意下划线
#  select * from user where id in (1,3,4)
ret = session.query(Users).filter(Users.id.in_([1, 3, 4])).all()
# # ~非，除。。外

# select * from user where id not in (1,3,4)
ret = session.query(Users).filter(~Users.id.in_([1, 3, 4])).all()

# # 二次筛选
ret = session.query(Users).filter(Users.id.in_(session.query(Users.id).filter_by(name='lqz'))).all()

# # or_包裹的都是or条件，and_包裹的都是and条件
ret = session.query(Users).filter(and_(Users.id > 3, Users.name == 'eric')).all()
ret = session.query(Users).filter(or_(Users.id < 2, Users.name == 'eric')).all()
ret = session.query(Users).filter(
    or_(
        Users.id < 2,
        and_(Users.name == 'eric', Users.id > 3),
        Users.extra != ""
    )).all()

# 通配符，以e开头，不以e开头
ret = session.query(Users).filter(Users.name.like('e%')).all()
ret = session.query(Users).filter(~Users.name.like('e%')).all()

# # 限制，用于分页，区间
ret = session.query(Users)[1:2]

# # 排序，根据name降序排列（从大到小）
ret = session.query(Users).order_by(Users.id.desc()).all()
# # 第一个条件重复后，再按第二个条件升序排
ret = session.query(Users).order_by(Users.name.desc(), Users.id.asc()).all()

# 分组
# select * from user group by user.extra;
ret = session.query(Users).group_by(Users.extra).all()
# # 分组之后取最大id，id之和，最小id
# select max(id),sum(id),min(id) from user group by name ;
ret = session.query(
    func.max(Users.id),
    func.sum(Users.id),
    func.min(Users.id)).group_by(Users.name).all()

# haviing筛选
#  select max(id),sum(id),min(id) from user group by name  having min(id)>2;
ret = session.query(
    func.max(Users.id),
    func.sum(Users.id),
    func.min(Users.id)).group_by(Users.name).having(func.min(Users.id) > 2).all()

# select max(id),sum(id),min(id) from user where id >=1 group by name  having min(id)>2;
ret = session.query(
    func.max(Users.id),
    func.sum(Users.id),
    func.min(Users.id)).filter(Users.id >= 1).group_by(Users.name).having(func.min(Users.id) > 2).all()

# 连表（默认用orm中forinkey关联）

# select * from user,favor where user.id=favor.id
ret = session.query(Users, Favor).filter(Users.id == Favor.nid).all()

# join表，默认是inner join
# select * from Person inner join favor on person.favor=favor.id;
ret = session.query(Person).join(Favor).all()
# isouter=True 外连，表示Person left join Favor，没有右连接，反过来即可
ret = session.query(Person).join(Favor, isouter=True).all()
ret = session.query(Favor).join(Person, isouter=True).all()

# 打印原生sql
aa = session.query(Person).join(Favor, isouter=True)
# print(aa)

# 自己指定on条件（连表条件）,第二个参数，支持on多个条件，用and_,同上
# select * from person left join favor on person.id=favor.id;
ret = session.query(Person).join(Favor, Person.id == Favor.id, isouter=True).all()

# 组合 UNION 操作符用于合并两个或多个 SELECT 语句的结果集 多用于分表后 上下连表 
# union和union all  union 去重， union all 不去重
q1 = session.query(Users.name).filter(Users.id > 2)
q2 = session.query(Favor.caption).filter(Favor.nid < 2)
ret = q1.union(q2).all()

q1 = session.query(Users.name).filter(Users.id > 2)
q2 = session.query(Favor.caption).filter(Favor.nid < 2)
ret = q1.union_all(q2).all()

Flask集成sqlalchemy

'''
flask_migrate  中使用了flask_sqlalchemy 下载时，会自动帮你下载flask_sqlalchemy
flask_migrate  3.0之前和之后使用方法有区别。这里以2.x 做演示
'''
# flask_migrate使用步骤
from flask_sqlalchemy import SQLAlchemy
# Flask_SQLAlchemy给你包装了基类，和session，以后拿到db
db = SQLAlchemy()  # 全局SQLAlchemy，就是线程安全的，内部就是上述那么实现的
app = Flask(__name__)
# SQLAlchemy 连接数据库配置是在 config 配置字典中获取的，所以需要我们将配置添加进去
app.config.from_object('DevelopmentConfig')
'''
基本写这些就够了
"SQLALCHEMY_DATABASE_URI"  
"SQLALCHEMY_POOL_SIZE"
"SQLALCHEMY_POOL_TIME"
"SQLALCHEMY_POOL_RECYCLE"
"SQLALCHEMY_TRACK_MODIFICATIONS"
"SQLALCHEMY_ENGINE_OPTIONS"
'''
# 将db注册到app中，加载配置文件，flask-session，用一个类包裹一下app
db.init_app(app)
# 将需要使用orm操作的表通过继承db.Model实现类


# 下面三句会创建出两个命令:runserver db 命令(flask_migrate)
manager=Manager(app)
Migrate(app, db)
manager.add_command('db', MigrateCommand) # 添加一个db命令

使用命令:
    1. python xxx.py db init  # 初始化，刚开始干，生成一个migrate文件夹(迁移文件夹)
    2. python xxx.py db migrate   # 生成迁移版本，保存到迁移文件夹，同django  makemigartions
    3. python xxx.py db upgrade   # 执行迁移，同django  migrate

构建模型类

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

# 相关配置
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:mysql@127.0.0.1:3306/test31'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_ECHO'] = True

# 创建组件对象
db = SQLAlchemy(app)


# 构建模型类  类->表  类属性->字段  实例对象->记录
# 模型类必须继承 db.Model, 其中 db 指对应的组件对象
class User(db.Model):
    __tablename__ = 't_user'  # 设置表名, 表名默认为类名小写
    id = db.Column(db.Integer, primary_key=True)  # 设置主键, 默认自增
    name = db.Column('username', db.String(20), unique=True)  # 设置字段名 和 唯一约束
    age = db.Column(db.Integer, default=10, index=True)  # 设置默认值约束 和 索引


if __name__ == '__main__':
    # 删除所有继承自db.Model的表
    db.drop_all()
    # 创建所有继承自db.Model的表
    db.create_all()
    app.run(debug=True)

常用的字段类型

常用的字段选项

增

# 1.创建模型对象
user1 = User(name='zs', age=20)
# user1.name = 'zs'
# user1.age = 20

# 2.将模型对象添加到会话中 
db.session.add(user1)
# 添加多条记录
# db.session.add_all([user1, user2, user3])

# 3.提交会话 (会提交事务)
# sqlalchemy会自动创建隐式事务
# 事务失败会自动回滚
db.session.commit()

查

# 查询所有用户数据
User.query.all() 返回列表, 元素为模型对象

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

# 查询第1个用户
User.query.first()  返回模型对象/None

# 查询id为4的用户[3种方式]
# 方式1: 根据id查询  返回模型对象/None
User.query.get(4)  
# 方式2: 等值过滤器 关键字实参设置字段值  返回BaseQuery对象
# BaseQuery对象可以续接其他过滤器/执行器  如 all/count/first等
User.query.filter_by(id=4).all()  
# 方式3: 复杂过滤器  参数为比较运算/函数引用等  返回BaseQuery对象
User.query.filter(User.id == 4).first()

# 查询名字结尾字符为g的所有用户[开始 / 包含]
User.query.filter(User.name.endswith("g")).all()
User.query.filter(User.name.startswith("w")).all()
User.query.filter(User.name.contains("n")).all()
User.query.filter(User.name.like("w%n%g")).all()  # 模糊查询

# 查询名字和邮箱都以li开头的所有用户[2种方式]
User.query.filter(User.name.startswith('li'), User.email.startswith('li')).all()
from sqlalchemy import and_
User.query.filter(and_(User.name.startswith('li'), User.email.startswith('li'))).all()

# 查询age是25 或者 `email`以`itheima.com`结尾的所有用户
from sqlalchemy import or_
User.query.filter(or_(User.age==25, User.email.endswith("itheima.com"))).all()

# 查询名字不等于wang的所有用户[2种方式]
from sqlalchemy import not_
User.query.filter(not_(User.name == 'wang')).all()
User.query.filter(User.name != 'wang').all()

# 查询id为[1, 3, 5, 7, 9]的用户
User.query.filter(User.id.in_([1, 3, 5, 7, 9])).all()

# 所有用户先按年龄从小到大, 再按id从大到小排序, 取前5个
User.query.order_by(User.age, User.id.desc()).limit(5).all()

# 查询年龄从小到大第2-5位的数据   2 3 4 5
User.query.order_by(User.age).offset(1).limit(4).all()

# 分页查询, 每页3个, 查询第2页的数据  paginate(页码, 每页条数)
pn = User.query.paginate(2, 3)
pn.pages 总页数  pn.page 当前页码 pn.items 当前页的数据  pn.total 总条数


# 查询每个年龄的人数    select age, count(name) from t_user group by age  分组聚合
from sqlalchemy import func
data = db.session.query(User.age, func.count(User.id).label("count")).group_by(User.age).all()
for item in data:
    # print(item[0], item[1])
    print(item.age, item.count)  # 建议通过label()方法给字段起别名, 以属性方式获取数据

# 只查询所有人的姓名和邮箱  优化查询   User.query.all()  # 相当于select *
from sqlalchemy.orm import load_only
data = User.query.options(load_only(User.name, User.email)).all()  # flask-sqlalchem的语法
for item in data:
    print(item.name, item.email)

data = db.session.query(User.name, User.email).all()  # sqlalchemy本体的语法
for item in data:
    print(item.name, item.email)

改

先查询, 再更新

对应SQL中的 先select, 再commit()

• 缺点

  • 查询和更新分两条语句, 效率低
  • 如果并发更新, 可能出现更新丢失问题(Lost Update)

• 示例文章来源地址https://www.toymoban.com/news/detail-548878.html

  # 1.执行查询语句, 获取目标模型对象
  goods = Goods.query.filter(Goods.name == '方便面').first()
  # 2.对模型对象的属性进行赋值 (更新数据)
  goods.count = goods.count - 1
  # 3.提交会话
  db.session.commit()
  

基于过滤条件的更新 (推荐方案)

对应SQL中的 update xx where xx = xx (也称为 update子查询 )

• 优点

  • 一条语句, 被网络IO影响程度低, 执行效率更高
  • 查询和更新在一条语句中完成, 单条SQL具有原子性, 不会出现更新丢失问题
  • 会对满足过滤条件的所有记录进行更新, 可以实现批量更新处理

• 示例

  Goods.query.filter(Goods.name == '方便面').update({'count': Goods.count - 1})
  # 提交会话
  db.session.commit()
  

删

先查询, 再删除

# 方式1: 先查后删除
goods = Goods.query.filter(Goods.name == '方便面').first()
# 删除数据
db.session.delete(goods)
# 提交会话 增删改都要提交会话
db.session.commit()

基于过滤条件的删除 (推荐方案)

# 方式2: delete子查询
Goods.query.filter(Goods.name == '方便面').delete()
# 提交会话
db.session.commit()

到了这里，关于【Flask】SQLAlchemy的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！