Метод offset
Метод offset класса Query задает
смещение в результирующей выборке. Первым
параметром метод принимает целое число -
количество строк, которые нужно пропустить
перед началом возврата результатов. Метод
возвращает новый объект Query, поэтому
его можно объединять в цепочку с другими
методами, например, с limit и
order_by.
Синтаксис
Query.offset(offset)
Пример
Давайте создадим модель и наполним таблицу
данными, а затем применим метод offset,
чтобы пропустить первые две строки:
from sqlalchemy import create_engine
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='draft', num=2),
Article(title='article 3', text='text 3', status='published', num=3),
Article(title='article 4', text='text 4', status='draft', num=4),
])
session.commit()
res = session.query(Article).order_by(Article.id).offset(2).all()
print([article.title for article in res])
Результат выполнения кода:
['article 3', 'article 4']
Пример
Давайте объединим метод offset с
методом limit, чтобы получить вторую
страницу выдачи по две строки:
from sqlalchemy import create_engine
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='draft', num=2),
Article(title='article 3', text='text 3', status='published', num=3),
Article(title='article 4', text='text 4', status='draft', num=4),
])
session.commit()
res = session.query(Article).order_by(Article.id).offset(2).limit(2).all()
print([article.title for article in res])
Результат выполнения кода:
['article 3', 'article 4']
Пример
Давайте посмотрим, какой SQL-запрос
генерирует метод offset:
from sqlalchemy import create_engine
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:
query = session.query(Article).order_by(Article.id).offset(2).limit(2)
print(query)
Итоговый SQL запрос:
SELECT articles.id AS articles_id, articles.title AS articles_title, articles.text AS articles_text, articles.status AS articles_status, articles.num AS articles_num
FROM articles ORDER BY articles.id
LIMIT 2 OFFSET 2
