如何查看Django ORM的查询集对应的SQL查询？

Question

有没有办法可以打印 Django ORM 生成的查询？

假设我执行以下语句： Model.objects.filter(name='test')

如何查看生成的 SQL 查询？

Answer 1

每个 QuerySet 对象都有一个 query 属性，您可以将其记录或打印到 stdout 以进行调试。

qs = Model.objects.filter(name='test')
print(qs.query)

请注意，在 pdb 中，使用 p qs.query 将无法按预期工作，但 print(qs.query) 可以。

如果这不起作用，对于旧的 Django 版本，请尝试：

print str(qs.query)

编辑

我还使用了自定义模板标签（如 此代码段）将查询作为 HTML 注释注入单个请求的范围内。

Answer 2

您还可以使用 python 日志记录来记录 Django 生成的所有查询。 只需将其添加到您的设置文件中即可。

LOGGING = {
    'disable_existing_loggers': False,
    'version': 1,
    'handlers': {
        'console': {
            # logging handler that outputs log messages to terminal
            'class': 'logging.StreamHandler',
            'level': 'DEBUG', # message level to be written to console
        },
    },
    'loggers': {
        '': {
            # this sets root level logger to log debug and higher level
            # logs to console. All other loggers inherit settings from
            # root level logger.
            'handlers': ['console'],
            'level': 'DEBUG',
            'propagate': False, # this tells logger to send logging message
                                # to its parent (will send if set to True)
        },
        'django.db': {
            # django also has database level logging
            'level': 'DEBUG'
        },
    },
}

应用程序生成 html 输出的另一种方法 - django 调试工具栏 可以是用过的。

Answer 3

您可以将此代码粘贴到 Django shell 上，它将显示所有 SQL 查询：

import logging
l = logging.getLogger('django.db.backends')
l.setLevel(logging.DEBUG)
l.addHandler(logging.StreamHandler())

Answer 4

只要 DEBUG 开启：

from django.db import connection
print(connection.queries)

对于单个查询，您可以执行以下操作：

print(Model.objects.filter(name='test').query)

Answer 5

也许您应该看一下 django-debug-toolbar 应用程序，它会为您记录所有查询，显示它们的分析信息等等。

Answer 6

一个强大的解决方案是将数据库服务器记录到一个文件，然后

tail -f /path/to/the/log/file.log

Answer 7

如果您使用数据库路由，则可能有多个数据库连接。
这样的代码可以让您查看会话中的连接。
您可以按照与单个连接相同的方式重置统计信息：reset_queries()

from django.db import connections,connection,reset_queries
...
reset_queries()  # resets data collection, call whenever it makes sense

...

def query_all():
    for c in connections.all():
        print(f"Queries per connection: Database: {c.settings_dict['NAME']} {c.queries}")

# and if you just want to count the number of queries
def query_count_all()->int:
    return sum(len(c.queries) for c in connections.all() )

Answer 8

Postgres Docker 容器

如果您在开发环境中使用 postgres docker 容器，则可以通过将此行添加到开发 docker-compose.yml postgres 容器配置中来轻松打开 SQL 日志记录：

command: ["postgres", "-c", "log_statement=all"]

然后查看数据库容器的日志。

优点

• 通过取消注释/注释单行来打开/关闭日志记录
• 适用于prefetch_lated
• 适用于像Django Ninja这样的API框架（调试工具栏可能不需要）
• 不需要对 Django 代码进行任何更改

缺点

• Docker/Postgre 唯一的解决方案 - 启用日志记录的相同技术适用于任何数据库，但此答案的范围有限，
• 显示的某些查询不感兴趣

Answer 9

您可以使用 Django debug_toolbar 来查看 SQL 查询。
debug_toolbar 使用分步指南：

安装 Debug_toolbar

pip install django-debug-toolbar

编辑 settings.py 文件 & 将 debug_toolbar 添加到已安装的应用程序，这应该添加到“django.contrib.staticfiles”下面。 还将 debug_toolbar 添加到中间件。

设置.py=>

INSTALLED_APPS= [ 'debug_toolbar'] 

MIDDLEWARE = ['debug_toolbar.middleware.DebugToolbarMiddleware']

在settings.py文件中创建一个名为INTERNAL_IPS的新列表

Settings.py=> 在 settings.py 文件末尾创建新列表； 添加以下列表：

INTERNAL_IPS= [127.0.0.1']

这将允许调试仅在内部开发服务器上运行

编辑#Project & 的 urls.py 文件 添加以下代码：

if settings.DEBUG:
    import debug_toolbar
    urlpatterns = [
    url(r'^__debug__/', include(debug_toolbar.urls))       
    ] + urlpatterns

apply migrate & 再次运行服务器

您将在网页上看到一个附加组件，地址为 127.0.0.1 & 如果单击 SQL 查询复选框，您实际上还可以看到查询的运行时间。