flask_sqlalchemy介绍
快速入门
Flask-SQLAlchemy 使用起来非常有趣，对于基本应用十分容易使用，并且对于大型项目易于扩展。有关完整的指南，请参阅 SQLAlchemy 的 API 文档。
一个最小应用
常见情况下对于只有一个 Flask 应用，所有您需要做的事情就是创建 Flask 应用，选择加载配置接着创建 SQLAlchemy 对象时候把 Flask 应用传递给它作为参数。
一旦创建，这个对象就包含 sqlalchemy 和 sqlalchemy.orm 中的所有函数和助手。此外它还提供一个名为 Model 的类，用于作为声明模型时的 delarative 基类:
from flask import Flask
from flask.ext.sqlalchemy import SQLAlchemy
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
db = SQLAlchemy(app)
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True)
email = db.Column(db.String(120), unique=True)
def __init__(self, username, email):
self.username = username
self.email = email
def __repr__(self):
return '<User %r>' % self.username
为了创建初始数据库，只需要从交互式 Python shell 中导入 db 对象并且调用 SQLAlchemy.create_all() 方法来创建表和数据库:
>>> from yourapplication import db
>>> db.create_all()
Boom, 您的数据库已经生成。现在来创建一些用户:
>>> from yourapplication import User
>>> admin = User('admin', 'admin@example.com')
>>> guest = User('guest', 'guest@example.com')
但是它们还没有真正地写入到数据库中，因此让我们来确保它们已经写入到数据库中:
>>> db.session.add(admin)
>>> db.session.add(guest)
>>> db.session.commit()
访问数据库中的数据也是十分简单的:
>>> users = User.query.all()
[<User u'admin'>, <User u'guest'>]
>>> admin = User.query.filter_by(username='admin').first()
<User u'admin'>
简单的关系
SQLAlchemy 连接到关系型数据库，关系型数据最擅长的东西就是关系。因此，我们将创建一个使用两张相互关联的表的应用作为例子:
from datetime import datetime
class Post(db.Model):
id = db.Column(db.Integer, primary_key=True)
title = db.Column(db.String(80))
body = db.Column(db.Text)
pub_date = db.Column(db.DateTime)
category_id = db.Column(db.Integer, db.ForeignKey('category.id'))
category = db.relationship('Category',
backref=db.backref('posts', lazy='dynamic'))
def __init__(self, title, body, category, pub_date=None):
self.title = title
self.body = body
if pub_date is None:
pub_date = datetime.utcnow()
self.pub_date = pub_date
self.category = category
def __repr__(self):
return '<Post %r>' % self.title
class Category(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50))
def __init__(self, name):
self.name = name
def __repr__(self):
return '<Category %r>' % self.name
首先让我们创建一些对象:
>>> py = Category('Python')
>>> p = Post('Hello Python!', 'Python is pretty cool', py)
>>> db.session.add(py)
>>> db.session.add(p)
现在因为我们在 backref 中声明了 posts 作为动态关系，查询显示为:
>>> py.posts
<sqlalchemy.orm.dynamic.AppenderBaseQuery object at 0x1027d37d0>
它的行为像一个普通的查询对象，因此我们可以查询与我们测试的 “Python” 分类相关的所有文章(posts):
>>> py.posts.all()
[<Post 'Hello Python!'>]
启蒙之路
您仅需要知道与普通的 SQLAlchemy 不同之处:
SQLAlchemy允许您访问下面的东西:sqlalchemy和sqlalchemy.orm下所有的函数和类- 一个叫做 session 的预配置范围的会话(session)
metadata属性engine属性SQLAlchemy.create_all()和SQLAlchemy.drop_all()，根据模型用来创建以及删除表格的方法- 一个
Model基类，即是一个已配置的声明(declarative)的基础(base)
Model声明基类行为类似一个常规的 Python 类，不过有个 query 属性，可以用来查询模型 (Model和BaseQuery)- 您必须提交会话，但是没有必要在每个请求后删除它(session)，Flask-SQLAlchemy 会帮您完成删除操作。
from flask_sqlalchemy import SQLAlchemy from flask import Flask app = Flask(__name__) # 此处是配置SQLALCHEMY_DATABASE_URI, 前面的mysql+mysqlconnetor指的是数据库的类型以及驱动类型 # 后面的username,pwd,addr,port,dbname分别代表用户名、密码、地址、端口以及库名 app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql+pymysql://username:pwd@addr:port/dbname?charset=utf8' # 创建1个SQLAlichemy实例 db = SQLAlchemy(app) # 定义1个类(由db.Model继承) class RoleTable(db.Model): # id是主键db.Column是字段名， db.INT是数据类型 __tablename__ = 'role' id = db.Column(db.INT, primary_key=True) name = db.Column(db.String(99), unique=False) name_cn = db.Column(db.String(99), unique=False) __table_args__ = ( {'mysql_engine': 'InnoDB', 'mysql_charset': 'utf8'} ) def __init__(self, id, name, name_cn): self.id = id self.name = name self.name_cn = name_cn # 初始化role 并插入数据库 test_role1 = RoleTable(6, 'supervisol', '超超超超级管理员哦') test_role2 = RoleTable(7, 'your try', '你试试哦') db.session.add(test_role1) db.session.add(test_role2) db.session.commit() #查询数据库 db.session.query(RoleTable).filter_by(id=2).first() # 查询role表中id为2的第一个匹配项目，用".字段名"获取字段值 db.session.query(RoleTable).all() # 得到一个list，返回role表里的所有role实例 db.session.query(RoleTable).filter(RoleTable.id == 2).first() # 结果与第一种一致 # 获取指定字段，返回一个生成器 通过遍历来完成相关操作, 也可以强转为list db.session.query(RoleTable).filter_by(id=2).values('id', 'name', 'name_cn') # 模糊查询 db.session.query(RoleTable).filter(RoleTable.name_cn.endswith('管理员')).all() # 获取role表中name_cn字段以管理员结尾的所有内容 # 修改数据库内容 user = db.session.query(RoleTable).filter_by(id=6).first() # 将role表中id为6的name改为change user.name = 'change' db.session.commit()
