ddquery

ddquery copied to clipboard

Django Debug Query (ddquery)

Ddquery is a library built in python that add color in your SQL statements and show in your command shell (pretty), for relational databases that uses ORM of the Django

Requirements

• Python ≥ 3.3
• Django ≥ 1.8

How to use

.. code-block:: console

pip install ddquery

Add it to your Django Logging settings

You can add it to your Django LOGGING settings:

.. code-block:: python

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'handlers': {
            'sqlhandler': {
                'level': 'DEBUG',
                'class': 'logging.StreamHandler',
                'formatter': 'sqlformatter'
            }
        },
        'formatters': {
            'sqlformatter': {
                '()': 'ddquery.SqlFormatter',
                'format': '%(levelname)s %(message)s',
            },
        },
        'loggers': {
            'django.db.backends': {
                'handlers': ['sqlhandler'],
                'level': 'DEBUG',
            },
        }
    }

Configuration options

.. code-block:: python

'formatters': {
    'sqlformatter': {
        '()': 'sqlformatter.SqlFormatter',
        'format': '%(levelname)s %(message)s',
        'reindent': False,
        'highlight': False,
        'keyword_case': 'lower'
    },
},

How it looks like?

.. code-block:: console

python manage.py runserver

.. image:: https://raw.githubusercontent.com/elinaldosoft/ddquery/master/imgs/shell-01.png :alt: Shell

.. code-block:: console

python manage.py shell

.. image:: https://raw.githubusercontent.com/elinaldosoft/ddquery/master/imgs/shell-02.png :alt: Shell 02

.. code-block:: console

python manage.py migration

.. image:: https://raw.githubusercontent.com/elinaldosoft/ddquery/master/imgs/migration.png :alt: Migration

References

• https://github.com/henriquebastos/sqlformatter
• http://henriquebastos.net/sqlformatter-beautiful-colored-sql-statements-for-logging/
• https://markusholtermann.eu/2016/01/syntax-highlighting-for-djangos-sql-query-logging/