Метод distinct класса ColumnElement

Метод distinct класса ColumnElement добавляет к выражению SQL-оператор DISTINCT, который убирает дубликаты из результата запроса. Метод применяется к колонке или любому выражению и возвращает новый объект ColumnElement с модифицированным SQL-представлением. Обычно используется в связке с функцией select для получения уникальных значений столбца.

Синтаксис

column.distinct()

Пример

Давайте получим уникальные значения столбца status из таблицы articles:

from sqlalchemy import create_engine, select, String, Integer
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] = mapped_column(String)
	text: Mapped[str] = mapped_column(String)
	status: Mapped[str] = mapped_column(String)
	num: Mapped[int] = mapped_column(Integer)

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='published', num=1),
		Article(title='article 2', text='text 2', status='draft', num=2),
		Article(title='article 3', text='text 3', status='published', num=3),
	])
	session.commit()
	
	stmt = select(Article.status.distinct())
	res = session.execute(stmt).scalars().all()
	print(res)

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

['published', 'draft']

Пример

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

from sqlalchemy import create_engine, select, String, Integer
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] = mapped_column(String)
	text: Mapped[str] = mapped_column(String)
	status: Mapped[str] = mapped_column(String)
	num: Mapped[int] = mapped_column(Integer)

stmt = select(Article.status.distinct())
print(stmt)

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

SELECT DISTINCT articles.status
FROM articles

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

класс ColumnElement,
который представляет элемент SQL-выражения
метод label,
который задает псевдоним для выражения
метод asc,
который сортирует результат по возрастанию
метод desc,
который сортирует результат по убыванию