Django snippets: Pretty print SQL of query sets

Pretty print SQL of query sets

import sqlparse

def print_sql(qs):
    q = qs.query.as_sql()
    statement = q[0] % q[1]
    print sqlparse.format(statement, reindent=True, keyword_case='upper')

More like this

DebugFooter middleware with Pygments sql syntax highlighting by monolar 3 years, 8 months ago
print SQL statements by zuzelvp 2 years ago
SQL Log To Console Middleware by davepeck 2 years, 6 months ago
Format transition middleware by limodou 4 years, 11 months ago
Serializing booleans correctly when doing dumpdata from a MySQL database using Django 0.96 by chrj 3 years, 6 months ago

Install sqlparse with easy_install sqlparse and then you can easily debug the SQL like this:

def view(request):
    data = MyModel.objects.filter(something__very=complex)
    print_sql(data)
    ...

Inspired by Simon Willison

Author:: peterbe
Posted:: May 5, 2009
Language:: Python
Django Version:: 1.0
Tags:: sqlparse queryset sql
Score:: 0 (after 0 ratings)

Tools

Comments

peterbe (on May 5, 2009):

You might want to wrap this with something so that this doesn't get used in non-development mode. For example:

if not settings.DEBUG:
    def print_sql(*__):
        pass

canassa (on August 6, 2010):

This should work in Django 1.2:

def print_sql(qs):
    q = qs.query.__str__()
    print sqlparse.format(q, reindent=True, keyword_case='upper')