Фильтрация выборки из БД методами filter() и filter_by() в SQLAlchemy ORM

Одним из основных инструментов для выборки данных в ORM является метод filter(). В этой статье мы познакомимся с его возможностями и научимся использовать различные выражения для фильтрации.

Основы метода filter()

Метод filter() используется для ограничения выборки записей, основанных на определенных условиях, и возвращает новый объект запроса, содержащий эти условия.

Простой пример:

users = session.query(User).filter(User.name == 'John').all()

В приведенном примере мы выбираем всех пользователей с именем "John".

Выражения для filter()

С помощью filter() можно использовать различные операторы и методы для создания более сложных условий.

Основные операторы:

Равенство: filter(User.name == 'John')
Неравенство: filter(User.name != 'John')
Больше/меньше: filter(User.age > 25), filter(User.age < 25)
Интервалы: filter(User.age.between(20, 30))

Использование строковых методов (для строковых столбцов):

Содержит: filter(User.name.contains('John'))
Начинается с: filter(User.name.startswith('J'))
Заканчивается на: filter(User.name.endswith('n'))
Регистронезависимые операции: filter(func.lower(User.name) == 'john')

В работе со списками:

В: filter(User.name.in_(['John', 'Jane']))
Не в: filter(~User.name.in_(['John', 'Jane']))

NULL значения:

Проверка на NULL: filter(User.name == None)
Проверка на не NULL: filter(User.name != None)

Использование and_ и or_:

При использовании нескольких условий иногда необходимо использовать логические операторы. В SQLAlchemy предоставляются специальные функции: and_(), or_() и not_().

Пример:

from sqlalchemy import and_, or_
users = session.query(User).filter(and_(User.name == 'John', User.age < 30)).all()

Расширенные возможности filter()

Метод filter() также позволяет работать со связанными таблицами. Например, если у нас есть связь между пользователями и их адресами, мы можем выбирать пользователей на основе свойств их адресов:

users_with_specific_address = session.query(User).join(User.addresses).filter(Address.email == "john@example.com").all()

Комбинирование условий в filter()

Метод filter() можно вызывать многократно, и это будет равносильно использованию оператора AND между условиями. Например:

users = session.query(User).filter(User.name == 'John').filter(User.age < 30).all()

Обработка ошибок при использовании filter()

При работе с методом filter() и базой данных в целом могут возникнуть различные исключения. Важно уметь их обрабатывать:

OperationalError: Ошибка, связанная с базой данных. Например, сервер базы данных недоступен.
DataError: Ошибка, вызванная неправильными данными, например, при попытке записать слишком длинную строку в столбец с ограничением по длине.
IntegrityError: Ошибки целостности, такие как нарушения ограничений уникальности.

Пример обработки ошибок:

from sqlalchemy.exc import OperationalError, DataError, IntegrityError

try:
    users = session.query(User).filter(User.name == 'John').all()
except OperationalError:
    print("Ошибка подключения к базе данных.")
except DataError:
    print("Неправильные данные.")
except IntegrityError:
    print("Ошибка целостности данных.")

Основы метода filter_by()

filter_by() — это удобный и прямолинейный метод фильтрации, который обеспечивает более "читаемый" синтаксис в сравнении с filter(). Он особенно полезен в простых запросах, где не требуется сложная логика.

Метод filter_by() использует имена атрибутов для задания условий:

users = session.query(User).filter_by(name='John').all()

В приведенном выше примере будут выбраны все записи из таблицы User, где имя равно 'John'.

Комбинирование условий filter_by()

Вы можете комбинировать условия, просто добавив дополнительные аргументы:

users = session.query(User).filter_by(name='John', age=25).all()

Здесь мы выбираем пользователей с именем "John" и возрастом 25 лет.

Ограничения filter_by()

Важно понимать, что filter_by() менее гибкий в сравнении с filter(). Он предназначен для простых запросов с равенством и не поддерживает сложные операции и выражения. Если вам нужно выполнить более сложный запрос, вы должны использовать filter().

Преимущества и недостатки filter_by()

Преимущества:

Читаемость: для простых запросов filter_by() может быть более читаемым и очевидным.
Простота: не требует импорта дополнительных функций или классов.

Недостатки:

Ограниченность: filter_by() не может обрабатывать сложные условия или использовать SQL-функции.
Меньшая гибкость: в отличие от filter(), filter_by() работает только с атрибутами, не с колонками.

Пример использования filter_by() с различными моделями

Если у вас есть связанные модели, вы можете использовать filter_by() в комбинации с отношениями:

# Предположим, у нас есть модель Post, связанная с User:
class Post(Base):
    __tablename__ = 'posts'
    id = Column(Integer, primary_key=True)
    user_id = Column(Integer, ForeignKey('users.id'))
    content = Column(String)

johns_post = session.query(Post).join(User).filter_by(name='John').first()

В этом примере мы ищем первый пост пользователя с именем "John".

Заключение

Метод filter() в SQLAlchemy ORM — это мощный инструмент, который предоставляет гибкие возможности для создания запросов к вашей базе данных. Учитывая разнообразие доступных операторов и методов, вы можете легко и эффективно создавать сложные условия для выборки данных, что делает ваш код более читаемым и понятным. А filter_by() — подходит для выполнения простых запросов в SQLAlchemy ORM. Несмотря на свои ограничения, он остается ценным для быстрого и прямолинейного запроса данных без необходимости добавления сложных выражений.

Подпишись на наш telegram-канал FullStacker и получай свежие статьи, мануалы и шпаргалки по Python первым

Содержание:

Читайте в Telegram