falsk 使用ORM访问SQL数据库

2020-12-15 00:36:19 编辑 0 阅读量:617

在flask使用SQL数据库（MySQL， Sqlite3等）时，强烈推荐使用flask_sqlalchemy和flask_migrate。
- flask_sqlalchemy：集成sqlalchemy，既可以使用ORM也可以直接执行原生SQL语句，普通查询都使用ORM，更容易理解维护，而且效率不会低到哪里去，然后比较复杂的语句可以写SQL语句，兼顾维护性和效率
- flask_migrate： 用来初始化、更新数据库表结构。可以持续记录每个数据库表结构的变动，而且可以生成更新脚本，人工审阅之后再执行，安全又有迹可循

一般的用法是，用flask_sqlalchemy创建基本的数据结构，然后用flask_migrate生成表，现在来创建一个最简单的应用

#### 一、创建一个最简单的应用

```
$ virtualenv env   # 关于virtualenv的说明请谷歌或百度
$ . env/bin/activate
(env) $ pip install flask_migrate  # 会包含flask和flask_sqlalchemy
(env) $ vim hello_db.py  # 添加一下内容，主要是定义数据库用什么，表结构是什么样的，以及最简单的一个路由
# coding: utf-8

import os

from flask import Flask, request
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate

basedir = os.path.abspath(os.path.dirname(__file__))

app = Flask(__name__)
# 使用sqlite3作为数据库
app.config['SQLALCHEMY_DATABASE_URI'] =\
    'sqlite:///' + os.path.join(basedir, 'data.sqlite')
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

# 初始化sqlalchemy和migrate
db = SQLAlchemy(app)
migrate = Migrate(app, db)

class User(db.Model):
    __tablename__ = 'users'  # 表名，必填
    id = db.Column(db.Integer, primary_key=True)  # 主键，最好都设置为id
    username = db.Column(db.String(64), unique=True, index=True)

def __repr__(self):
        return '<User %r>' % self.username

@app.route('/', methods=['GET'])
def index():
    username = request.args.get("username", '')  # 通过GET获取参数
    if not username:
        return 'please input username in params'
    user = User.query.filter_by(username=username).first()
    if user is None:
        user = User(username=username)
        db.session.add(user)  # db.session和flask 的session是完全不同的内容
        db.session.commit()
    print(User.query.all())
    return "hello: %s", username

if __name__ == "__main__":
    app.debug = True
    app.run(host='0.0.0.0', port=5001)
```
保存为hello_db.py,然后运行`$ python hello_db.py`
访问`http://your_ip:5001?username=ctg`，很明显，报错了，因为数据库还没创建

#### 二、生成数据库
```
(env) $ export FLASK_APP=hello_db.py  # 设置应用
(env) $ flask db  # 可以看到一大堆的参数
Usage: flask db [OPTIONS] COMMAND [ARGS]...

Perform database migrations.

Options:
  --help  Show this message and exit.

Commands:
  branches   Show current branch points
  current    Display the current revision for each...
  downgrade  Revert to a previous version  # 回退数据库中的表结构
  edit       Edit a revision file
  heads      Show current available heads in the script...
  history    List changeset scripts in chronological...
  init       Creates a new migration repository.  # 用且仅在初始化数据库时使用
  merge      Merge two revisions together, creating a new...
  migrate    Autogenerate a new revision file (Alias for...  # 每次在代码中改变数据库表结构后，必须先执行
  revision   Create a new revision file.
  show       Show the revision denoted by the given...
  stamp      'stamp' the revision table with the given...
  upgrade    Upgrade to a later version  # 在migrate后执行，表示将代码的表结构变动更新到数据库中
  
(env) # flask db init   # 在当前目录生成migrations
(env) # flask db migrate -m 'init'  # 类似于git的提交方式，一定要带上-m，不然以后自己都可能看不懂变更了什么。根据提示，去查看migrations/versions/里面的脚本，就是该脚本对数据库做出变更，如果觉得脚本没问题，就继续
(env) # flask db upgrade  # 至此，数据库已建立
```

#### 三、使用数据库
运行`$ python hello_db.py`
访问`http://your_ip:5001?username=ctg`， 改变参数，可以看到命令行输出不同的用户

#### 四、数据库变更
每次变更，都按以下顺序执行：
1. 修改代码中的数据库表结构
2. 执行flask db migrate
3. 审查migrations/versions/中的脚本
4. 执行flask db upgrade

#### 五、其他
##### 5.1 sqlite3里面，千万不要从model.py中删除column！ 这一点非常重要，因为根据我查到到资料显示，sqlite是没有“删除行”这一个选项的。如果你删除了某个column，这一操作能被migrate正确记录，但是在你upgrade的时候就会报错。然后想要还原migrate版本？
##### 5.2 在创建本地数据库的时候，不要在 py shell 环境下执行 db.create_all()，这样没法记录表结构

---
参考：
- [1][创建和部署flask中有关migrate可能遇到的问题](http://blog.csdn.net/kkevinyang/article/details/52183768)
- [2][Python的Flask框架中使用Flask-Migrate扩展迁移数据库的教程](http://www.jb51.net/article/86609.htm)
- [3][Flask 插件系列 - Flask-SQLAlchemy](http://python.jobbole.com/86797/)

falsk 使用ORM访问SQL数据库

附件: