Flask中的ORM - SQLAlchemy

# Django中默认使用sqlite，且提供了ORM框架通过类和对象操作数据库

# Flask当中没有ORM框架，需要引入SQLAlchemy扩展

# pip install flask-sqlalchemy 

# 连接的是mysql数据库需要安装

# pip install flask-mysqldb 

# 设置数据库链接地址：

    app.config['SQLALCHEMY_DATABASE_URI’] = mysql://root:chuanzhi@127.0.0.1:3306/flask_test

# 关闭自动追踪数据库：

    app.config[’SQLALCHEMY_TRACK_MODIFICATION’] = False

---

Flask 数据库设置：

名字	备注
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 小时。

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

 

---

# 定义自定义模型类

    class Role(db.Model):

        __tablename__ = ‘role’

        id = db.Column(db.Integer, primary_key=True)

        name = db.Column(db.String(64), nullable=False, unique=True)

        # lazy, 默认为subquery，自动加载数据库数据，dynamic反之

        users = db.relationship(‘Users’, backref=‘roles’, lazy=‘dynamic')

    

---

# 查询所有用户数据

User.query.all() -> 返回所有的对象，列表显示， 不是queryset

# 查询有多少个用户

User.query.count()

# 查询第1个用户

User.query.first()

# 查询id为4的用户[3种方式]

User.query.get(4)  -> Flask中只能根据id来查，如果查不到不会报错

User.query.filter_by(id=4).first()  -> 精确查询

User.query.filter(User.id == 4).first()  -> 模糊查询， >= 

# 查询名字结尾字符为g的所有数据[开始/包含]

User.query.filter(User.name.endswith('g')).all()

User.query.filter(User.name.startswith('z')).all()

# 查询名字不等于wang的所有数据[2种方式]

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

from sqlalchemy import not_

User.query.filter(not_(User.name == "wang")).all()

# 查询名字和邮箱都以 li 开头的所有数据[2种方式]

User.query.filter(User.name.startswith('li'), User.email.startswith('li')).all()

# 查询password是 `123456` 或者 `email` 以 `itheima.com` 结尾的所有数据

from sqlalchemy import or_

User.query.filter(or_(User.password == '123456', User.email.endswith('itheima.com'))).all()

# 查询id为 [1, 3, 5, 7, 9] 的用户列表

User.query.filter(User.id.in_([1, 3, 5, 7, 9])).all()

# 查询所有用户数据，并以邮箱排序

User.query.order_by(User.email).all()  # 默认升序

User.query.order_by(User.email.desc()).all()

# 每页3个，查询第2页的数据

    # 返回的是pagination对象，如果查不到会返回False

pagination = User.query.paginate(2, 3)

pagination.items  # 当前页对象

pagination.pages  # 总页数

pagination.page   # 当前页页数

---

# 关联查询

# 关联属性users，但是不是列
# backref='role' 代表给User增加属性role 通过user.role可以获得关联属性信息
# lazy 类似于惰性查询，默认subquery，会自动查询关联集对象，dynamic则不会    
users = db.relationship('User', backref='role', lazy='subquery')

# 查询admin角色的所有用户信息

Role.query.filter(Role.name == 'admin').first().users

# 查询id为1 的用户的角色信息

User.query.get(1).role

# lazy = dynamic

In [2]: ro1 = Role.query.get(1)

In [3]: ro1.users

Out[3]: <sqlalchemy.orm.dynamic.AppenderBaseQuery at 0x101f3a510>

In [4]: ro1.users[0]

Out[4]: <User: wang wang@163.com 123456 1>

---

# 数据库的迁移: 避免直接删除数据库，可以通过框架追踪数据库变化

    # pip install flask-migrate

    # manage.add_command(‘db’, MigrateCommand)

    # Migrate(app, db)

# coding=utf-8
from flask import Flask, render_template
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate, MigrateCommand
from flask_script import Manager



app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:chuanzhi@127.0.0.1:3306/flask_migrate'
# 动态追踪数据库
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False


db = SQLAlchemy(app)

# 通过script 以脚本的方式运行服务器
manager = Manager(app)

# 给脚本加入db 指定集
manager.add_command('db', MigrateCommand)

# 创建Migrate类，传入app和db，以迁移方式管理数据库
Migrate(app, db)

class Role(db.Model):
    __tablename__ = 'roles'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(64), nullable=False, unique=True)

    def __repr__(self):
        return '<Role: id=%s, name=%s>' % (self.id, self.name)


@app.route('/')
def index():
    return 'index'

if __name__ == '__main__':
    # app.run(debug=True)
    manager.run()

# 操作指令

    # python manage.py db init 进行数据库管理初始化工作，生成迁移文件夹

    # python manage.py db migrate -m '说明信息' 生成当前版本的迁移文件，仍未操作数据库

    # python manage.py db upgrade 迁移生成数据库中的表
    # python manage.py db upgrade/downgrade <version_num> 升级或者降级到指定版本

    # python manage.py db history 查看数据库迁移历史

    # python manage.py db current 查看当前数据库版本