django运行测试时如何查看sql查询？

Question

我的一个django应用程序单元测试失败了

DatabaseError: ORA-00942: table or view does not exist

我想看到导致此错误的实际SQL查询.你知道怎么做吗？

Answer 1

如果要打印/记录测试中的所有 SQL查询,请尝试使用以下子TestCase类化:

from django.conf import settings
from django.template import Template, Context
import sys
from django.db import connection
from django.test import TestCase

class LoggingTestCase(TestCase):

  @staticmethod
  def setUpClass():
    # The test runner sets DEBUG to False. Set to True to enable SQL logging.
    settings.DEBUG = True
    super(LoggingTestCase, LoggingTestCase).setUpClass()

  @staticmethod
  def tearDownClass():
    super(LoggingTestCase, LoggingTestCase).tearDownClass()

    time = sum([float(q['time']) for q in connection.queries])
    t = Template("{{count}} quer{{count|pluralize:\"y,ies\"}} in {{time}} seconds:\n\n{% for sql in sqllog %}[{{forloop.counter}}] {{sql.time}}s: {{sql.sql|safe}}{% if not forloop.last %}\n\n{% endif %}{% endfor %}")
    print >> sys.stderr, t.render(Context({'sqllog': connection.queries, 'count': len(connection.queries), 'time': time}))

    # Empty the query list between TestCases.    
    connection.queries = []

然后在测试中使用LoggingTestCase而不是TestCase作为基类.tearDownClass如果你覆盖它,请记住调用它.

Answer 2

另一种选择是使用CaptureQueriesContext（用 测试pytest）。

from django.db import connection
from django.test.utils import CaptureQueriesContext


def test_foo():
    with CaptureQueriesContext(connection) as ctx:
        # code that runs SQL queries
        print(ctx.captured_queries)

资料来源：

• https://blog.ploetzli.ch/2019/showing-sql-queries-with-pytest-and-django/
• 如何强制 django 打印每个执行的 sql 查询

Answer 3

另一种选择是connection.execute_wrapper()在您的测试中使用，如下所示：

from django.db import connection

def logger(execute, sql, params, many, context):
    print(sql, params)
    return execute(sql, params, many, context)

class GizmoTest(TestCase):

    def test_with_sql_logging(self):
        with connection.execute_wrapper(logger):
            code_that_uses_database()

用 Django 2.2 测试。

Answer 4

您还可以执行以下操作来获取查询（例如，在测试中将其打印或评估）。

实际上，如今您不应该更改django.conf.settings，因此我使用override_settings。

from django.db import connection, reset_queries
from django.test import override_settings, TransactionTestCase

class TransactionTests(TransactionTestCase):

    @override_settings(DEBUG=True)
    def test_sql(self):
        reset_queries()
        try:
            # Code that uses the ORM goes here
        except Exception as e:
            pass
        self.assertEqual(connection.queries, [])

TestCase可能也合适，请参见此答案中的区别。

有关SQL输出的详细信息，请参见Django文档。

Answer 5

到目前为止我发现的最好的解决方案是 django-debugtoolbar 提供的 debugsqlshell 自定义 django 管理命令。