Debian Codegraph @

docs/examples/onboarding/django/database_sqlalchemy.py

raw
1 from collections.abc import Sequence
2 from typing import Annotated
3
4 from sqlalchemy import select
5 from sqlalchemy.ext.asyncio import AsyncSession
6 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
7
8 from litestar import Litestar, get, post
9 from litestar.dto import DTOConfig
10 from litestar.plugins.sqlalchemy import (
11 AsyncSessionConfig,
12 SQLAlchemyAsyncConfig,
13 SQLAlchemyDTO,
14 SQLAlchemyPlugin,
15 )
16
17
18 class Base(DeclarativeBase):
19 pass
20
21
22 class Item(Base):
23 __tablename__ = "migration_items"
24 id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
25 name: Mapped[str]
26
27
28 WriteItemDTO = SQLAlchemyDTO[Annotated[Item, DTOConfig(exclude={"id"})]]
29 ReadItemDTO = SQLAlchemyDTO[Item]
30
31
32 @post("/items", dto=WriteItemDTO, return_dto=ReadItemDTO)
33 async def create_item(data: Item, db_session: AsyncSession) -> Item:
34 async with db_session.begin():
35 db_session.add(data)
36 return data
37
38
39 @get("/items", return_dto=ReadItemDTO)
40 async def list_items(db_session: AsyncSession) -> Sequence[Item]:
41 return (await db_session.execute(select(Item))).scalars().all()
42
43
44 config = SQLAlchemyAsyncConfig(
45 connection_string="sqlite+aiosqlite:///:memory:",
46 create_all=True,
47 metadata=Base.metadata,
48 session_config=AsyncSessionConfig(expire_on_commit=False),
49 )
50 app = Litestar(
51 route_handlers=[create_item, list_items],
52 plugins=[SQLAlchemyPlugin(config=config)],
53 )