Выполнение необработанных SQL-запросов

Сопоставление полей запроса с полями модели

raw() автоматически сопоставляет поля запроса с полями модели.

Порядок полей в запросе не имеет значения. Иными словами, оба следующих запроса работают одинаково:

>>> Person.objects.raw("SELECT id, first_name, last_name, birth_date FROM myapp_person")
>>> Person.objects.raw("SELECT last_name, birth_date, first_name, id FROM myapp_person")

Сопоставление выполняется по имени. Это означает, что вы можете использовать предложения AS в SQL для сопоставления полей запроса с полями модели. Поэтому, если у вас есть другая таблица с данными Person, их можно легко сопоставить с экземплярами Person:

>>> Person.objects.raw(
...     """
...     SELECT first AS first_name,
...            last AS last_name,
...            bd AS birth_date,
...            pk AS id,
...     FROM some_other_table
...     """
... )

Пока имена совпадают, экземпляры модели будут созданы правильно.

В качестве альтернативы можно сопоставить поля запроса с полями модели с помощью аргумента translations метода raw(). Это словарь, сопоставляющий имена полей в запросе с именами полей модели. Например, приведённый выше запрос можно также записать так:

>>> name_map = {"first": "first_name", "last": "last_name", "bd": "birth_date", "pk": "id"}
>>> Person.objects.raw("SELECT * FROM some_other_table", translations=name_map)

Обращение по индексу

raw() поддерживает обращение по индексу, поэтому, если вам нужен только первый результат, можно написать:

>>> first_person = Person.objects.raw("SELECT * FROM myapp_person")[0]

Однако индексация и срезы не выполняются на уровне базы данных. Если в вашей базе данных хранится большое количество объектов Person, эффективнее ограничить запрос на уровне SQL:

>>> first_person = Person.objects.raw("SELECT * FROM myapp_person LIMIT 1")[0]

Отложенная загрузка полей модели

Поля также можно не указывать:

>>> people = Person.objects.raw("SELECT id, first_name FROM myapp_person")

Объекты Person, возвращённые этим запросом, будут экземплярами моделей с отложенной загрузкой полей (см. defer()). Это означает, что поля, не включённые в запрос, будут загружаться по требованию. Например:

>>> for p in Person.objects.raw("SELECT id, first_name FROM myapp_person"):
...     print(
...         p.first_name,  # This will be retrieved by the original query
...         p.last_name,  # This will be retrieved on demand
...     )
...
John Smith
Jane Jones

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

Есть только одно поле, которое нельзя не указывать, — поле первичного ключа. Django использует первичный ключ для идентификации экземпляров модели, поэтому он всегда должен присутствовать в необработанном запросе. Если вы забудете включить первичный ключ, будет вызвано исключение FieldDoesNotExist.

Добавление аннотаций

Вы также можете выполнять запросы, содержащие поля, не определённые в модели. Например, можно использовать функцию age() в PostgreSQL, чтобы получить список людей с возрастом, вычисленным базой данных:

>>> people = Person.objects.raw("SELECT *, age(birth_date) AS age FROM myapp_person")
>>> for p in people:
...     print("%s is %s." % (p.first_name, p.age))
...
John is 37.
Jane is 42.
...

Часто вычислять аннотации с помощью необработанного SQL не нужно: вместо этого можно использовать выражение Func().

Передача параметров в raw()

Если вам нужно выполнять параметризованные запросы, можно использовать аргумент params метода raw():

>>> lname = "Doe"
>>> Person.objects.raw("SELECT * FROM myapp_person WHERE last_name = %s", [lname])

params — это список или словарь параметров. Для списка в строке запроса используются заполнители %s, а для словаря — заполнители %(key)s (где key заменяется ключом словаря), независимо от используемого движка базы данных. Эти заполнители будут заменены параметрами из аргумента params.

>>> query = "SELECT * FROM myapp_person WHERE last_name = %s" % lname
>>> Person.objects.raw(query)

>>> query = "SELECT * FROM myapp_person WHERE last_name = '%s'"

Подключения и курсоры

connection и cursor в основном реализуют стандартный Python DB-API, описанный в PEP 249, — за исключением обработки транзакций.

Если вы не знакомы с Python DB-API, обратите внимание, что в SQL-операторе cursor.execute() используются заполнители "%s", а параметры не вставляются непосредственно в SQL. При использовании этого способа нижележащая библиотека базы данных автоматически экранирует параметры по мере необходимости.

Также обратите внимание, что Django ожидает заполнитель "%s", а не заполнитель "?", используемый привязками Python для SQLite. Это сделано для согласованности и удобства.

Использование курсора в качестве менеджера контекста:

with connection.cursor() as c:
    c.execute(...)

эквивалентно следующему:

c = connection.cursor()
try:
    c.execute(...)
finally:
    c.close()