Flask-SQLAlchemy常用字段介绍

前言

这几年一直在it行业里摸爬滚打，一路走来，不少总结了一些python行业里的高频面试，看到大部分初入行的新鲜血液，还在为各样的面试题答案或收录有各种困难问题

于是乎，我自己开发了一款面试宝典，希望能帮到大家，也希望有更多的Python新人真正加入从事到这个行业里，让python火不只是停留在广告上。

微信小程序搜索：Python面试宝典

或可关注原创个人博客：https://lienze.tech

也可关注微信公众号，不定时发送各类有趣猎奇的技术文章：Python编程学习

Flask-SQLAlchemy

SQLAlchemy是一个ORM框架，可以不局限于框架或位置使用

而Flask-SQLAlchemy是一个Flask扩展，简化了在Flask程序中使用SQLAlchemy的操作，并且可以支持多种数据库后台

---

扩展安装

pip3 install Flask-SQLAlchemy
pip3 install flask-migrate
pip3 install flask_script
pip3 install mysqlclient

迁移集成

默认的Flask-SQLAlchemy并不能像django的orm一样，进行动态迁移，改变数据库状态，只能使用对象db的.create_all等方法进行数据库的管理

因此我们使用flask-migrate就解决这个问题，flask-migrate可以直接将修改的东西映射到数据库中，这一小节首先配置flask-migrate

---

首先我们创建一个最基本的含有蓝图的项目结构用来实现一个简单实用Flask-SQLAlchemy结合flask-migrate使用的例子

并且采用工厂模式创建flask应用对象，下面是目录结构

flaskProject/
	ext.py
	manage.py
	settings.py
	app.py
	user/
		__init__.py
		models.py
		views.py

• ext.py

  扩展插件，数据库配置文件，单独写入该文件下，避免循环引入

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

• manage.py

  命令行管理文件，在这个文件进行app的manager初始化，migrate命令的支持添加等等

from flask_migrate import Migrate, MigrateCommand
from ext import db
from flask_script import Manager
from app import create_app

app = create_app() # 实例化flask的app对象
manager = Manager(app)  # 实例化一个manager对象
Migrate(app, db)  # 迁移命令管理与app,建立关系

manager.add_command('db', MigrateCommand)  # 添加迁移命令集 到脚本命令

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

• app.py

  代码入口文件，进行配置选择，蓝图注册，服务启动等功能

from flask import Flask
from ext import db


def create_app(config="settings.py"):
    app = Flask(__name__)
    app.config.from_pyfile(config)

    from user.views import user_blueprint
    app.register_blueprint(user_blueprint)

    db.init_app(app)
    return app


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

• settings.py

  配置文件，用来存放项目配置、数据库连接等有关数据

其余配置项参考: https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/#configuration-keys

# 设置连接数据库的URL
SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://root:mysql@127.0.0.1:3306/flasktest'
# 设置每次请求结束后会自动提交数据库中的改动
SQLALCHEMY_COMMIT_ON_TEARDOWN = True
# 如果设置为True，Flask-SQLAlchemy将跟踪对象的修改并发出信号。默认值为None
SQLALCHEMY_TRACK_MODIFICATIONS = True
# 查询时会显示原始SQL语句
SQLALCHEMY_ECHO = True

数据库连接URL配置参考

dialect+driver://username:password@host:port/database

参数名	解释
SQLALCHEMY_DATABASE_URI	用于连接的数据库 URI 。例如:sqlite:tmp/test.dbmysql://username:password@server/db
SQLALCHEMY_BINDS	一个映射 binds 到连接 URI 的字典。更多 binds 的信息见用 Binds 操作多个数据库。
SQLALCHEMY_ECHO	如果设置为Ture， SQLAlchemy 会记录所有 发给 stderr 的语句，这对调试有用。(打印sql语句)
SQLALCHEMY_RECORD_QUERIES	可以用于显式地禁用或启用查询记录。查询记录 在调试或测试模式自动启用。更多信息见get_debug_queries()。
SQLALCHEMY_NATIVE_UNICODE	可以用于显式禁用原生 unicode 支持。当使用 不合适的指定无编码的数据库默认值时，这对于 一些数据库适配器是必须的（比如 Ubuntu 上 某些版本的 PostgreSQL ）。
SQLALCHEMY_POOL_SIZE	数据库连接池的大小。默认是引擎默认值（通常 是 5 ）
SQLALCHEMY_POOL_TIMEOUT	设定连接池的连接超时时间。默认是 10 。
SQLALCHEMY_POOL_RECYCLE	多少秒后自动回收连接。这对 MySQL 是必要的， 它默认移除闲置多于 8 小时的连接。注意如果 使用了 MySQL ， Flask-SQLALchemy 自动设定 这个值为 2 小时。

建表

找到app的models文件夹下，使用ext目录下初始化好的db对象进行orm表的编写

class Users(db.Model):
    __tablename__ = 'users'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(32), index=True, nullable=False)
    age = db.Column(db.String(2), index=True, nullable=False)

    def __init__(self, name, age):
        self.name = name
        self.age = age

引入模型

建立好的表，为了能够让flask-migrate捕捉到模型类上下文变化，需要在manage.py文件中引入app下的models文件

from user import models  # 导入你想要迁移的数据表的ORM类

执行迁移

• 初始化，只执行一次

python3 manage.py db init

• 生成迁移文件，等同于django的makemigartions

python3 manage.py db migrate

• 迁移

python3 manage.py db upgrade

---

• 返回之前数据库版本

python3 manage.py db history

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

• 回滚到指定版本

python3 manage.py db downgrade 版本号

常用字段

类型名	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	二进制文件

常用字段选项

选项名	说明
primary_key	如果为True，代表表的主键
unique	如果为True，代表这列不允许出现重复的值
index	如果为True，为这列创建索引，提高查询效率
nullable	如果为True，允许有空值，如果为False，不允许有空值
default	为这列定义默认值

常用关系选项

选项名	说明
backref	在关系的另一模型中添加反向引用
primary join	明确指定两个模型之间使用的联结条件
uselist	如果为False，不使用列表，而使用标量值
order_by	指定关系中记录的排序方式
secondary	指定多对多关系中关系表的名字
secondary join	在SQLAlchemy中无法自行决定时，指定多对多关系中的二级联结条件