Skip to content

Repository navigation

docs: clarify database driver installation for SQLAlchemy sessions #4743

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

Merged
seratch merged 1 commit into from
Sep 7, 2026
Merged

docs: clarify database driver installation for SQLAlchemy sessions #4743

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
12 changes: 10 additions & 2 deletions docs/sessions/sqlalchemy_session.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@

## Installation

SQLAlchemy sessions require the `sqlalchemy` optional-dependency extra from the `openai-agents` package:
SQLAlchemy sessions require the `sqlalchemy` optional-dependency extra and an async database driver that matches your database URL.

For the SQLite examples below (`sqlite+aiosqlite://`), install `aiosqlite` alongside the extra:

```bash
pip install 'openai-agents[sqlalchemy]' aiosqlite
```

The extra already includes `asyncpg` for PostgreSQL URLs that start with `postgresql+asyncpg://`. For MySQL URLs that start with `mysql+aiomysql://`, install `aiomysql` alongside the extra. The driver's `rsa` extra supplies dependencies for MySQL's SHA-256 authentication methods:

```bash
pip install openai-agents[sqlalchemy]
pip install 'openai-agents[sqlalchemy]' 'aiomysql[rsa]'
Comment thread
seratch marked this conversation as resolved.
```

## Quick start
Expand Down