Debian Codegraph @

docs/examples/contrib/sqlalchemy/plugins/sqlalchemy_sync_init_plugin_example.py

raw
1 from __future__ import annotations
2
3 from typing import TYPE_CHECKING
4
5 from sqlalchemy import select
6 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
7
8 from litestar import Litestar, post
9 from litestar.di import NamedDependency
10 from litestar.plugins.sqlalchemy import SQLAlchemyInitPlugin, SQLAlchemySyncConfig
11
12 if TYPE_CHECKING:
13 from typing import Any, Dict, List
14
15 from sqlalchemy.orm import Session
16
17
18 class Base(DeclarativeBase): ...
19
20
21 class TodoItem(Base):
22 __tablename__ = "todo_item"
23 title: Mapped[str] = mapped_column(primary_key=True)
24 done: Mapped[bool]
25
26
27 @post("/", sync_to_thread=True)
28 def add_item(data: Dict[str, Any], db_session: NamedDependency[Session]) -> List[Dict[str, Any]]:
29 todo_item = TodoItem(**data)
30 with db_session.begin():
31 db_session.add(todo_item)
32 return [
33 {
34 "title": item.title,
35 "done": item.done,
36 }
37 for item in db_session.execute(select(TodoItem)).scalars()
38 ]
39
40
41 def init_db(app: Litestar) -> None:
42 with config.get_engine().begin() as conn:
43 Base.metadata.create_all(conn)
44
45
46 config = SQLAlchemySyncConfig(connection_string="sqlite:///todo_sync.sqlite")
47 plugin = SQLAlchemyInitPlugin(config=config)
48 app = Litestar(route_handlers=[add_item], plugins=[plugin], on_startup=[init_db])