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

Для того, чтобы помочь вам понять и контролировать запросы, выполняемые вашим кодом, 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) и вернёт результат этого вызова.