Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

django_print_sql is an easy-to-use SQL debug tool for Django developers to print SQL statements

Project description

django-print-sql is an easy-to-use SQL debug tool for Django developers to print SQL statements

What’s new

2018.3.6

  • Added a decorator
  • It now prints how long it takes each query to execute, as well as the total time elapsed

Requirements

You need to have django installed (obviously).

I’ve tried it on Django 1.11.11 and 2.0.3.

If sqlparse is installed, the SQL statement wil be formatted.

Install

From pip, run:

$ pip install --upgrade django-print-sql

Consider using the --user option.

From the repository, run:

python setup.py install

to install django-print-sql on your system.

django-print-sql is compatible with Python 2.7 and Python 3 (>= 3.3) (hopefully :D).

Install sqlparse to pretty print the statements:

$ pip install --upgrade sqlparse

Usage

Example 1. Use as context manager:

from django_print_sql import print_sql

# set `count_only` to `True` will print the number of executed SQL statements only
with print_sql(count_only=False):

  # write the code you want to analyze in here,
  # e.g. some complex foreign key lookup,
  # or analyzing a DRF serializer's performance

  for user in User.objects.all()[:10]:
      user.groups.first()

Example 2. Use as decorator:

from django_print_sql import print_sql_decorator


  @print_sql_decorator(count_only=False)  # this works on class-based views as well
  def get(request):
      # your view code here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-print-sql-2018.3.6.tar.gz (3.1 kB) Copy SHA256 hash SHA256 Source None Mar 15, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page