Справочник по API поиска

В данном документе содержатся ссылки на API поиска, предоставляемые Django для построения WHERE условия базы данных. Чтобы узнать, как использовать поиск, см. Выполнение запросов; чтобы узнать, как создать новые запросы, см. Пользовательские запросы.

API поиска состоит из двух компонентов: класса RegisterLookupMixin, который регистрирует запросы, и API выражений запроса, набора методов, которые класс должен реализовать, чтобы быть зарегистрированным как запрос.

Django имеет два базовых класса, которые следуют API выражений запроса и от которых происходят все встроенные запросы Django:

• Lookup: для поиска поля (например, exact поля field_name__exact)
• Transform: для преобразования поля

Выражение поиска состоит из трех частей:

• Часть поля (например, Book.objects.filter(author__best_friends__first_name...);
• Часть преобразований (может быть опущена) (например, __lower__first3chars__reversed);
• Поиск (например, __icontains) который, если опущен, по умолчанию равен __exact.

API регистрации

Django использует RegisterLookupMixin, чтобы предоставить классу интерфейс для регистрации запросов в нем. Два ярких примера — Field, базовый класс всех полей модели, и Aggregate, базовый класс всех агрегатов Django.

class lookups.RegisterLookupMixin

Mixin, реализующий API поиска для класса.

classmethod register_lookup(lookup, lookup_name=None)

Регистрирует новый поиск в классе. Например, DateField.register_lookup(YearExact) зарегистрирует YearExact запрос для DateField. Он перезаписывает запрос, который уже существует с тем же именем. lookup_name будет использоваться для этого запроса, если он предоставлен, в противном случае будет использоваться lookup.lookup_name.

Изменено в Django 1.9:

Добавлен параметр lookup_name.

get_lookup(lookup_name)

Возвращает Lookup с именем lookup_name , зарегистрированным в классе. Стандартная реализация выполняет рекурсивный поиск по всем родительским классам и проверяет, имеет ли какой-либо из них зарегистрированный запрос с именем lookup_name, возвращая первую найденную запись.

get_transform(transform_name)

Возвращает Transform с именем transform_name. Стандартная реализация рекурсивно ищет по всем родительским классам, чтобы проверить, имеет ли какой-либо из них зарегистрированное преобразование с именем transform_name, возвращая первую найденную запись.

Для того, чтобы класс был запросом, он должен следовать API выражений запроса. Lookup и Transform естественным образом следуют этому API.

API выражений запроса

API выражений запроса — это общий набор методов, которые классы определяют для использования в выражениях запросов, чтобы преобразовать себя в выражения SQL. Прямые ссылки на поля, агрегаты и Transform — это примеры, которые следуют этому API. Говорят, что класс следует API выражений запроса, когда он реализует следующие методы:

as_sql(self, compiler, connection)

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

Вызов expression.as_sql() обычно некорректен — вместо этого следует использовать compiler.compile(expression) . Метод compiler.compile() позаботится о вызове специфичных для поставщика методов выражения.

В этом методе могут быть определены пользовательские ключевые аргументы, если вероятно, что методы as_vendorname() или подклассы будут нуждаться в предоставлении данных для переопределения генерации строки SQL. См. Func.as_sql() для примера использования.

as_vendorname(self, compiler, connection)

Действует как метод as_sql(). Когда выражение компилируется с помощью compiler.compile(), Django сначала попытается вызвать as_vendorname(), где vendorname — это имя поставщика используемого бэкенда для выполнения запроса. vendorname — это одно из postgresql, oracle, sqlite, или mysql для встроенных бэкендов Django.

get_lookup(lookup_name)

Должен вернуть запрос с именем lookup_name. Например, возвращая self.output_field.get_lookup(lookup_name).

get_transform(transform_name)

Должен вернуть запрос с именем transform_name. Например, возвращая self.output_field.get_transform(transform_name).

output_field

Определяет тип класса, возвращаемого методом get_lookup(). Это должен быть экземпляр Field.

Transform справочник

class Transform [source]

Transform — это общий класс для реализации преобразований полей. Яркий пример — __year, преобразующий DateField в IntegerField.

Запись для использования Transform в выражении запроса — <expression>__<transformation> (например, date__year).

Этот класс соответствует API выражений запроса, что подразумевает, что вы можете использовать <expression>__<transform1>__<transform2>. Это специализированное выражение Func(), принимающее только один аргумент. Его также можно использовать в правой части фильтра или непосредственно как аннотацию.

Изменено в Django 1.9:

Transform теперь является подклассом Func.

bilateral

Булево значение, указывающее, следует ли применять это преобразование к lhs и rhs. Двусторонние преобразования применяются к rhs в том же порядке, в котором они появляются в выражении поиска. По умолчанию он равен False. Пример использования см. в Пользовательских запросах.

lhs

Левая часть — то, что преобразуется. Он должен соответствовать API выражений запроса.

lookup_name

Имя запроса, используемое для его идентификации при разборе выражений запроса. Он не может содержать строку "__".

output_field

Определяет класс, который выдает это преобразование. Он должен быть экземпляром Field. По умолчанию совпадает с lhs.output_field.

Lookup справочник

class Lookup [source]

Класс Lookup — это общий класс для реализации поисковых запросов. Поисковый запрос — это выражение запроса с левой частью, lhs; правой частью, rhs; и lookup_name, используемой для создания булевого сравнения между lhs и rhs , например, lhs in rhs или lhs > rhs.

Для использования поискового запроса в выражении используется запись <lhs>__<lookup_name>=<rhs>.

Этот класс не следует API выражений запроса, поскольку он имеет =<rhs> при создании: поисковые запросы всегда являются концом выражения поиска.

lhs

Левая часть — то, что ищется. Объект должен соответствовать API выражений запроса.

rhs

Правая часть — то, с чем lhs сравнивается. Это может быть простое значение или нечто, что компилируется в SQL, обычно объект F() или QuerySet.

lookup_name

Имя этого поискового запроса, используемое для его идентификации при разборе выражений запроса. Оно не может содержать строку "__".

process_lhs(compiler, connection, lhs=None) [source]

Возвращает кортеж (lhs_string, lhs_params), как возвращает compiler.compile(lhs). Этот метод можно переопределить, чтобы настроить обработку lhs.

compiler — это объект SQLCompiler, который используется как compiler.compile(lhs) для компиляции lhs. connection можно использовать для компиляции поставщика SQL. Если lhs не None, используйте его как обработанную lhs вместо self.lhs.

process_rhs(compiler, connection) [source]

Ведет себя так же, как process_lhs(), для правой части.