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

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(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]

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