Flask-SQLAlchemy

简介与安装

SQLAlchemy是一个强大的关系型数据库框架，支持多种数据库后台。SQLAlchemy提供了高层ORM，也提供了使用数据库原生SQL的低层功能
alchemy 读作#ˈælkəmi

安装：pip install flask-sqlalchemy

FLask-SQLAlchemy数据库URL

SQLite 数据库不需要使用服务器，因此不用指定 hostname、username 和password。
URL 中的 database 是硬盘上文件的文件名

SQLAlchemy常用列类型

SQLAlchemy常用列选项

SQLAlchemy常用关系

配置信息

必须配置 SQLALCHEMY_DATABASE_URI
建议将SQLALCHEMY_TRADE_CONDIFITION 设为False，降低内存消耗

from flask import Flask
import os
from flask_sqlalchemy import SQLAlchemy
app = Flask(__file__)
basedir = os.path.asbpath(os.path.dirname(__file__))
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + basedir + '\\dev-data.sqlite'
app.config['SQLALCHEMY_TRADE_CONDIFITION'] = False

创建db实例

# ...
db = SQLAlchemy(app)

定义模型

定义表名及表字段
hello.py

#...
class Role(db.model):
    __tabelname__ = "roles" #表名,如果未设置,SQLAlchemy会使用一个默认名字
    id = db.Column(db.Integer, primary_key=True) #行,id,主键
    name = db.Column(db.String(64), unique=True) #name字段,唯一
    users = db.relationship('User', backref='role') # backref定义的值，是后续创建user外键行时需要参数
    def __perp__(self):
        return "<Role %r>', % self.name
class User(db.model):
    __tablename__ = "users"
    id = db.column(db.Integer, primary_key=True)
    username = db.Column(db.String(64), unique=True, index=True)
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))
    def __perp__(self):
        return "<User %r>', % self.username

数据库操作

生成表

不存在数据库时，会生成数据库。
如果已存在数据表，db.create_all()将不会重新创建或者更新对应的表

# flask shell 进入交互界面
from hello import db # 是在hello中定义的模型
db.create_all()

删除表

修改模型后，需要更新表，则需要删除所有表，然后再重新生成。
但是该种方式会将数据库中原有数据都清除

db.drop_all()
db.create_all()

会话（db.session）

对数据库的改动通过会话进行管理，把数据写入库之前，需要先添加到会话中

db.session.add(xxx) # 添加会话
db.session.add_all([xxx,aaa])
db.session.commit() # 将会话中的数据提交到数据库
db.session.rollback() # 添加到数据库会话中的所有对象都还原到数据库中的状态

增加行

from hello import Role, User
admin_role = Role(name='admin')
user_role = Role(username='user', role=admin_role)
db.session.add(admin_role)
db.session.add(user_role)
# 批量添加db.session.add_all([admin_role , user_role])
db.session.commit()

修改行

admin_role.name = 'administrator'
db.session.add(admin_role)
db.session.commit()

删除行

db.session.delete(user_role)
db.session.commit()
#若要重新创建user_role字段,使用db.sesson.transient(user_role)恢复,后再add\commit

查询行

>>>Role.query.all()
[<Role 'admin'>, <Role 'Moderator'>, <Role 'User'>]
Role.query.first()
<Role 'admin'>
User.query.filter_by(role=user_role).all()
[<User 'admin'>]
>>> Role.query.limit(2).all()
[<Role 'admin'>, <Role 'Moderator'>]
>>>admin_role = Role.query.filter_by(name='admin').first()
>>>admin_role.users # Role模型中，users未添加lazy=dynamic属性时，会默认自动执行all(),此时query对象隐藏起来了，无法增加精确筛选
[<User 'admin'>]

常用的查询过滤器

最常使用的查询执行函数

集成python shell

每次启动shell都要导入数据库实例和模型，避免重复工作，我们可以做些配置自动导入这些对象。
hello.py

# ...
@app.shell_context_processor
def make_shell_context():
    return dict(db=db, User=User, Role=Role)

flask shell
>>> app
<Flask 'hello'>
>>> db

数据库迁移

在开发过程中需要对数据库结构进行修改，修改完模型后，需要更新数据库。

db.create_all()在存在表时，不会重新生成表，必须db.drop_all()后重新生成，但是这样会清除历史数据。

安装与初始化

pip install flask-migrate

from flask_migrate import Migrate
# ...
migrate = Migrate(app, db)

新项目中增加数据库迁移

(venv) set FLASK_APP=hello.py
(venv) set FLASK_DEBUG=1
(venv) flask db init

更新数据库

1. 修改模型

   class User(db.model):
    # ...
    password = db.Column(db.String())

2. 在flask shello环境中执行 set FLASK_APP=hello.py

3. 执行flask db migrate,创建一个迁移脚本
4. 检查自动生成的脚本,根据模型实际改动调整(SQLite问题处理)
   1. 比如重命名一列，如果使用自动迁移，会删除一列，再新增一列，导致该列数据被清空
5. flask db upgrade 迁移应用到数据库中

   >>> set FLASK_APP=hello.py
   >>> flask db migrate
   >>> flask db upgrade