Format SQL code prodcued by sqlmigrate

[Paolo Melchiorre]

I propose to use sqlparse, which is already a Django dependency, to format the SQL code generated by the sqlmigrate command.

django/core/management/commands/sqlmigrate.py

@@ +1 @@
+import sqlparse
+
 from django.apps import apps
 from django.core.management.base import BaseCommand, CommandError
 from django.db import DEFAULT_DB_ALIAS, connections
@@ -80 +82 @@
         sql_statements = loader.collect_sql(plan)
         if not sql_statements and options["verbosity"] >= 1:
             self.stderr.write("No operations found.")
-        return "\n".join(sql_statements)
+        return sqlparse.format("\n".join(sql_statements), reindent=True)

[David Sanders]

Personally I'm not sure it's worth formatting… it's kinda nice to have the current format have 1 line per ddl statement. Additionally in my experience sqlmigrate's formatting of ddl is lack lustre 🤷‍♂️

[Natalia Bidart]

Thanks Paolo for your ticket!

I personally think that if we were to do this, it should be via a dedicated CLI switch, I wouldn't change the default formatting because there may be tools that parse this output and assume one command per line.

Having said that, I would suggest/like that this feature request is proposed in the Django forum to reach a wider audience, Trac notifications are receive by a small subset of people from the community.

Following the triage procedure, I'll close as wontfix pending the conversation in the forum, happy to re-open later!

[Natalia Bidart]

Replying to David Sanders:

Personally I'm not sure it's worth formatting… it's kinda nice to have the current format have 1 line per ddl statement. Additionally in my experience sqlmigrate's formatting of ddl is lack lustre 🤷‍♂️

Did you mean that sqlmigrate's formatting is subpar, or that sqlparse's is?

[David Sanders]

Did you mean that sqlmigrate's formatting is subpar, or that sqlparse's is?

oops! I meant sqlparse :)