Django调试模型SQL输出的两种方法:配置日志与shell_plus

小满
小满
发布时间:2026-10-13| 2人浏览过
原创

本文介绍在Django中调试模型SQL输出的两种实用方法。首先,通过在settings.py中配置LOGGING,将django.db.backends记录器指向控制台并设为DEBUG级别,可实时打印所有数据库交互语句。其次,推荐使用django-extensions库的shell_plus命令,通过添加--print-sql参数,在交互式环境中直接查看每次查询的执行时间与SQL详情,提升开发效率。

通过settings.py配置日志查看SQL

要在Django项目中查看模型生成的SQL语句,第一种方法是通过修改配置文件来启用日志记录。具体操作是在settings.py中添加LOGGING配置块。


LOGGING = {
 'version': 1,
 'disable_existing_loggers': False,
 'handlers': {
  'console':{
   'level':'DEBUG',
   'class':'logging.StreamHandler',
  },
 },
 'loggers': {
  'django.db.backends': {
   'handlers': ['console'],
   'propagate': True,
   'level':'DEBUG',
  },
 }
}

配置生效后,当执行数据库查询时,生成的SQL语句会直接输出到控制台终端,方便开发者即时检查。


$ python manage.py shell
 
In [1]: from test.models import A
 
In [2]: A.objects.all()
(0.001) SELECT "app1_a"."id", "app1_a"."name" FROM "app1_a" LIMIT 21; args=()
[<A: A object>]

使用shell_plus命令打印SQL

第二种更便捷的方法是利用django-extensions扩展库提供的增强型Shell功能。该库提供了shell_plus命令,并支持通过--print-sql选项开启SQL打印功能。

在终端中运行以下命令即可启动带有SQL打印功能的交互式Shell:


>>> Author.objects.all()
SELECT "library_author"."id", "library_author"."name" FROM "library_author" LIMIT 21
Execution time: 0.001393s [Database: default]
<QuerySet [<Author: Author object>]>

Django内置记录器说明

除了上述方法,Django框架本身也内置了一套完善的日志记录机制,用于处理不同层级的系统消息。

需要注意的是,Django的消息记录器遵循其内部层次结构,开发者不应直接使用通用的根记录器名称,而应针对特定模块使用具体的记录器。

其中,django.request记录器专门处理与HTTP请求相关的日志。对于状态码为5xx的服务端错误,日志级别会被提升为ERROR;而4xx客户端错误则被记录为WARNING。

django.server记录器负责记录由RunServer命令启动的开发服务器所接收请求的处理过程。HTTP 5xx响应记录为ERROR,4xx记录为WARNING,其他正常请求则记录为INFO级别。

django.template记录器用于捕获与模板渲染过程相关的日志信息,有助于排查模板加载或渲染时的问题。

对于调试SQL而言,最关键的是django.db.backends记录器。它专门记录代码与数据库之间的交互消息。在DEBUG级别下,应用程序执行的每一条SQL语句都会被详细记录在此处,这是查看底层数据库操作的核心入口。

以上介绍了在Django中调试模型SQL输出的两种主要方式,包括配置日志和使用增强型Shell,希望能帮助开发者更高效地进行数据库查询优化与调试。

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。