定义和访问数据库 — Flask 文档

来自菜鸟教程
Flask/docs/2.0.x/tutorial/database
跳转至:导航、​搜索

定义和访问数据库

该应用程序将使用 SQLite 数据库来存储用户和帖子。 Python 在 sqlite3 模块中内置了对 SQLite 的支持。

SQLite 很方便,因为它不需要设置单独的数据库服务器并且是 Python 内置的。 但是,如果并发请求尝试同时写入数据库,它们会随着每次写入顺序发生而变慢。 小型应用程序不会注意到这一点。 一旦你变大了,你可能想切换到不同的数据库。

本教程没有详细介绍 SQL。 如果您不熟悉它,SQLite 文档描述了 语言

连接到数据库

使用 SQLite 数据库(和大多数其他 Python 数据库库)时要做的第一件事是创建到它的连接。 任何查询和操作都使用连接执行,工作完成后关闭。

在 Web 应用程序中,此连接通常与请求相关联。 它是在处理请求时的某个时刻创建的,并在发送响应之前关闭。

flaskr/db.py

import sqlite3

import click
from flask import current_app, g
from flask.cli import with_appcontext


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 告诉连接返回行为类似于 dicts 的行。 这允许按名称访问列。

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')
@with_appcontext
def init_db_command():
    """Clear the existing data and create new tables."""
    init_db()
    click.echo('Initialized the database.')

open_resource() 打开一个与 flaskr 包相关的文件,这很有用,因为您在稍后部署应用程序时不一定知道该位置在哪里。 get_db 返回一个数据库连接,用于执行从文件中读取的命令。

click.command() 定义了一个名为 init-db 的命令行命令,该命令调用 init_db 函数并向用户显示成功消息。 您可以阅读 命令行界面 以了解有关编写命令的更多信息。


注册应用程序

close_dbinit_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 命令调用。

从工厂导入并调用此函数。 在返回应用程序之前,将新代码放在工厂函数的末尾。

flaskr/__init__.py

def create_app():
    app = ...
    # existing code omitted

    from . import db
    db.init_app(app)

    return app

初始化数据库文件

现在 init-db 已在应用程序中注册,可以使用 flask 命令调用它,类似于上一页中的 run 命令。

笔记

如果您仍在上一页运行服务器,则可以停止服务器,或在新终端中运行此命令。 如果您使用新终端,请记住更改到您的项目目录并按照 安装 中的说明激活 env。 您还需要设置 FLASK_APPFLASK_ENV,如上一页所示。


运行 init-db 命令:

$ flask init-db
Initialized the database.

现在您的项目中的 instance 文件夹中将有一个 flaskr.sqlite 文件。

继续 蓝图和视图