Skip to content

📝 Fix async example in session.execute() docstring & deprecation message #1643

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

📝 Fix async example in session.execute() docstring & deprecation message #1643

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dccd01b
Fix async example in session.execute() deprecation warning & docstring
DanielLeviLucas Nov 11, 2025
ca5138d
Merge branch 'main' into fix/async-example-in-execute
DanielLeviLucas Nov 11, 2025
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
12 changes: 8 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 @@ -119,13 +119,15 @@ async def exec(
For example:

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

instead you could use `exec()`:

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

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

instead you could use `exec()`:

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