feat: New parameter PRETTIFY_SQL

Author: Louis Béranger

debug_toolbar/panels/sql/utils.py

@@ -4,6 +4,8 @@
 from django.utils.html import escape
 from sqlparse import tokens as T
 
+from debug_toolbar import settings as dt_settings
+
 
 class BoldKeywordFilter:
     """sqlparse filter to bold SQL keywords"""
@@ -31,7 +33,8 @@ def reformat_sql(sql, with_toggle=False):
 
 def parse_sql(sql, aligned_indent=False):
     stack = sqlparse.engine.FilterStack()
-    stack.enable_grouping()
+    if dt_settings.get_config()["PRETTIFY_SQL"]:
+        stack.enable_grouping()
     if aligned_indent:
         stack.stmtprocess.append(
             sqlparse.filters.AlignedIndentFilter(char="&nbsp;", n="<br/>")

debug_toolbar/settings.py

@@ -41,6 +41,7 @@
     "SHOW_TEMPLATE_CONTEXT": True,
     "SKIP_TEMPLATE_PREFIXES": ("django/forms/widgets/", "admin/widgets/"),
     "SQL_WARNING_THRESHOLD": 500,  # milliseconds
+    "PRETTIFY_SQL": True,
 }
 
 

docs/configuration.rst

@@ -221,6 +221,40 @@ Panel options
   The SQL panel highlights queries that took more that this amount of time,
   in milliseconds, to execute.
 
+* ``PRETTIFY_SQL``
+
+  Default: ``True``
+
+  Panel: SQL
+
+  Controls SQL token grouping.
+
+  Token grouping allows pretty print of similar tokens,
+  like aligned indentation for every selected field.
+
+  When set to ``True``, it might cause render slowdowns
+  when a view make long SQL textual queries.
+
+  **Without grouping**::
+
+    SELECT "auth_user"."id", "auth_user"."password", "auth_user"."last_login", "auth_user"."is_superuser", "auth_user"."username", "auth_user"."first_name", "auth_user"."last_name"
+    FROM "auth_user"
+    WHERE "auth_user"."username" = '''test_username'''
+    LIMIT 21
+
+  **With grouping**::
+
+    SELECT "auth_user"."id",
+       "auth_user"."password",
+       "auth_user"."last_login",
+       "auth_user"."is_superuser",
+       "auth_user"."username",
+       "auth_user"."first_name",
+       "auth_user"."last_name",
+      FROM "auth_user"
+    WHERE "auth_user"."username" = '''test_username'''
+    LIMIT 21
+
 Here's what a slightly customized toolbar configuration might look like::
 
     # This example is unlikely to be appropriate for your project.