Метод between

Метод between класса ColumnElement создает выражение SQL BETWEEN, которое проверяет, находится ли значение столбца в заданном диапазоне включительно. Первым параметром метод принимает нижнюю границу диапазона, вторым параметром - верхнюю границу. Метод возвращает объект BinaryExpression, который можно использовать в условиях where, filter и других частях запроса. Если значение столбца равно любой из границ, оно также попадает в результат.

Синтаксис

ColumnElement.between(cleft, cright)

Пример

Давайте создадим модель статьи и выберем записи, у которых поле num находится в диапазоне от 10 до 20:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article 1', text='text 1', status='draft', num=5),
		Article(title='article 2', text='text 2', status='published', num=15),
		Article(title='article 3', text='text 3', status='published', num=25),
	])
	session.commit()
	
	stmt = select(Article.title).where(Article.num.between(10, 20))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article 2']

Пример

Метод between можно применять и к строковым столбцам. Давайте выберем статьи, у которых заголовок находится в алфавитном диапазоне от article 1 до article 2:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article 1', text='text 1', status='draft', num=1),
		Article(title='article 2', text='text 2', status='published', num=2),
		Article(title='article 3', text='text 3', status='published', num=3),
	])
	session.commit()
	
	stmt = select(Article.title).where(Article.title.between('article 1', 'article 2'))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article 1', 'article 2']

Пример

Метод between можно инвертировать с помощью оператора ~. Давайте выберем статьи, у которых поле num не входит в диапазон от 10 до 20:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, Session

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)

with Session(engine) as session:
	session.add_all([
		Article(title='article 1', text='text 1', status='draft', num=5),
		Article(title='article 2', text='text 2', status='published', num=15),
		Article(title='article 3', text='text 3', status='published', num=25),
	])
	session.commit()
	
	stmt = select(Article.title).where(~Article.num.between(10, 20))
	res = session.execute(stmt).scalars().all()
	print(res)

Результат выполнения кода:

['article 1', 'article 3']

Пример

Давайте посмотрим, какой SQL-запрос генерирует метод between:

from sqlalchemy import create_engine, select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column

class Base(DeclarativeBase):
	pass

class Article(Base):
	__tablename__ = 'articles'
	
	id: Mapped[int] = mapped_column(primary_key=True)
	title: Mapped[str]
	text: Mapped[str]
	status: Mapped[str]
	num: Mapped[int]

stmt = select(Article.title).where(Article.num.between(10, 20))
print(stmt)

Итоговый SQL запрос:

SELECT articles.title
FROM articles
WHERE articles.num BETWEEN :num_1 AND :num_2

Смотрите также

класс ColumnElement,
который представляет базовый элемент столбца
метод in_,
который проверяет вхождение значения в список
метод like,
который ищет совпадения по шаблону
метод is_,
который сравнивает значение с NULL или другим выражением