This package provides a simple context manager for Django applications that will output the SQL queries caused by a block of code to standard output.
(To pre-empt a common question: Django Debug Toolbar lets you see the queries caused by HTTP requests to your application, but often I want to track down the queries that are used in a management command or some other context than making requests in your browser; the show_queries context manager in this package helps in those other situations.)
If you have sqlparse installed, then the SQL will be pretty-printed to make them easier to read, so I’d recommend that you also do:
pip install sqlparse
Example
from django_debug_queries import show_queries
...
with show_queries():
people = list(Person.objects.filter(date_of_birth__gt="2000-01-01") \
.values('id', 'legal_name'))
sessions = list(ParliamentarySession.objects.all())
This might output the following to standard output:
--===--
Number of queries: 2
Query 0 (taking 0.003):
SELECT "core_person"."id",
"core_person"."legal_name"
FROM "core_person"
WHERE "core_person"."date_of_birth" > '2000-01-01'
ORDER BY "core_person"."sort_name" ASC
Query 1 (taking 0.005):
SELECT "core_parliamentarysession"."id",
"core_parliamentarysession"."created",
"core_parliamentarysession"."updated",
"core_parliamentarysession"."start_date",
"core_parliamentarysession"."end_date",
"core_parliamentarysession"."house_id",
"core_parliamentarysession"."position_title_id",
"core_parliamentarysession"."mapit_generation",
"core_parliamentarysession"."name",
"core_parliamentarysession"."slug"
FROM "core_parliamentarysession"
ORDER BY "core_parliamentarysession"."start_date" ASC
End of query output.
Other options
Long query strings can take a long time to pretty-print using sqlparse, so by default SQL that is longer that 2048 characters is not formatted; you can adjust that limit with the optional sqlparse_character_limit parameter, e.g.:
with show_queries(sqlparse_character_limit=8192):
...
If you are using multiple databases in your Django application, you can tell this to use a particular database with the optional db_alias parameter, e.g.
with show_queries(db_alias='my_other_db'):
...
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-debug-queries-0.0.7.tar.gz.
File metadata
- Download URL: django-debug-queries-0.0.7.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4372619a7869023fd1fbf777c25cd7b33612421390861e68577caec82545bd2
|
|
| MD5 |
848a55d1b06703a55c78827dbbeb66cf
|
|
| BLAKE2b-256 |
eeb7f9c394837dd420fd59c13a213382110f8355da616dbdcc90860c354bbedb
|