依照惯例,本文开头先提供Flask-SQLAlchemy的官方文档地址
Flask
框架之所以强大有一个重要因素是良好的生态系统支持用户对原框架进行扩展,Flask-SQLAlchemy
就是一个扩展插件,其作用是帮助用户操作数据库(增、删、改、查、创表、提交事务等等),或者说这是一个ORM
插件(O
-Object
、R
-Relational
、M
-Mapping
,简言之就是用对象去表达数据结构的插件)。显然,使用Flask-SQLAlchemy
最大的好处就是操作不同的数据库时不必关注数据库特异性,一套代码重复利用。
使用Flask-SQLAlchemy
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
db = SQLAlchemy(app)
引入flask_sqlalchemy
插件,调用SQLAlchemy
和flask app
绑定
调用
SQLAlchemy
是因为这是flask_sqlalchemy
提供的一个__init__
函数,源码:#: Default query class used by :attr:`Model.query` and other queries. #: Customize this by passing ``query_class`` to :func:`SQLAlchemy`. #: Defaults to :class:`BaseQuery`. Query = None def __init__(self, app=None, use_native_unicode=True, session_options=None, metadata=None, query_class=BaseQuery, model_class=Model): self.use_native_unicode = use_native_unicode self.Query = query_class self.session = self.create_scoped_session(session_options) self.Model = self.make_declarative_base(model_class, metadata) self._engine_lock = Lock() self.app = app _include_sqlalchemy(self, query_class) if app is not None: self.init_app(app)
PS:通过看源码应该能发现调用
SQLAlchemy
时app
是可以不用传入的,可以初始化时再调用init_app
传入app
,这特别适用于工厂函数创建app
的情况
使用Flask-SQLAlchemy
创建表
class User(db.Model):
__tablename__ = 'users'
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def __repr__(self):
return '<User %r>' % self.username
核心是创建一个类继承Model
属性(Model
属性是啥,可以按照上面的源码去查看)
这里讲一下代码含义:
-
__tablename__ = 'users'
是给表命名(这句也可以省略,但是一般表名还是推荐自己取) -
这部分是添加表的字段,以及相应字段的属性id = db.Column(db.Integer, primary_key=True) username = db.Column(db.String(80), unique=True, nullable=False) email = db.Column(db.String(120), unique=True, nullable=False)
-
这两行是def __repr__(self): return '<User %r>' % self.username
python
对象的__repr__
方法,重写是为了方便程序员查看对象,不属于flask-sqlalchemy
提供的特殊内容
当然,这是最简单的数据表,实际操作中肯定会涉及到数据表的互相关联。这一部分实际是数据库的基础知识而不是Flask-SQLAlchemy
的独特内容。简单提一下Flask-SQLAlchemy
是有APIForeignKey
、relationship
帮助我们创表时关联数据表的。具体内容可以查看上面的官方文档。
使用Flask-SQLAlchemy
进行增、删、改、查
做数据库基本操作必然涉及到数据库事务,这里先说如何使用SQLAlchemy
提交事务
db.session.add(xxx)
db.session.delete(xxx)
db.session.commit()
session
API中带有add
、delete
等方法,直接调用即可,最后再commit
。当然,如同写SQL
语句一样,针对不同的操作还有更多API,例如session.add_all()
、session.rollback()
等等,这里不详述了。
前面说了相关的API,现在总结一下增、删、改、查具体操作。
from yourapp import User
me = User('admin', 'admin@example.com')
db.session.add(me)
db.session.commit()
以添加一条记录为例,所有的执行都是遵循三个步骤
- 创建一个python对象(这个对象是相应数据表类的一个实例,也就是相应数据表的一条记录)
- 调用
session
中的API - 提交事务
db.session.delete(me)
db.session.commit()
删除一条记录也是类似的
admin = Role.query.filter_by(name='Admin').first()
查询表中某条记录可以直接调用对象的query
方法,相当于SELECT
语句
admin = Role.query.filter_by(name='Admin').first()
if admin is not None:
admin.name = 'admin'
db.session.add(admin)
db.session.commit()
修改记录可以综合查找和添加两步:
- 查出记录
- 修改
- 提交
至此,使用Flask-SQLALchemy
进行数据库基本操作已经都介绍完了,复杂的用法请查看开头的官方文档。