Python 資料庫框架

大多數的資料庫引擎都有對應的 Python 包,包括開源包和商業包。Flask 並不限制你使用何種型別的資料庫包,因此可以根據自己的喜好選擇使用 MySQL、Postgres、SQLite、Redis、MongoDB 或者 CouchDB。

如果這些都無法滿足需求,還有一些資料庫抽象層程式碼包供選擇,例如SQLAlchemy和MongoEngine。你可以使用這些抽象包直接處理高等級的 Python 物件,而不用處理如表、文件或查詢語言此類的資料庫實體。

選擇資料庫框架的因素：

• 易用性。抽象層,也稱為物件關係映 射(Object-Relational Mapper,ORM) 或 對 象 文 檔 映 射(Object-Document Mapper,ODM),在使用者不知覺的情況下把高層的面向物件操作轉換成低層的資料庫指令。
• 效能。ORM 和 ODM 把物件業務轉換成資料庫業務會有一定的損耗。真正的關鍵點在於如何選擇一個能直接操作低層資料庫的抽象層,以防特定的操作需要直接使用資料庫原生指令優化。
• 可移植性。必須考慮其是否能在你的開發平臺和生產平臺中使用。
• Flask整合度

• 安裝

pip install flask-sqlalchemy

使用URL制定資料庫

SQLite 數 據 庫 不 需 要 使 用 服 務 器, 因 此 不 用 指 定 hostname 、 username 和 password 。URL 中的 database 是硬碟上檔案的檔名。

• 配置
  程式使用的資料庫 URL 必須儲存到 Flask 配置物件的 SQLALCHEMY_DATABASE_URI 鍵中

配置物件中還有一個很有用的選項,即 SQLALCHEMY_COMMIT_ON_TEARDOWN 鍵,將其設為 True時,每次請求結束後都會自動提交資料庫中的變動

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)

• 定義模型

class Role(db.Model):
    __tablename__ = 'roles'#__tablename__ 定義在資料庫中使用的表名
    id = db.Column(db.Integer, primary_key=True)#primary_key如果設為 True ,這列就是表的主鍵.如果沒有定義 __tablename__ ,SQLAlchemy 會使用一個預設名字
    name = db.Column(db.String(64), unique=True)
    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)
    def __repr__(self):
        return '<User % r>' % self.username

最常用的SQLAlchemy列型別

最常使用的SQLAlchemy列選項

關係表達

關係型資料庫使用關係把不同表中的行聯絡起來。

• 一對多

class Role(db.Model):
    # ...
    users = db.relationship('User', backref='role')#新增到 Role 模型中的 users 屬性代表這個關係的面向物件視角。對於一個 Role 類的例項,其 users 屬性將返回與角色相關聯的使用者組成的列表。db.relationship() 的第一個引數表,如果模型類尚未定義,可使用字串形式指定。db.relationship() 中的 backref 引數向 User 模型中新增一個 role 屬性,從而定義反向關係。這一屬性可替代 role_id 訪問 Role 模型,此時獲取的是模型物件
class User(db.Model):
    # ...
    role_id = db.Column(db.Integer, db.ForeignKey('roles.id'))#關係使用 users 表中的外來鍵連線了兩行。新增到 User 模型中的 role_id 列被定義為外來鍵,就是這個外來鍵建立起了關係。傳給 db.ForeignKey() 的引數 'roles.id' 表明,這列的值是 roles 表中行的 id 值。

db.relationship() 都能自行找到關係中的外來鍵,但有時卻無法決定把哪一列作為外來鍵。如果 User 模型中有兩個或以上的列定義為 Role 模型的外來鍵,SQLAlchemy 就不知道該使用哪列。如果無法決定外來鍵,你就要為 db.relationship() 提供額外引數,從而確定所用外來鍵

常用的SQLAlchemy關係選項

• 一對一
  一對一關係可以用前面介紹的一對多關係表示,但呼叫 db.relationship() 時要把 uselist 設為 False ,把“多”變成“一”。

• 多對多

tags = db.Table('tags',
    db.Column('tag_id', db.Integer, db.ForeignKey('tag.id')),
    db.Column('page_id', db.Integer, db.ForeignKey('page.id'))
)

class Page(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    tags = db.relationship('Tag', secondary=tags,
        backref=db.backref('pages', lazy='dynamic'))

class Tag(db.Model):
    id = db.Column(db.Integer, primary_key=True)

資料庫操作

• 建立表

python hello.py shell
>>> from hello import db
>>> db.create_all()

• 刪除表

db.drop_all()

• 插入行

#建立物件，模型的建構函式接受的引數是使用關鍵字引數指定的模型屬性初始值。
admin_role = Role(name='Admin')
user_role = Role(name='User')
user_susan = User(username='susan', role=user_role)#role 屬性也可使用,雖然它不是真正的資料庫列,但卻是一對多關係的高階表示。
user_john = User(username='john', role=admin_role)
#這些新建物件的 id 屬性並沒有明確設定,因為主鍵是由 Flask-SQLAlchemy 管理的。
print(admin_role.id)#None
#通過資料庫會話管理對資料庫所做的改動,在 Flask-SQLAlchemy 中,會話由 db.session 表示。
##首先，將物件新增到會話中
db.session.add(admin_role)
db.session.add(user_role)
db.session.add(user_susan)
db.session.add(user_john)
#簡寫：db.session.add_all([admin_role, user_role, user_john, user_susan])
##通過提交會話(事務)，將物件寫入資料庫
db.session.commit()

會話提交：

資料庫會話能保證資料庫的一致性。提交操作使用原子方式把會話中的物件全部寫入資料庫。如果在寫入會話的過程中發生了錯誤,整個會話都會失效。
資料庫會話也可 回滾 。呼叫 db.session.rollback() 後,新增到資料庫會話中的所有物件都會還原到它們在資料庫時的狀態。

• 修改行

admin_role.name = 'Administrator'
db.session.add(admin_role)
session.commit()

• 刪除行

db.session.delete(mod_role)
session.commit()

• 查詢行

  • 查詢全部。Role.query.all()
  • 條件查詢（使用過濾器）。User.query.filter_by(role=user_role).all()

  user_role = Role.query.filter_by(name='User').first()#filter_by() 等過濾器在 query 物件上呼叫,返回一個更精確的 query 物件。

  常用過濾器

最常使用的SQLAlchemy查詢執行函式

• 關係查詢

  
  #執行 user_role.users 表示式時,隱含的查詢會呼叫 all() 返回一個使用者列表。 query 物件是隱藏的,因此無法指定更精確的查詢過濾器。
  
  users = user_role.users
  
  #修改了關係的設定,加入了 lazy = 'dynamic' 引數,從而禁止自動執行查詢
  
  class Role(db.Model):
  users = db.relationship('User', backref='role', lazy='dynamic')
  
  #順序排列
  
  user_role.users.order_by(User.username).all()

在檢視函式中操作資料庫

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

修改模板

{ % extends "base.html" % }
{ % import "bootstrap/wtf.html" as wtf % }
{ % block title % }Flasky{ % endblock % }
{ % block page_content % }
    <div class="page-header">
        <h1>Hello, { % if name % }{{ name }}{ % else % }Stranger{ % endif % }!</h1>
        { % if not known % }
            <p>Pleased to meet you!</p>
        { % else % }
            <p>Happy to see you again!</p>
        { % endif % }
    </div>
    {{ wtf.quick_form(form) }}
{ % endblock % }

整合 Python shell

讓 Flask-Script 的 shell 命令自動匯入特定的物件

from flask.ext.script import Shell
def make_shell_context():
    return dict(app=app, db=db, User=User, Role=Role)  
manager.add_command("shell", Shell(make_context=make_shell_context))

make_shell_context() 函式註冊了程式、資料庫例項以及模型,因此這些物件能直接匯入 shell

使用 Flask-Migrate 實現資料庫遷移

建立遷移倉庫

pip install flask-migrate

配置

from flask.ext.migrate import Migrate, MigrateCommand
# ...
migrate = Migrate(app, db)
manager.add_command('db', MigrateCommand)

在維護資料庫遷移之前,要使用 init 子命令建立遷移倉庫

python hello.py db init

建立遷移指令碼

python hello.py db migrate -m "initial migration"

更新資料庫

python hello.py db upgrade