Запуск сырых 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')
...

Переписка ведется по имени. Это означает, что вы можете использовать предложения SQL AS для сопоставления полей в запросе с полями в шаблоне. Итак, если у вас есть другая таблица, содержащая данные 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 запроса. По запросу были получены только имена (first_name), raw() каждое из имен (last_name) было получено по запросу при отображении.

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

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

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

>>> 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 основном реализовать стандартный API базы данных Python, описанный вPEP 249 , за исключением управления транзакциями .

Если вы не знакомы с этим API-интерфейсом Python DB, обратите внимание, что оператор 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()