Flask 資料庫

1. 使用Flask-SQLAlchemy管理資料庫

Flask使用Flask-SQLAlchemy管理資料庫，安裝方式：

$ pip install flask-sqlalchemy

在 Flask-SQLAlchemy 中，資料庫使用 URL 指定：

MySQL mysql://username:[email protected]/database
Postgres postgresql://username:[email protected]/database
SQLite（ Unix） sqlite:////absolute/path/to/database
 

SQLite（ Windows） sqlite:///c:/absolute/path/to/database

程式使用的資料庫 URL 必須儲存到 Flask 配置物件的 SQLALCHEMY_DATABASE_URI 鍵中。
配置物件中還有一個很有用的選項， 即 SQLALCHEMY_COMMIT_ON_TEARDOWN 鍵，將其設為 True時，每次請求結束後都會自動提交資料庫中的變動。

初始化以及配置一個簡單的SQLite資料庫：

from os
from flask import Flask
from flask.ext.sqlalchemy import SQLAlchemy

basedir = os.path.abspath(os.path.dirname(__file__))                                                                                                  

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'
 
] = \ 
        'sqlite:///' + os.path.join(basedir, 'data.sqlite')
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = True

db = SQLAlchemy(app)

2. 定義模型

在 ORM 中，模型一般是一個 Python 類，類中的屬性對應資料庫表中的列。
下面定義兩個表對應的Python類。

class Role(db.Model):
    __tablename__ = 'roles'
    id = db.Column(db.Integer, primary_key=True
 
)
    name = db.Column(db.String(64), unique=True)
    users = db.relationship('User', backref='role')

    def __repr__(self):
        return '<Role %r>' % self.name

class User(db.Model):
    __tablename__ = 'users'
    id = db.Column(db.Integer, primary_key=True)
    username=db.Column(db.String(64), unique=True, index=True)
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

    def __repr__(self):
        return '<User %r>' % self.username

類變數 __tablename__ 定義在資料庫中使用的表名。如果沒有定義 __tablename__， Flask-SQLAlchemy會使用一個預設名字，但預設的表名沒有遵守使用複數形式進行命名的約定，所以最好由我們自己來指定表名。其餘的類變數都是該模型的屬性，被定義為 db.Column類的例項。

下圖顯示了最常用的SQLAlchemy列的型別：

下圖顯示了最常用的SQLAlchemy列選項：

Flask-SQLAlchemy 要求每個模型都要定義主鍵，這一列經常命名為 id。

3. 定義模型的關係

上面的User類和Role類中，通過下面的程式碼定義了兩個類的關係：

class Role(db.Model):
    # ...
    users = db.relationship('User', backref='role', lazy='dynamic')
class User(db.Model):
    # ...
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))

之前定義了兩個表的名字：users和roles。

關係使用 users 表中的外來鍵連線了兩行。新增到 User 模型中的 role_id 列被定義為外來鍵， 就是這個外來鍵建立起了關係。傳給 db.ForeignKey() 的引數 'roles.id' 表明，這列的值是 roles 表中行的 id值。

新增到 Role 模型中的 users 屬性代表這個關係的面向物件視角。對於一個 Role 類的例項，其 users 屬性將返回與角色相關聯的使用者組成的列表。db.relationship() 的第一個引數表明這個關係的另一端是哪個模型。

db.relationship() 中的 backref 引數向 User 模型中新增一個 role 屬性，從而定義反向關係。這一屬性可替代 role_id 訪問 Role 模型，此時獲取的是模型物件，而不是外來鍵的值。

其中引數lazy的作用是：禁止自動查詢，當在一個Role物件中呼叫users屬性的時候，會自動執行query，返回所有的屬於該Role物件的User物件，因此無法在此結果上附加更精確的查詢過濾器。例如原來這樣直接獲取User物件users = user_role.users，增加lazy引數後這樣獲取：user_role.users.order_by(User.username).all()，增加了更精確的過濾器。

4. 資料配置

在該部分實現資料庫的建立、初始化等工作，所以把這部分程式碼放在manage.py檔案中：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
from flask_script import Manager, Server, Shell
from somepackage import app, db
from somepackage import User, Role

manager = Manager(app)

@manager.command
def init_db():
    """
    Init the DB and Insert test data
    """
    # this db is a SQLAlchemy instance, must be imported.
    # the create_all method is belonged to SQLAlchemy instance.
    db.create_all()

    admin_role = Role(id=1, name="Admin")
    user_role = Role(id=2, name="User")
    user_jhon = User(id=1, username="Jhon", role=admin_role)
    user_david = User(id=2, username="david", role=user_role)

    db.session.add_all([admin_role, user_role, user_jhon, user_david])
    try:
        db.session.commit()
    except Exception, e:
        db.session.rollback()
        print e

if __name__ == "__main__":
    manager.run()

注意：其中的User和Role，以及db都要從合適的包或者模組中引入進來。

這樣就能夠建立並初始化資料庫。下面看SQLAlchemy提供的過濾器和查詢函式：

其中filter和filter_by的區別就是：filter_by之後的條件直接是欄位＝查詢的值。filter之後的條件是類名.欄位＝查詢條件。

5. 資料庫操作

通過上面的配置就可以在檢視函式中操作資料庫了：

@app.route('/', methods=['GET', 'POST'])
def index():
    form = NameForm()

    if form.validate_on_submit():
        user = User.query.filter_by(username=form.name.data).first() 

        if user is None:
            user = User(username = form.name.data)
            db.session.add(user)
            session['known'] = False
        else:
            session['known'] = True
            session['name'] = form.name.data
            form.name.data = ''

            return redirect(url_for('index'))

    return render_template('index.html',
                            form = form, 
                            name = session.get('name'),
                            known = session.get('known', False)