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

В этом документе содержатся ссылки на API поиска, Django API для построения 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, базовый класс всех полей модели, и Transform, базовый класс всех преобразований Django.

class lookups.RegisterLookupMixin

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

classmethod register_lookup(lookup, lookup_name=None)

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

get_lookup(lookup_name)

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

get_lookups()

Возвращает словарь, где каждый ключ — имя зарегистрированного поиска, а значение — класс Lookup.

get_transform(transform_name)

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

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

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

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

as_sql(compiler, connection)

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

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

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

as_vendorname(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(), которое принимает только один аргумент. Его также можно использовать в правой части фильтра или напрямую как аннотацию.

bilateral

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

lhs

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

lookup_name

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

output_field

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

Lookup справочник

class Lookup [source]

A 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(), для правой части.