定义和访问数据库¶
应用程序将使用 SQLite 数据库来存储用户和帖子。Python 内置了对 SQLite 的支持,模块为 sqlite3
。
SQLite 很方便,因为它不需要设置单独的数据库服务器,并且内置于 Python 中。但是,如果并发请求尝试同时写入数据库,它们会因为每次写入顺序发生而减速。小型应用程序不会注意到这一点。一旦你的应用变大,你可能需要切换到不同的数据库。
本教程不详细介绍 SQL。如果您不熟悉它,SQLite 文档描述了 语言。
连接到数据库¶
使用 SQLite 数据库(以及大多数其他 Python 数据库库)时,首先要做的是创建到它的连接。任何查询和操作都使用此连接执行,并在工作完成后关闭连接。
在 Web 应用程序中,此连接通常与请求绑定。它在处理请求的某个时刻创建,并在发送响应之前关闭。
flaskr/db.py
¶import sqlite3
from datetime import datetime
import click
from flask import current_app, g
def get_db():
if 'db' not in g:
g.db = sqlite3.connect(
current_app.config['DATABASE'],
detect_types=sqlite3.PARSE_DECLTYPES
)
g.db.row_factory = sqlite3.Row
return g.db
def close_db(e=None):
db = g.pop('db', None)
if db is not None:
db.close()
g
是一个特殊对象,对于每个请求都是唯一的。它用于存储在请求期间可能被多个函数访问的数据。连接被存储和重用,而不是在同一请求中第二次调用 get_db
时创建新连接。
current_app
是另一个特殊对象,它指向处理请求的 Flask 应用程序。由于您使用了应用程序工厂,因此在编写其余代码时没有应用程序对象。get_db
将在应用程序创建并正在处理请求时被调用,因此可以使用 current_app
。
sqlite3.connect()
建立与 DATABASE
配置键指向的文件的连接。此文件不必事先存在,并且直到稍后初始化数据库时才会存在。
sqlite3.Row
告诉连接返回行为类似于字典的行。这允许通过名称访问列。
close_db
检查是否通过检查是否设置了 g.db
来创建连接。如果连接存在,则将其关闭。稍后您将在应用程序工厂中告知您的应用程序 close_db
函数,以便在每个请求之后调用它。
创建表¶
在 SQLite 中,数据存储在表和列中。这些需要在您可以存储和检索数据之前创建。Flaskr 将用户存储在 user
表中,并将帖子存储在 post
表中。创建一个包含创建空表所需的 SQL 命令的文件
flaskr/schema.sql
¶DROP TABLE IF EXISTS user;
DROP TABLE IF EXISTS post;
CREATE TABLE user (
id INTEGER PRIMARY KEY AUTOINCREMENT,
username TEXT UNIQUE NOT NULL,
password TEXT NOT NULL
);
CREATE TABLE post (
id INTEGER PRIMARY KEY AUTOINCREMENT,
author_id INTEGER NOT NULL,
created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
title TEXT NOT NULL,
body TEXT NOT NULL,
FOREIGN KEY (author_id) REFERENCES user (id)
);
将运行这些 SQL 命令的 Python 函数添加到 db.py
文件中
flaskr/db.py
¶def init_db():
db = get_db()
with current_app.open_resource('schema.sql') as f:
db.executescript(f.read().decode('utf8'))
@click.command('init-db')
def init_db_command():
"""Clear the existing data and create new tables."""
init_db()
click.echo('Initialized the database.')
sqlite3.register_converter(
"timestamp", lambda v: datetime.fromisoformat(v.decode())
)
open_resource()
打开相对于 flaskr
包的文件,这很有用,因为您不一定知道以后部署应用程序时该位置在哪里。get_db
返回数据库连接,该连接用于执行从文件读取的命令。
click.command()
定义了一个名为 init-db
的命令行命令,该命令调用 init_db
函数并向用户显示成功消息。您可以阅读 命令行界面 以了解有关编写命令的更多信息。
对 sqlite3.register_converter()
的调用告诉 Python 如何解释数据库中的时间戳值。我们将该值转换为 datetime.datetime
。
向应用程序注册¶
close_db
和 init_db_command
函数需要向应用程序实例注册;否则,应用程序将不会使用它们。但是,由于您使用的是工厂函数,因此在编写函数时该实例不可用。相反,编写一个接受应用程序并执行注册的函数。
flaskr/db.py
¶def init_app(app):
app.teardown_appcontext(close_db)
app.cli.add_command(init_db_command)
app.teardown_appcontext()
告诉 Flask 在返回响应后清理时调用该函数。
app.cli.add_command()
添加一个可以使用 flask
命令调用的新命令。
从工厂导入并调用此函数。将新代码放在工厂函数的末尾,然后在返回 app 之前。
flaskr/__init__.py
¶def create_app():
app = ...
# existing code omitted
from . import db
db.init_app(app)
return app
初始化数据库文件¶
现在 init-db
已经向应用程序注册,可以使用 flask
命令调用它,类似于上一页中的 run
命令。
注意
如果您仍在运行上一页的服务器,您可以停止服务器,或者在新终端中运行此命令。如果您使用新终端,请记住切换到您的项目目录并按照 安装 中的描述激活 env。
运行 init-db
命令
$ flask --app flaskr init-db
Initialized the database.
现在在您的项目中的 instance
文件夹中将有一个 flaskr.sqlite
文件。
继续阅读 蓝图和视图。