Метод group_by класса Select
Метод group_by класса Select
добавляет в запрос секцию GROUP BY.
Метод принимает одну или несколько колонок, по
которым нужно сгруппировать строки. Обычно
используется вместе с агрегатными функциями,
такими как func.count, func.sum
и func.avg. Метод можно вызывать
несколько раз, а также передавать колонки
позиционно или через метод.
Синтаксис
select(...).group_by(column, ...)
Пример
Давайте сгруппируем статьи по статусу и посчитаем их количество. Сначала создадим таблицу и заполним её данными:
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 1', text='text 1', status='published', num=1),
Article(title='article 2', text='text 2', status='published', num=2),
Article(title='article 3', text='text 3', status='draft', num=3),
])
session.commit()
stmt = select(Article.status, func.count(Article.id)).group_by(Article.status)
res = session.execute(stmt).all()
print(res)
Результат выполнения кода:
[('draft', 1), ('published', 2)]
Итоговый SQL запрос:
SELECT articles.status, count(articles.id) AS count_1
FROM articles
GROUP BY articles.status
Пример
Давайте сгруппируем строки сразу по двум колонкам - статусу и числу:
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 1', text='text 1', status='published', num=1),
Article(title='article 2', text='text 2', status='published', num=1),
Article(title='article 3', text='text 3', status='draft', num=2),
])
session.commit()
stmt = select(
Article.status, Article.num, func.count(Article.id)
).group_by(Article.status, Article.num)
res = session.execute(stmt).all()
print(res)
Результат выполнения кода:
[('draft', 2, 1), ('published', 1, 2)]
Итоговый SQL запрос:
SELECT articles.status, articles.num, count(articles.id) AS count_1
FROM articles
GROUP BY articles.status, articles.num
Пример
Давайте отсортируем сгруппированные строки по
количеству статей с помощью метода order_by:
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 1', text='text 1', status='published', num=1),
Article(title='article 2', text='text 2', status='published', num=2),
Article(title='article 3', text='text 3', status='draft', num=3),
])
session.commit()
stmt = (
select(Article.status, func.count(Article.id).label('total'))
.group_by(Article.status)
.order_by(func.count(Article.id).desc())
)
res = session.execute(stmt).all()
print(res)
Результат выполнения кода:
[('published', 2), ('draft', 1)]
Итоговый SQL запрос:
SELECT articles.status, count(articles.id) AS total
FROM articles
GROUP BY articles.status
ORDER BY count(articles.id) DESC
