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()

數據庫已經生成。現在來創建一些用戶:

from yourapplication import User
admin = User(‘admin‘, ‘[email protected]‘)
guest = User(‘guest‘, ‘[email protected]‘)

但是它們還沒有真正地寫入到數據庫中，因此讓我們來確保它們已經寫入到數據庫中:

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 會幫助完成刪除操作。

Flask-SQLAlchemy使用方法