Does it work with Textual Statements

[sombathoudom]

Does it work with Textual Statements?

Ex:
stmt = text("select * from users")
 return paginate(db, stmt)

[uriyyo]

Hi @sombathoudom,

Yes, here is an example:

from faker import Faker
from pydantic import BaseModel
from sqlalchemy import create_engine, text
from sqlalchemy.orm import DeclarativeBase, Mapped, MappedAsDataclass, Session, mapped_column

from fastapi_pagination import Page, set_page, set_params, Params
from fastapi_pagination.ext.sqlalchemy import paginate

faker = Faker()

engine = create_engine("sqlite:///:memory:")


class Base(MappedAsDataclass, DeclarativeBase):
    pass


class User(Base):
    __tablename__ = "users"

    name: Mapped[str]
    email: Mapped[str]

    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True, default=None)


class UserSchema(BaseModel):
    id: int
    name: str
    email: str


Base.metadata.create_all(bind=engine)

session = Session(engine)

with session.begin():
    session.add_all([User(name=faker.name(), email=faker.email()) for _ in range(100)])

set_page(Page[UserSchema])
set_params(Params(size=5, page=2))

with session.begin():
    page = paginate(session, text("SELECT * FROM users"))

print(page.model_dump_json(indent=2))

{
  "items": [
    {
      "id": 6,
      "name": "Mark Snyder",
      "email": "[email protected]"
    },
    {
      "id": 7,
      "name": "Scott Moreno",
      "email": "[email protected]"
    },
    {
      "id": 8,
      "name": "Melissa Parker",
      "email": "[email protected]"
    },
    {
      "id": 9,
      "name": "David Walker",
      "email": "[email protected]"
    },
    {
      "id": 10,
      "name": "Timothy Patton",
      "email": "[email protected]"
    }
  ],
  "total": 100,
  "page": 2,
  "size": 5,
  "pages": 20
}