Comment afficher la requête SQL correspondante du jeu de requêtes de Django ORM?

Existe-t-il un moyen d'imprimer la requête générée par Django ORM?

Disons que j'exécute l'instruction suivante: Model.objects.filter(name='test')

Comment puis-je voir la requête SQL générée?

Chaque objet QuerySet possède un queryattribut que vous pouvez enregistrer ou imprimer sur stdout à des fins de débogage.

qs = Model.objects.filter(name='test')
print qs.query

Éditer

J'ai également utilisé des balises de modèle personnalisées (comme indiqué dans cet extrait de code) pour injecter les requêtes dans le cadre d'une seule demande sous forme de commentaires HTML.

Vous pouvez également utiliser la journalisation python pour journaliser toutes les requêtes générées par Django. Ajoutez simplement ceci à votre fichier de paramètres.

LOGGING = {
    'disable_existing_loggers': False,
    'version': 1,
    'handlers': {
        'console': {
            # logging handler that outputs log messages to terminal
            'class': 'logging.StreamHandler',
            'level': 'DEBUG', # message level to be written to console
        },
    },
    'loggers': {
        '': {
            # this sets root level logger to log debug and higher level
            # logs to console. All other loggers inherit settings from
            # root level logger.
            'handlers': ['console'],
            'level': 'DEBUG',
            'propagate': False, # this tells logger to send logging message
                                # to its parent (will send if set to True)
        },
        'django.db': {
            # django also has database level logging
        },
    },
}

Une autre méthode au cas où l'application génère une sortie html - la barre d'outils de débogage django peut être utilisée.

Vous pouvez coller ce code sur votre shell qui affichera toutes les requêtes SQL:

# To get all sql queries sent by Django from py shell
import logging
l = logging.getLogger('django.db.backends')
l.setLevel(logging.DEBUG)
l.addHandler(logging.StreamHandler())

Tant qu'il DEBUGest allumé:

from django.db import connection
print(connection.queries)

Pour une requête individuelle, vous pouvez faire:

print(Model.objects.filter(name='test').query)

Vous devriez peut-être jeter un œil à l' django-debug-toolbarapplication, elle enregistrera toutes les requêtes pour vous, affichera les informations de profilage pour elles et bien plus encore.

Une solution robuste consisterait à enregistrer votre serveur de base de données dans un fichier, puis

tail -f /path/to/the/log/file.log

Si vous utilisez le routage de base de données, vous disposez probablement de plusieurs connexions à la base de données. Un code comme celui-ci vous permet de voir les connexions dans une session. Vous pouvez réinitialiser les statistiques de la même manière qu'avec une seule connexion:reset_queries()

from django.db import connections,connection,reset_queries
...
reset_queries()  # resets data collection, call whenever it makes sense

...

def query_all():
    for c in connections.all():
        print(f"Queries per connection: Database: {c.settings_dict['NAME']} {c.queries}")

# and if you just want to count the number of queries
def query_count_all()->int:
    return sum(len(c.queries) for c in connections.all() )

Vous pouvez utiliser une debug_toolbar Django pour afficher la requête SQL. Guide étape par étape pour l'utilisation de debug_toolbar:

Installez la Debug_toolbar

pip install django-debug-toolbar

Modifiez le fichier settings.py et ajoutez debug_toolbar aux applications installées, cela devrait être ajouté ci-dessous à «django.contrib.staticfiles». Ajoutez également debug_toolbar au middleware.

Settings.py =>

INSTALLED_APPS= [ 'debug_toolbar'] 

MIDDLEWARE = ['debug_toolbar.middleware.DebugToolbarMiddleware']

créer une nouvelle liste nommée INTERNAL_IPS dans le fichier settings.py

Settings.py => créer une nouvelle liste à la fin du fichier settings.py et ajouter la liste ci-dessous:

INTERNAL_IPS= [127.0.0.1']

Cela permettra au débogage de s'exécuter uniquement sur le serveur de développement interne

Modifiez le fichier urls.py de #Project et ajoutez le code ci-dessous:

if settings.DEBUG:
    import debug_toolbar
    urlpatterns = [
    url(r'^__debug__/', include(debug_toolbar.urls))       
    ] + urlpatterns

appliquer à nouveau migrer et exécuter le serveur

Vous verrez un module complémentaire sur votre page Web à 127.0.0.1 et si vous cliquez sur la case à cocher Requête SQL, vous pouvez également voir le temps d'exécution de la requête.