Инструментирование базы данных

Для помощи в понимании и контроле запросов, выполняемых вашим кодом, Django предоставляет возможность установки оберток вокруг выполнения запросов к базе данных. Например, обертки могут подсчитывать запросы, измерять время выполнения запросов, регистрировать запросы или даже предотвращать выполнение запросов (например, чтобы убедиться, что запросы не выполняются при рендеринге шаблона с предварительно полученными данными).

Обертки моделируются по аналогии с средствами промежуточного программного обеспечения – это вызываемые объекты, которые принимают другой вызываемый объект в качестве одного из своих аргументов. Они вызывают этот вызываемый объект для вызова (возможно, обернутого) запроса к базе данных, и могут делать все, что им нужно, вокруг этого вызова. Однако они создаются и устанавливаются кодом пользователя, поэтому не нуждаются в отдельной фабрике, как средства промежуточного программного обеспечения.

Установка обертки выполняется в контекстном менеджере – таким образом, обертки временные и специфичные для определенного потока в вашем коде.

Как упоминалось выше, примером обертки является блокировщик выполнения запроса. Он может выглядеть так:

def blocker(*args):
    raise Exception('No database access allowed here.')

И он будет использоваться в представлении для блокировки запросов из шаблона следующим образом:

from django.db import connection
from django.shortcuts import render

def my_view(request):
    context = {...}  # Code to generate context with all data.
    template_name = ...
    with connection.execute_wrapper(blocker):
        return render(request, template_name, context)

Параметры, передаваемые оберткам:

• execute – вызываемый объект, который должен быть вызван с остальными параметрами для выполнения запроса.
• sql – str, SQL-запрос, который будет отправлен в базу данных.
• params – список/кортеж значений параметров для SQL-команды или список/кортеж списков/кортежей, если обернутый вызов является executemany().
• many – bool, указывающий, является ли конечный вызванный вызов execute() или executemany() (и ожидается ли params быть последовательностью значений или последовательностью последовательностей значений).
• context – словарь с дополнительными данными о контексте вызова. Это включает соединение и курсор.

Используя параметры, несколько более сложная версия блокировщика может включать имя подключения в сообщение об ошибке:

def blocker(execute, sql, params, many, context):
    alias = context['connection'].alias
    raise Exception("Access to database '{}' blocked here".format(alias))

Для более полного примера, регистратор запросов может выглядеть так:

import time

class QueryLogger:

    def __init__(self):
        self.queries = []

    def __call__(self, execute, sql, params, many, context):
        current_query = {'sql': sql, 'params': params, 'many': many}
        start = time.monotonic()
        try:
            result = execute(sql, params, many, context)
        except Exception as e:
            current_query['status'] = 'error'
            current_query['exception'] = e
            raise
        else:
            current_query['status'] = 'ok'
            return result
        finally:
            duration = time.monotonic() - start
            current_query['duration'] = duration
            self.queries.append(current_query)

Чтобы использовать это, вы создали бы объект регистратора и установили его в качестве обертки:

from django.db import connection

ql = QueryLogger()
with connection.execute_wrapper(ql):
    do_queries()
# Now we can print the log.
print(ql.queries)

connection.execute_wrapper()

execute_wrapper(wrapper)

Возвращает контекстный менеджер, который при входе устанавливает обёртку вокруг выполнения запросов к базе данных, а при выходе удаляет обёртку. Обёртка устанавливается на объекте подключения в локальном хранилище потока.

wrapper – это вызываемый объект, принимающий пять аргументов. Он вызывается для каждого выполнения запроса в рамках контекстного менеджера с аргументами execute, sql, params, many, и context, как описано выше. Ожидается, что он вызовет execute(sql, params, many, context) и вернёт значение возврата этого вызова.