Flask-SQLAlchemy 使用起来很是有趣,对于基本应用十分容易使用,而且对于大型项目易于扩展。有关完整的指南,请参阅 SQLAlchemy
的 API 文档。html
常见状况下对于只有一个 Flask 应用,全部您须要作的事情就是建立 Flask 应用,选择加载配置接着建立 SQLAlchemy
对象时候把 Flask 应用传递给它做为参数。python
一旦建立,这个对象就包含 sqlalchemy
和 sqlalchemy.orm
中的全部函数和助手。此外它还提供一个名为 Model 的类,用于做为声明模型时的 delarative 基类:sql
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()
方法来建立表和数据库:shell
>>> from yourapplication import db >>> db.create_all()
Boom, 您的数据库已经生成。如今来建立一些用户:数据库
>>> from yourapplication import User >>> admin = User('admin', 'admin@example.com') >>> guest = User('guest', 'guest@example.com')
可是它们尚未真正地写入到数据库中,所以让咱们来确保它们已经写入到数据库中:flask
>>> db.session.add(admin) >>> db.session.add(guest) >>> db.session.commit()
访问数据库中的数据也是十分简单的:api
>>> users = User.query.all() [<User u'admin'>, <User u'guest'>] >>> admin = User.query.filter_by(username='admin').first() <User u'admin'>
SQLAlchemy 链接到关系型数据库,关系型数据最擅长的东西就是关系。所以,咱们将建立一个使用两张相互关联的表的应用做为例子:session
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
首先让咱们建立一些对象:app
>>> 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
下全部的函数和类metadata
属性engine
属性SQLAlchemy.create_all()
和 SQLAlchemy.drop_all()
,根据模型用来建立以及删除表格的方法Model
基类,便是一个已配置的声明(declarative)的基础(base)Model
声明基类行为相似一个常规的 Python 类,不过有个 query 属性,能够用来查询模型 (Model
和 BaseQuery
)