Flask之SQLAlchemy

Flask之SQLAlchemy

1. 简介

   SQLAlchemy是Python编程语言下的一款开源软件。提供了SQL工具包及对象关系映射（ORM）工具，使用MIT许可证发行。

   SQLAlchemy“采用简单的Python语言，为高效和高性能的数据库访问设计，实现了完整的企业级持久模型”。

   SQLAlchemy首次发行于2006年2月，并迅速地在Python社区中最广泛使用的ORM工具之一，不亚于Django的ORM框架。

   Flask-SQLAlchemy是在Flask框架的一个扩展，其对SQLAlchemy进行了封装，目的于简化在 Flask 中 SQLAlchemy 的 使用，提供了有用的默认值和额外的助手来更简单地完成日常任务。

2. 安装

   安装Flask-SQLAlchemy

   pip install flask-sqlalchemy
   

   如果使用的是MySQL数据库，还需要安装MySQL的Python客户端库

   pip install mysqlclient
   

3. 数据库连接设置

   在Flask中使用Flask-SQLAlchemy需要进行配置，主要配置以下几项：

   1. SQLALCHEMY_DATABASE_URI 数据库的连接信息：

      Postgres:
      postgresql://user:password@localhost/mydatabase
      MySQL:
      mysql://user:password@localhost/mydatabase
      Oracle:
      oracle://user:password@127.0.0.1:1521/sidname
      SQLite （注意开头的四个斜线）:
      sqlite:absolute/path/to/foo.db
      

   2. SQLALCHEMY_TRACK_MODIFICATIONS 在Flask中是否追踪数据修改；

   3. SQLALCHEMY_ECHO 显示生成的SQL语句，可用于调试；

   这些配置参数需要放在Flask的应用配置（app.config）中

   from flask import Flask
   from flask_sqlalchemy import SQLAlchemy
   
   app = Flask(__name__)
   
   # 配置mysql
   class Config(object):
       # 配置数据库
       SQLALCHEMY_DATABASE_URI = 'mysql://root:mysql@127.0.0.1:3306/toutiao'
       # 是否追踪数据的改变，设置为False即可，后面会废弃。
       SQLALCHEMY_TRACK_MODIFICATIONS = False
       # 是否显示sqlalchemy执行的sql语句
       SQLALCHEMY_ECHO = True
   
   app.config.from_object(Config)
   

   其他配置参考如下：

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

4. 模型类字段与选项

   1. 字段类型

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

   2. 列选项

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

   3. 关系选项

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

5. 构建模型类映射

   步骤：

   1. 创建SQLAlchemy对象

      1. 方式一

         db = SQLAlchemy(app)
         

      2. 方式二

         db = SQLAlchemy()
         db.init_app(app)
         

         注意此方式在单独运行调试时，对数据库操作需要在Flask的应用上下文中进行

         with app.app_context():
             User.query.all()
         

   2. 代码示例

      from flask import Flask
      from flask_sqlalchemy import SQLAlchemy
      
      app = Flask(__name__)
      
      # 配置mysql
      class Config(object):
          # 配置数据库
          SQLALCHEMY_DATABASE_URI = 'mysql://root:mysql@127.0.0.1:3306/toutiao'
          # 是否追踪数据的改变，设置为False即可，后面会废弃。
          SQLALCHEMY_TRACK_MODIFICATIONS = False
          # 是否显示sqlalchemy执行的sql语句
          SQLALCHEMY_ECHO = True
      
      app.config.from_object(Config)
      
      # 创建db对象
      db = SQLAlchemy(app)
      # 定义模型类
      class User(db.Model):
          # 指定映射数据库中的哪张表
          __tablename__ = "user_basic"
          # 此类是业务自己用的，跟SQLAlchemy没关系
          class STATUS:
              ENABLE = 1
              DISABLE = 0
          # db.Column的第一个参数映射对应的字段
          id = db.Column('user_id', db.Integer, primary_key=True, doc='用户ID')
          mobile = db.Column(db.String, doc='手机号')
      
      if __name__ == '__main__':
          # 获取所有用户
          users = User.query.all()
          for user in users:
              print(user)