随笔- 16 文章- 0 评论- 0 阅读- 7127

Flask数据库操作

数据库操作

ORM

ORM 全拼Object-Relation Mapping，中文意为 对象-关系映射。主要实现模型对象到关系数据库数据的映射

优点 :

只需要面向对象编程, 不需要面向数据库编写代码.
- 对数据库的操作都转化成对类属性和方法的操作.
- 不用编写各种数据库的sql语句.
实现了数据模型与数据库的解耦, 屏蔽了不同数据库操作上的差异.
- 不再需要关注当前项目使用的是哪种数据库。
- 通过简单的配置就可以轻松更换数据库, 而不需要修改代码.

缺点 :

相对于较为复杂的SQL语句,在使用模型来操作,难度会增加.
相对于编写原生SQL语句, 使用ORM会带来额外的学习成本和排错成本
根据对象的操作转换成SQL语句,根据查询的结果转化成对象, 在映射过程中有性能损失.

Flask-SQLAlchemy

flask默认提供模型操作，但是并没有提供ORM，所以一般开发的时候我们会采用flask-SQLAlchemy模块来实现ORM操作。

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

SQLAlchemy: https://www.sqlalchemy.org/

安装 flask-sqlalchemy

pip install flask-sqlalchemy -i https://pypi.douban.com/simple/

如果连接的是 mysql 数据库，需要安装 mysqldb 驱动

pip install flask-mysqldb

安装flask-mysqldb报错如下:

OSError: mysql_config not found

解决方案:

sudo apt-get install libmysqlclient-dev

数据库连接设置

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

class Config():
    DEBUG = True
    # 数据类型://登录用户:登录密码@数据库IP或地址:端口/数据库名
    SQLALCHEMY_DATABASE_URI = 'mysql://root:123@127.0.0.1:3306/flaskDemo'
    # 动态追踪修改设置，如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    #查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)

其他设置：

    # 动态追踪修改设置，如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    #查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

配置完成需要去 MySQL 中创建项目所使用的数据库

$ mysql -uroot -p123
$ create database flaskDemo charset=utf8mb4;

常用的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	在关系的另一模型中添加反向引用,用于设置外键名称,在1查多的
primary join	明确指定两个模型之间使用的联结条件
uselist	如果为False，不使用列表，而使用标量值
order_by	指定关系中记录的排序方式
secondary	指定多对多关系中关系表的名字
secondary join	在SQLAlchemy中无法自行决定时，指定多对多关系中的二级联结条件

数据库基本操作

在Flask-SQLAlchemy中，插入、修改、删除操作，均由数据库会话管理。
- 会话用 db.session 表示。在准备把数据写入数据库前，要先将数据添加到会话中然后调用 commit() 方法提交会话。
在 Flask-SQLAlchemy 中，查询操作是通过 query 对象操作数据。
- 最基本的查询是返回表中所有数据，可以通过过滤器进行更精确的数据库查询。

在视图函数中定义模型类

from flask import Flask
app = Flask(__name__)

class Config():
    DEBUG = True
    # 数据类型://登录用户:登录密码@数据库IP或地址:端口/数据库名
    SQLALCHEMY_DATABASE_URI = 'mysql://root:123@127.0.0.1:3306/flaskDemo'
    # 动态追踪修改设置，如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    #查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)


# 数据库初始化
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)

# 创建模型
class User(db.Model):
    """用户"""
    # 模型相关声明
    __tablename__ = "user"

    # 模型字段信息
    id = db.Column(db.Integer, primary_key=True, comment="ID")
    name = db.Column(db.String(20), index=True, comment="用户名")
    age = db.Column(db.Integer, nullable=True, comment="年龄")
    sex = db.Column(db.Boolean, default=True, comment="性别")
    created_time = db.Column(db.DateTime, comment="创建时间")
    role = db.Column(db.SmallInteger, db.ForeignKey("role.id") ) # role.id 是表名和表字段名

    # 自定义模型操作方法
    def __repr__(self):
        """当把模型输出时，展示的内容"""
        return "%s" % self.name

class Role(db.Model):
    """角色"""
    __tablename__ = "role"

    id = db.Column(db.SmallInteger, primary_key=True, comment="ID")
    name = db.Column(db.String(20), index=True, comment="角色名")
    # 注意，这个user_list不是字段，不会在创建表的时候，加入到数据中，这个字段是ORM自己处理的。
    user_list = db.relationship("User", backref='role')

    def __repr__(self):
        return "%s" % self.name

@app.route("/")
def index():
    return "ok"


if __name__ == '__main__':
    # 创建所有表, 根据当前系统应用中模型对应的数据表
    # db.create_all()
    # 删除所有表
    # db.drop_all()

    app.run(host="0.0.0.0", port=8080,debug=True)

常用的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对象，它包含指定范围内的结果

创建表：

db.create_all()  # 注意，create_all()方法执行的时候，需要放在模型的后面

删除表

db.drop_all()

插入一条数据

# 添加一个数据
role1 = Role(name="青铜会员")
db.session.add(role1)
db.session.commit()

一次插入多条数据

# 添加批量数据
# user1 = User(name="小明1号", age=12, sex=True)
user2 = User(name="小明2号", age=14, sex=True)
user3 = User(name="小明3号", age=16, sex=True)
user4 = User(name="小明4号", age=20, sex=True)
user5 = User(name="小红1号", age=22, sex=False)
user6 = User(name="小红2号", age=23, sex=False)
user7 = User(name="小红3号", age=26, sex=True)
user8 = User(name="小黑1号", age=10, sex=True)
user9 = User(name="小黑2号", age=30, sex=True)
user10 = User(name="小黑3号", age=16, sex=True)
db.session.add_all([user2, user3, user4, user5, user6, user7, user8, user9, user10])
db.session.commit()

查询数据代码

@app.route("/select")
def select():
    """查询数据"""
    """使用filter_by来查询，只能编写=号条件查询字段内容"""
    # user = User.query.filter_by(name="小明1号").first()  # first() 表示只返回匹配到的第一个结果
    # print(user)  # 小明1号
    # # 查询模型对象的数据
    # print(user.age)  # 12
    # print(user.name)  # 小明1号

    # user_list = User.query.filter_by(sex=True).all()  # all() 表示返回能匹配到的所有结果
    # print(user_list)  # [小明1号, 小明2号, 小明3号, 小明4号, 小红3号, 小黑1号, 小黑2号, 小黑3号]

    """使用filter来模糊查询，filter会比filter_by支持更多的判断和查询条件"""
    # user = User.query.filter(User.name == "小明1号").first()
    # print(user)  # 小明1号

    user_list = User.query.filter(User.age < 14).all()
    print(user_list)  # [小明1号, 小黑1号]
    return "查询成功"

filter_by精确查询

first()返回查询到的第一个对象

"""使用filter_by来查询，只能编写=号条件查询字段内容"""
user = User.query.filter_by(name="小明1号").first()  # first() 表示只返回匹配到的第一个结果
print(user)  # 小明1号
# 查询模型对象的数据
print(user.age)  # 12
print(user.name)  # 小明1号

all()返回查询到的所有对象

user_list = User.query.filter_by(sex=True).all()  # all() 表示返回能匹配到的所有结果
print(user_list)  # [小明1号, 小明2号, 小明3号, 小明4号, 小红3号, 小黑1号, 小黑2号, 小黑3号]

filter模糊查询，返回名字结尾字符为g的所有数据。

"""使用filter来模糊查询，filter会比filter_by支持更多的判断和查询条件"""
user = User.query.filter(User.name == "小明1号").first()
print(user)  # 小明1号

user_list = User.query.filter(User.age < 14).all()
print(user_list)  # [小明1号, 小黑1号]

get():参数为主键，如果主键不存在没有返回内容

User.query.get()

逻辑非，返回名字不等于wang的所有数据

User.query.filter(User.name!='wang').all()

not_ 相当于取反

from sqlalchemy import not_
User.query.filter(not_(User.name=='chen')).all()

逻辑与，需要导入and，返回and()条件满足的所有数据

from sqlalchemy import and_
User.query.filter(and_(User.name!='wang',User.email.endswith('163.com'))).all()

逻辑或，需要导入or_

from sqlalchemy import or_
User.query.filter(or_(User.name!='wang',User.email.endswith('163.com'))).all()

查询数据后删除

@app.route("/delete")
def delete():
    """删除数据"""
    try:
        user = User.query.filter(User.name=="小明4号").first()
        db.session.delete(user)
        db.session.commit()
    except:
        return "查无此人或已经删除！"
    return "删除成功"

更新数据

@app.route("/update")
def update():
    """修改数据"""
    user = User.query.filter(User.name=="小明2号").first()
    user.age = 26
    db.session.commit()
    return "修改成功"

查询所有用户数据
查询有多少个用户
查询第1个用户
查询id为4的用户[3种方式]  filter  和 filter_by 和 get 3种
查询名字结尾字符为g的所有数据[开始/包含]
查询名字不等于wang的所有数据[2种方式]
查询age是 14 或者 `age` 以 12 的所有用户
查询id为 [1, 3, 5, 7, 9] 的用户列表
查询所有女生数据，并以年龄排序
每页3个，查询第2页的数据

模型之前的关联

一对多

class Role(db.Model):
    ...
    #关键代码
    user_list = db.relationship('User', backref='myrole', lazy='dynamic')
    ...

class User(db.Model):
    ...
    role = db.Column(db.Integer, db.ForeignKey('roles.id'))

其中realtionship描述了Role和User的关系。在此文中，第一个参数为对应参照的类"User"
第二个参数backref为类User申明新属性的方法
第三个参数lazy决定了什么时候SQLALchemy从数据库中加载外键模型数据
- 如果设置为子查询方式(subquery)，则会在加载完Role对象后，就立即加载与其关联的对象，这样会让总查询数量减少，但如果返回的条目数量很多，就会比较慢
  - 设置为 subquery 的话，role.users 返回所有数据列表
- 另外,也可以设置为动态方式(dynamic)，这样关联对象会在被使用的时候再进行加载，并且在返回前进行过滤，如果返回的对象数很多，或者未来会变得很多，那最好采用这种方式
  - 设置为 dynamic 的话，role.users 返回查询对象，并没有做真正的查询，可以利用查询对象做其他逻辑，比如：先排序再返回结果

多对多

registrations = db.Table('registrations',  
    db.Column('student_id', db.Integer, db.ForeignKey('students.id')),  
    db.Column('course_id', db.Integer, db.ForeignKey('courses.id'))  
)

class Course(db.Model):
    ...

class Student(db.Model):
    ...
    courses = db.relationship('Course',secondary=registrations,  
                                    backref='students',  
                                    lazy='dynamic')

关联查询

角色和用户的关系是一对多的关系，一个角色可以有多个用户，一个用户只能属于一个角色。

查询角色的所有用户

#查询roles表id为1的角色
ro1 = Role.query.get(1)
#查询该角色的所有用户
ro1.us.all()

查询用户所属角色

#查询users表id为3的用户
us1 = User.query.get(3)
#查询用户属于什么角色
us1.role

数据库迁移

在开发过程中，需要修改数据库模型，而且还要在修改之后更新数据库。最直接的方式就是删除旧表，但这样会丢失数据。
更好的解决办法是使用数据库迁移框架，它可以追踪数据库模式的变化，然后把变动应用到数据库中。
在Flask中可以使用Flask-Migrate扩展，来实现数据迁移。并且集成到Flask-Script中，所有操作通过命令就能完成。
为了导出数据库迁移命令，Flask-Migrate提供了一个MigrateCommand类，可以附加到flask-script的manager对象上。

首先要在虚拟环境中安装Flask-Migrate。

pip install flask-migrate==2.7.0

代码文件内容：

from flask import Flask
from flask_migrate import Migrate, MigrateCommand
from flask_script import Manager
app = Flask(__name__)
manager = Manager(app)

class Config():
    DEBUG = True
    # 数据类型://登录用户:登录密码@数据库IP或地址:端口/数据库名?charset=utf8
    SQLALCHEMY_DATABASE_URI = 'mysql://root:123@127.0.0.1:3306/flaskDemo?charset=utf8'
    # 动态追踪修改设置，如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    #查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True

app.config.from_object(Config)

# 数据库初始化
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)

# 对数据迁移类进行初始化
migrate = Migrate(app, db)
# 把数据迁移的相关命令添加到项目中进行注册
manager.add_command("db", MigrateCommand)

# 创建模型
class Student(db.Model):
    """学生"""
    # 模型相关声明
    __tablename__ = "student"

    # 模型字段信息
    id = db.Column(db.Integer, primary_key=True, comment="ID")
    name = db.Column(db.String(20), index=True, comment="用户名")
    age = db.Column(db.Integer, nullable=True, comment="年龄")
    achievement = db.relationship("Achievement", backref="student",lazy="dynamic")
    # 自定义模型操作方法
    def __repr__(self):
        """当把模型输出时，展示的内容"""
        return "%s" % self.name

class Course(db.Model):
    """课程"""
    __tablename__ = "course"

    id = db.Column(db.SmallInteger, primary_key=True, comment="ID")
    name = db.Column(db.String(20), index=True, comment="课程名称")
    achievement = db.relationship("Achievement", backref="course", lazy="dynamic")
    def __repr__(self):
        return "%s" % self.name

# 创建关系模型
class Achievement(db.Model):
    """成绩"""
    __tablename__= "mychievement"
    id = db.Column(db.Integer, primary_key=True, comment="ID")
    score = db.Column(db.Numeric(4,1), default=0, comment="分数")
    student_id = db.Column(db.Integer, db.ForeignKey("student.id"), comment="学生")
    course_id = db.Column(db.SmallInteger, db.ForeignKey("course.id"), comment="课程")

    def __repr__(self):
        return "%s-%s-%s" % (self.student.name, self.course.name, self.score)

@app.route("/")
def select():
    return "ok"

if __name__ == '__main__':
    manager.run()

创建迁移仓库（先把数据库里表都删干净）

#这个命令会创建migrations文件夹，所有迁移文件都放在里面。
python manage.py db init

创建迁移脚本

自动创建迁移脚本有两个函数
- upgrade()：函数把迁移中的改动应用到数据库中。
- downgrade()：函数则将改动删除。
自动创建的迁移脚本会根据模型定义和数据库当前状态的差异，生成upgrade()和downgrade()函数的内容。
对比不一定完全正确，有可能会遗漏一些细节，需要进行检查

python manage.py db migrate -m 'initial migration'

更新数据库

python manage.py db upgrade

返回以前的版本

可以根据history命令找到版本号,然后传给downgrade命令:

python manage.py db history

输出格式：<base> ->  版本号 (head), initial migration

回滚到指定版本[升级也可以指定版本号]

python manage.py db downgrade # 默认返回上一个版本
python manage.py db downgrade 版本号   # 返回到指定版本号对应的版本

数据迁移的步骤:

1. 初始化数据迁移的目录
python manage.py db init

2. 数据库的数据迁移版本初始化
python manage.py db migrate -m 'initial migration'

3. 升级版本[创建表]
python manage.py db upgrade 

4. 降级版本[删除表]
python manage.py db downgrade

github: https://github.com/joke2k/faker

from flask import Flask
from flask_migrate import Migrate, MigrateCommand
from flask_script import Manager, Command

app = Flask(__name__)
manager = Manager(app)


class Config():
    DEBUG = True
    # 数据类型://登录用户:登录密码@数据库IP或地址:端口/数据库名?charset=utf8
    SQLALCHEMY_DATABASE_URI = 'mysql://root:123@127.0.0.1:3306/flaskDemo?charset=utf8'
    # 动态追踪修改设置，如未设置只会提示警告
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    # 查询时会显示原始SQL语句
    SQLALCHEMY_ECHO = True


app.config.from_object(Config)

# 数据库初始化
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy(app)

# 对数据迁移类进行初始化
migrate = Migrate(app, db)
# 把数据迁移的相关命令添加到项目中进行注册
manager.add_command("db", MigrateCommand)


# 创建模型
class Student(db.Model):
    """学生"""
    # 模型相关声明
    __tablename__ = "student"
    # 模型字段信息
    id = db.Column(db.Integer, primary_key=True, comment="ID")
    name = db.Column(db.String(20), index=True, comment="用户名")
    mobile = db.Column(db.String(20), unique=True, comment="手机号码")
    email = db.Column(db.String(100), unique=True, comment="邮箱地址")
    address = db.Column(db.String(500), default=None, nullable=True, comment="地址")
    birth = db.Column(db.DateTime, default=None, nullable=True, comment="出生年月")

    # 自定义模型操作方法
    def __repr__(self):
        return self.name


from faker import Faker


class FakerCommand(Command):
    """生成测试数据"""

    def run(self):
        """调用模型来生成数据"""
        faker = Faker(locale="zh_CN")
        for _ in range(0, 100):
            student = Student(
                name=faker.name(),
                mobile=faker.phone_number(),
                email=faker.email(),
                address=faker.address(),
                birth=faker.date_of_birth(minimum_age=0, maximum_age=60)

            )
            db.session.add(student)
        db.session.commit()

manager.add_command("faker", FakerCommand)

if __name__ == '__main__':
    manager.run()

执行命令生成数据

python manage.py faker

flask-session

允许设置session到指定存储的空间中, 文档:

安装命令: https://pythonhosted.org/Flask-Session/

pip install Flask-Session

使用session之前,必须配置一下配置项:

SECRET_KEY = "QFLNQIWFHOW,1pr32k4pEIFH" # session秘钥

redis基本配置

from flask import Flask, session
from redis import Redis
from flask_session import Session
app = Flask(__name__)

class Config():
    DEBUG = True
    SECRET_KEY = "QFLNQIWFHOW,1pr32k4pEIFH"
    """ 把session保存到redis中 """
    SESSION_TYPE = "redis"  # session存储方式为redis
    # session保存数据到redis时启用的连接对象
    SESSION_REDIS = Redis(host="127.0.0.1", port="6379", db=1)  # 用于链接redis的配置
    # 如果设置session的生命周期是否是会话期，为True, 则关闭浏览器session就失效
    SESSION_PERMANENT = False
    # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_USE_SIGNER = False
    # 保存到redis的session数据的键名称前缀
    SESSION_KEY_PREFIX = "session:"

app.config.from_object(Config)

Session(app)

@app.route("/")
def set():
    session["user"] = "xiaoming"
    return "ok"

@app.route("/get")
def get():
    user = session["user"]
    return f"ok! {user}"

if __name__ == '__main__':
    app.run()

SQLAlchemy基本配置

from flask import Flask, session
from flask_session import Session
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
db = SQLAlchemy()

class Config():
    DEBUG = True
    SECRET_KEY = "qwfkpwekrf12#!$@#$#%35"  # session秘钥
    # 数据库配置
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/flaskDemo"
    # 设置mysql的错误跟踪信息显示
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 打印每次模型操作对应的SQL语句
    SQLALCHEMY_ECHO = True

    """把session保存到mysql中"""
    SESSION_TYPE = 'sqlalchemy'  # session类型为sqlalchemy
    SESSION_SQLALCHEMY = db  # SQLAlchemy对象
    SESSION_SQLALCHEMY_TABLE = 'session'  # session要保存的表名称
    SESSION_PERMANENT = True  # 如果设置为True，则关闭浏览器session就失效。
    SESSION_USE_SIGNER = False  # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_KEY_PREFIX = 'session:'  # 保存到session中的值的前缀

app.config.from_object(Config)

# 让数据库在创建对象之后进行初始化
db.init_app(app)

Session(app)

@app.route("/")
def set():
    session["user"] = "xiaoming"
    return "ok"

@app.route("/get")
def get():
    user = session["user"]
    return f"ok! {user}"

if __name__ == '__main__':
    with app.app_context():  # 把session表创建进来
        db.create_all()
    app.run()

posted @ 2022-07-31 20:41 归来人少年阅读(284) 评论(0) 编辑收藏举报

刷新页面返回顶部

登录后才能查看或发表评论，立即登录或者逛逛博客园首页

相关博文：

· Flask入门（路由和http请求）

· flask请求钩子、异常捕获、上下文、jinjia2模板引擎、解决CSRF攻击

· flask-3

· Flask学习（三）

· Flask-SQLAlchemy flask-migrate mysql用法记录

公告

昵称：归来人少年
园龄： 4年9个月
粉丝： 2
关注： 0

+加关注

2025年3月

日

一

二

三

四

五

六

随笔档案

2022年7月(16)

顶级的欲望通过煎熬才能获得

无论人生上到哪一层台阶，阶下有人在仰望你，阶上亦有人在俯视你。你抬头自卑，低头自得，唯有平视，才能看见真正的自己。