Метод add_columns

Метод add_columns класса Select добавляет одну или несколько колонок к списку уже выбранных колонок запроса. Метод принимает произвольное количество аргументов, каждый из которых может быть колонкой таблицы или выражением. В отличие от метода with_only_columns, который заменяет существующий список колонок, add_columns расширяет его.

Синтаксис

select_stmt.add_columns(*entities)

Пример

Давайте создадим модель и добавим колонку к запросу:

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

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

with Session(engine) as session:
	article = Article(title='article', text='text', status='new', num=1)
	session.add(article)
	session.commit()
	
	stmt = select(Article.id)
	stmt = stmt.add_columns(Article.title)
	res = session.execute(stmt).all()
	print(res)

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

[(1, 'article')]

Пример

Давайте добавим несколько колонок одновременно:

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

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

with Session(engine) as session:
	article = Article(title='article', text='text', status='new', num=1)
	session.add(article)
	session.commit()
	
	stmt = select(Article.id)
	stmt = stmt.add_columns(Article.title, Article.status)
	res = session.execute(stmt).all()
	print(res)

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

[(1, 'article', 'new')]

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

класс Select,
который представляет SELECT-запрос
метод with_only_columns,
который заменяет список выбираемых колонок
метод where,
который добавляет условие фильтрации
метод order_by,
который задает сортировку результатов