数据库工具 — Django 6.0.4 documentation(2026)
创始人
2026-06-01 03:20:39
0
Django教程

数据库工具

为了帮助你更好的理解并控制由你的代码所产生的数据库查询,Django提供了一个钩子函数,在这个钩子函数中你可以在数据库查询方法外层添加一层wrappers方法.举例说明, wrappers方法可以记录数据库查询的数量, 计算查询持续的事件, 为查询记录日志, 甚至可以阻止查询的执行(例如在渲染使用了预取的数据的模板时确保没有数据库查询被执行).

装饰器是在 middleware 之后建模的--它们是可调用的,并把其他调用作为它们的参数之一。它们调用可调用函数来调用(可能是包装的)数据库查询,并且它们可以围绕这个调用做一些工作。然而,它们通过用户代码来创建和安装,因此不需要独立像中间件这样的独立文件。

wrapper方法的安装是在上下文管理器中完成的 -- 因此wrapper方法是暂时的, 也是针对于你代码里的某些特定逻辑的.

正如上面提到的, 一个使用wrapper方法的例子是阻塞查询的执行. 类似的代码为:

def blocker(*args):
    raise Exception("No database access allowed here.")

它可以被用在视图里阻止来自模板的查询,如下所示:

from django.db import connection
from django.shortcuts import render


def my_view(request):
    context = {...}  # Code to generate context with all data.
    template_name = ...
    with connection.execute_wrapper(blocker):
        return render(request, template_name, context)

发给wrapper方法的参数是:

  • "execute" -- 一个可以被执行的对象, 使用剩下的参数触发来执行查询.

  • sql -- 一个 str,要发送到数据库的SQL 查询。

  • params -- SQL命令行参数值的列表/二元组,或者列表集/二元组集的一个列表/二元组(如果包装过的调用是 executemany() 的话)。

  • many -- 一个布尔值,标识最终的调用是否是 execute() 还是 executemany() (以及 params 是否是一个值系列,还是一系列值的序列)。

  • context -- 一个字典,包含带有关于调用上下文的数据。

使用这个参数,稍微复杂一点的阻塞函数包含在错误信息中的连接名:

def blocker(execute, sql, params, many, context):
    alias = context["connection"].alias
    raise Exception("Access to database '{}' blocked here".format(alias))

有关更完整的例子,一个查询日志器看起来像这样:

import time


class QueryLogger:
    def __init__(self):
        self.queries = []

    def __call__(self, execute, sql, params, many, context):
        current_query = {"sql": sql, "params": params, "many": many}
        start = time.monotonic()
        try:
            result = execute(sql, params, many, context)
        except Exception as e:
            current_query["status"] = "error"
            current_query["exception"] = e
            raise
        else:
            current_query["status"] = "ok"
            return result
        finally:
            duration = time.monotonic() - start
            current_query["duration"] = duration
            self.queries.append(current_query)

要使用它,你可以创建一个日志器对象,并且将其作为装饰器来安装:

from django.db import connection

ql = QueryLogger()
with connection.execute_wrapper(ql):
    do_queries()
# Now we can print the log.
print(ql.queries)

connection.execute_wrapper()

execute_wrapper(wrapper)

返回一个上下文管理器,当进入时,会安装一个围绕数据库查询执行的装饰器,当离开时,会移除这个装饰器。装饰器是在本地线程的连接对象上安装的。

wrapper is a callable taking five arguments. It is called for every query execution in the scope of the context manager, with arguments execute, sql, params, many, and context as described above. It's expected to call execute(sql, params, many, context) and return the return value of that call.

Last update:

4月 20, 2026


本文整理自 Django 6.0 官方中文文档,转载请注明出处。

相关内容

热门资讯

玻璃硬盘原理图 玻璃硬盘原理 玻璃硬盘,又称为磁头悬浮硬盘(Magnetic Head Flying Disk,MHFD),是一种...
闲鱼搜索规则与技巧 闲鱼最新特... 在闲鱼这个二手交易平台上,有很多用户都希望能够找到一些特殊的东西,比如一些罕见的收藏品、独特的手工艺...
家里监控最长能保存多少天的记录... 家里监控一般保存多久 随着科技的发展,家庭监控系统已经成为了许多家庭的必备设备,它不仅可以帮助我们...
华为tag有用吗 华为tag-... 华为Tag是华为手机中的一种功能,它可以帮助用户更好地管理自己的手机数据和应用,通过使用华为Tag,...
ps5手柄可用手机快充充电吗 ... PS5手柄,即PlayStation 5的DualSense手柄,是索尼公司为PlayStation...
QQ音乐提示代理模式可能无法正... QQ音乐提示代理模式可能无法正常访问,如上图所示,是怎么回事呢? 这个可能和你的网络设置有关系,首先...
收到微信有提示音怎么去掉 微信... 微信收到信息没有提示音,可能是由多种原因导致的,以下是一些可能的原因及解决方法: 1. 手机静音或...
a100显卡对应的cuda版本 在进行GPU加速的编程中,CUDA是常用的架构和平台,其版本和显卡型号之间存在着一定的对应关系。本篇...
别人打电话听不见我说话怎么回事... 当我们在使用手机时,可能会遇到别人打电话过来听不见声音的情况,这种情况可能是由多种原因导致的,下面我...
苹果手机非通讯录电话打不进来 ... 手机电话打不进来可能有多种原因,以下是一些常见的问题及解决方法: 1. **信号问题**: ...