Метод label

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

Синтаксис

column_element.label(name)

Пример

Давайте создадим псевдоним для простого выражения и выведем итоговый SQL-запрос:

from sqlalchemy import select, literal

stmt = select(literal('article').label('title'))
print(stmt)

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

SELECT :param_1 AS title

Пример

Давайте применим метод label к колонке модели:

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]

Теперь построим запрос с псевдонимом для колонки:

from sqlalchemy import select

stmt = select(Article.title.label('article_title'))
print(stmt)

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

SELECT articles.title AS article_title
FROM articles

Пример

Давайте создадим псевдоним для агрегатной функции и выполним запрос:

<+python+> from sqlalchemy import create_engine, select, func 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', text='text 1', status='active', num=1), Article(title='article', text='text 2', status='active', num=2), Article(title='article', text='text 3', status='archive', num=3), ]) session.commit() stmt = select( Article.status, func.count(Article.id).label('total'), ).group_by(Article.status) res = session.execute(stmt).all() print(res) <-python+>

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

[('active', 2), ('archive', 1)]

Пример

Давайте получим доступ к значению по имени псевдонима:

<+python+> from sqlalchemy import create_engine, select, func 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', text='text 1', status='active', num=1), Article(title='article', text='text 2', status='active', num=2), ]) session.commit() total = func.count(Article.id).label('total') stmt = select(total) res = session.execute(stmt).scalar_one() print(res) <-python+>

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

2

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

класс ColumnElement,
который представляет элемент SQL-выражения
метод cast,
который приводит выражение к заданному типу
метод concat,
который объединяет строковые значения
метод operate,
который применяет оператор к элементу