Skip to content

docs: add Async tutorial and fix docstring async examples (#626) #1733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cscguochang wants to merge 1 commit into
base: main
Choose a base branch
from
+52 −4
Open

docs: add Async tutorial and fix docstring async examples (#626) #1733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/tutorial/async/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Async SQLModel

SQLModel supports asynchronous database operations out of the box using SQLAlchemy's async features and the `AsyncSession` provided by SQLModel.

## When to use Async

Asynchronous programming is particularly useful for Web APIs (like FastAPI) that handle many concurrent connections and spend much of their time waiting for the database to respond.

## Create the Async Engine

To use async, you need an async database driver (like `aiosqlite` for SQLite or `asyncpg` for PostgreSQL).

```python
from sqlalchemy.ext.asyncio import create_async_engine
from sqlmodel import SQLModel

sqlite_url = "sqlite+aiosqlite:///database.db"
engine = create_async_engine(sqlite_url, echo=True)

async def init_db():
async with engine.begin() as conn:
await conn.run_sync(SQLModel.metadata.create_all)
```

## Use AsyncSession

Use `from sqlmodel.ext.asyncio.session import AsyncSession` to perform async operations.

```python
from sqlmodel.ext.asyncio.session import AsyncSession
from sqlmodel import select

async def get_heroes():
async with AsyncSession(engine) as session:
statement = select(Hero)
results = await session.exec(statement)
return results.all()
```

## Integration with FastAPI

In FastAPI, you can use a dependency to provide an `AsyncSession`:

```python
async def get_session():
async with AsyncSession(engine) as session:
yield session
```
8 changes: 4 additions & 4 deletions sqlmodel/ext/asyncio/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,13 @@ async def exec(
For example:

```Python
heroes = await session.execute(select(Hero)).scalars().all()
heroes = (await session.execute(select(Hero))).scalars().all()
Copy link
Member

@YuriiMotov YuriiMotov Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have PR for this: #1643

```

instead you could use `exec()`:

```Python
heroes = await session.exec(select(Hero)).all()
heroes = (await session.exec(select(Hero))).all()
```
"""
)
Expand All @@ -145,13 +145,13 @@ async def execute(
For example:

```Python
heroes = await session.execute(select(Hero)).scalars().all()
heroes = (await session.execute(select(Hero))).scalars().all()
```

instead you could use `exec()`:

```Python
heroes = await session.exec(select(Hero)).all()
heroes = (await session.exec(select(Hero))).all()
```
"""
return await super().execute(
Expand Down
Loading