前言

趁着最近被裁，现在有了空闲时间正好把之前使用过的东西好好的归类，作一下简单的梳理和总结吧！由于是给我自己看的东西，所以就非常的简单，看者请勿喷，好了下面开始整活！

flask-sqlalchemy简介

flask-sqlalchemy是一个基于SQLAlchemy的flask插件扩展，它简化了连接数据库服务器，管理数据库操作会话等各类工作，让Flask中的数据处理体验变得更加轻松。

flask-sqlalchemy数据库常用配置

以下是我经常会用到的配置项:

• SQLALCHEMY_DATABASE_URI: 用于连接数据的数据库。
• SQLALCHEMY_ECHO: 记录所有发送到标准输出的SQL语句，通常在开发调试时很有帮助。
• SQLALCHEMY_POOL_SIZE: 数据库连接池的大小。默认是数据库引擎的默认值为5。
• SQLALCHEMY_POOL_TIMEOUT: 指定数据库连接池的超时时间，默认值为 10。
• SQLALCHEMY_POOL_RECYCLE: 自动回收连接的秒数。这各配置项对 MySQL 是必须的，默认 情况下 MySQL 会自动移除闲置 8 小时或者以上的连接。 需要注意地是如果使用 MySQL 的话， Flask-SQLAlchemy 会自动地设置这个值为 2 小时。
• SQLALCHEMY_MAX_OVERFLOW: 控制在连接池达到最大值后可以创建的连接数。当这些额外的 连接回收到连接池后将会被断开和抛弃。
• SQLALCHEMY_TRACK_MODIFICATIONS: 如果此配置设置成 True (默认情况就是True)，Flask-SQLAlchemy 将会追踪对象的修改并且发送信号。这个通常需要额外的内存， 如果不必要的话可以禁用它。

flask-sqlalchemy连接数据URL格式

// 数据库类型+驱动名称://用户名:密码@host:port/database_name

postgresql://root:root@127.0.0.1:1521/db  // postgresql数据库

mysql://root:root@127.0.0.1:1521/db  // mysql数据库

oracle://root:root@127.0.0.1:1521/db // oracle数据库

sqlite:////absolute/path/to/sqlite3.db // sqlite数据库

在flask中使用flask-sqlalchemy插件

通用的做法如下所示:

1. 通常会在app目录下创建一个extension.py文件用户实例化各种flask插件的实例和配置

# app/extension.py

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

2. 我们还需添加配置数据的配置

# app/config.py

SQLALCHEMY_DATABASE_URI = "sqlite:////sqlite3.db" # 这个项是必须的

3. 实例化db对象后我们会在，create_app这个工厂方法里注册db实例和加载数据配置

# app/__init__.py

from flask import Flask
from app.extension importt db


def create_app() -> Flask:
    app = Flask(__name__)
    app.config.from_object("app.config")
    db.init_app(app) # 注册db实例
    return app

flask-sqlalcheymy数据字段

1. 数据类型

• Integer：整数类型
• String(size)：有长度限制的字符串类型
• Text：文本类型，用于存放一些比较长的unicode文本
• DateTime：日期时间
• Float：浮点数类型
• Boolean：布尔类型
• PickleType：可以存储一个持久化的python对象
• LargeBinary：可以存储一个任意大的二进制数据

2. 常用选项

• primary_ley：如果这个选项设置为True,这一列就是表的主键
• unique：如果这个选项设置为True，表示这一列不允许出现重复的值
• index：如果这个选项设置为True,表示为这一列创建索引
• nullable：如果这个选项设置为True，表示这一列允许有空值的存在
• autoincrement: 如果这个选项设置为True,表示这列的值会自动增长
• default：为列设置默认值

使用flask-sqlalchemy定义模型

一般的我们都是基于SQLAlchemy的实例去定义数据库模型的，具体做法如下所示:

# app/models.py
from datetime import datetime
from sqlalchemy import func # 自动更新

from app.extension importt db


class User(db.Model): # 继承db.Model这个基础模型类
    __tablename__ = "users" # 设置表的名字，不设置的话默认是模型类的名称
    id = db.Column(db.Integer, primary_key=True, autoincrement=True) # 使用db.Column()函数定义一个列，db.Integer指定列的类型
    nickname = db.Column(db.String(30), unique=True, nullable=False)
    join_date = db.Column(db.DateTime, default=datetime.now(), onupdate=func.now())

表的关系和约束

1. 表与表的关系

表与表之间的关系存在三种：一对一、一对多、多对多

• 一对一关系: 查询结果是唯一的

 # app/models.py

from sqlalchemy import func
from app.extension import db


class Users(db.Model): # 主表
    __tablename__ = "users"
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    nickname = db.Column(db.String(30), unique=True, nullable=False)
    join_date = db.Column(db.DateTime, default=datetime.now, onupdate=func.now)


class InfoCar(db.Model): # 从表
    __tablename__ = "info_car"
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    uid_number = db.Column(db.Integer, unique=True, nullable=False)
    user_id = db.Column(db.Integer, db.ForeignKey("users.id")
    users = db.relationship("Users", backref=db.backref("info"), uselist=False)

在InfoCar模型中使用了db.ForeignKey("users.id")定义了一个外键，并使用了db.relationship()来表明两张表之间的关系，注意一对一的关系，必须将userlist设置为False,它将仅返回对应的单个记录

• 一对多关系: 例如，一本小说的作者可能存在发行了多本小说，具体如下所示:

# app/models.py

class Author(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    name = db.Column(db.String(32), unique=True, nullable=False)
    books = db.relastionship("Book", backref=db.backref("book"))


class Book(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    book_name = db.Column(db.String(35), unique=True, nullable=False)
    author_id = db.Column(db.ForeignKey("author.id")

一般的外键只能存储单一的数据，所以外键总是在"多"的一侧，backref=db.backref("book")的意思是用户可以直接使用book查询到author所有的书籍。

• 多对一: 例如，多本小说对应同一个作者

# app/models.py

class Author(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    name = db.Column(db.String(32), unique=True, nullable=False)
    books = db.relastionship("Book")
    book_id = db.Column(db.Integer, db.ForeignKey("book.id"))


class Book(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    book_name = db.Column(db.String(35), unique=True, nullable=False)

    

因为外键总是在"多"这一侧定义,所以在多对一关系中外键和关系属性都定义在"多"的这一侧。

• 多对多: 例如，多本书对应多个作者

想要建立多对多关系就需要建立一张辅助的关联表。联表不存储数据，只用来存储关系两侧模型的外键对应关系

relation_table = db.Table("relation_tb", db.Column("user_id", db.Integer, db.ForeignKey("user.id"), 
    db.Column("book_id", db.Integer, db.ForeignKey("book.id")))


class Author(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    name = db.Column(db.String(32), unique=True, nullable=False)
    books = db.relationship("Book", secondary=relation_table, back_populates="author")


class Book(db.Model):
    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
    book_name = db.Column(db.String(35), unique=True, nullable=False)

使用db.Table类定义关联表，第一个参数是关联表的名称，然后就是两个外键字段，user_id和book_id，secondary参数指定关联表名称。back_populates表明建立双向关系。

2. relationship关系函数常用参数

• back_poulates: 定义反向引用，用于建立双向关系，在关系的另一侧也必须显式定义关系属性
• backref: 添加反向引用，自动在另一侧建立关系属性，是back_populates的简化版
• lazy: 指定如何加载相关记录
• uselist: 指定是否使用列表的形式加载记录，设为False则使用标量
• cascade: 设置级联操作
• order_by: 指定加载相关记录时的排序方式
• secondary: 在多对多关系中指定关联表
• primaryjoin: 指定多对多关系中的一级联结条件
• secondaryjoin: 指定多对多关系中的二级联结条件

3. lazy参数的选项

• select: 在必要时一次性加载记录，返回包含记录的列表（默认值），等同于lazy=True
• joined: 和父查询一样加载记录，但使用联结，等同于lazy=False
• immediate: 一旦父查询加载就加载
• subquery: 类似于joi口时，不过将使用子查询
• dynamic: 不直接加载记录，而是返回一个包含相关记录的query对象，以便再继续附加查询函数对结果进行过滤

CRUD操作

• 插入添加操作

创建 Python 对象->把它添加到会话->提交会话

user = Users(nickname="tom")
db.session.add(user)
db.session.commit()

• 查询记录

查询格式如下:

model_class.query.query_filter_condition.query_method

例子如下:

Users.query.all() # 查询所有users表记录

Users.query.first() # 返回查询的第一条记录，如果未找到，则返回None

Users.query.get() # 传入主键值作为参数，返回指定主键值的记录，如果未找到，则返回None

Users.query.count() # 返回查询结果的数

Users.query.filter(Users.id = 1).first() # filter条件过滤，返回新产生的查询对象，只能根据模型实例来查询

Users.query.filter_by(id=1).first() # filter_by条件过滤，返回新产生的查询对象，可以根据关键字参数来进行查询

Users.query.filter(Users.nickname.like("%min%").first() # 类似于LIKE语句

Users.query.filter(Users.id.in_([1, 2, 3])) # 相当于原生IN操作

Users.query.filter(~Users.id.in_([1, 2, 3])) # 相当于原生NOT IN操作

Users.query.filter(and_(Users.nickname = "admin", Users.id = 1)).first() # 相当于AND

Users.query.filter(or_(Users.nickname = "admin", Users.id = 2)).first() # 相当于OR

• 更新记录

更新一条记录非常简单，直接赋值给模型类的字段属性就可以改变字段值，然后调用commit方法提交会话即可。

user.nickname = "superadmin"
db.commit()

• 删除记录

删除记录和添加记录很相似，不过要把add方法换成delete方法，最后都需要调用commit方法提交修改。

user = User.query.get(1)
db.session.delete(user)
db.commit()

小结

以上就是flask-sqlalchemy的一些小总结，虽然基础但是也足够了，后续再写个小demo来打发时间吧。