chore: import upstream snapshot with attribution
Continuous Integration / Pre-commit Linter (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.10) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.11) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.12) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.12) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Has been cancelled
Copybara PR Handler / close-imported-pr (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / Pre-commit Linter (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.10) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.11) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.12) (push) Has been cancelled
Continuous Integration / Mypy Check (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.12) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / Unit Tests (Python 3.14) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.10) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.11) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.12) (push) Has been cancelled
Copybara PR Handler / close-imported-pr (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.13) (push) Has been cancelled
Continuous Integration / A2A v0.3 Tests (Python 3.14) (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,197 @@
|
||||
# Using PostgreSQL with DatabaseSessionService
|
||||
|
||||
This sample demonstrates how to configure `DatabaseSessionService` to use PostgreSQL for persisting sessions, events, and state.
|
||||
|
||||
## Overview
|
||||
|
||||
ADK's `DatabaseSessionService` supports multiple database backends through SQLAlchemy. This guide shows how to:
|
||||
|
||||
- Set up PostgreSQL as the session storage backend
|
||||
- Configure async connections with `asyncpg`
|
||||
- Understand the auto-generated schema
|
||||
- Run the sample agent with persistent sessions
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **PostgreSQL Database**: A running PostgreSQL instance (local or cloud)
|
||||
- **asyncpg**: Async PostgreSQL driver for Python
|
||||
|
||||
## Installation
|
||||
|
||||
Install the required Python packages:
|
||||
|
||||
```bash
|
||||
pip install google-adk asyncpg greenlet
|
||||
```
|
||||
|
||||
## Database Schema
|
||||
|
||||
`DatabaseSessionService` automatically creates the following tables on first use:
|
||||
|
||||
### sessions
|
||||
|
||||
| Column | Type | Description |
|
||||
| ----------- | ------------ | --------------------------- |
|
||||
| app_name | VARCHAR(128) | Application identifier (PK) |
|
||||
| user_id | VARCHAR(128) | User identifier (PK) |
|
||||
| id | VARCHAR(128) | Session UUID (PK) |
|
||||
| state | JSONB | Session state as JSON |
|
||||
| create_time | TIMESTAMP | Creation timestamp |
|
||||
| update_time | TIMESTAMP | Last update timestamp |
|
||||
|
||||
### events
|
||||
|
||||
| Column | Type | Description |
|
||||
| ------------- | ------------ | --------------------------- |
|
||||
| id | VARCHAR(256) | Event UUID (PK) |
|
||||
| app_name | VARCHAR(128) | Application identifier (PK) |
|
||||
| user_id | VARCHAR(128) | User identifier (PK) |
|
||||
| session_id | VARCHAR(128) | Session reference (PK, FK) |
|
||||
| invocation_id | VARCHAR(256) | Invocation identifier |
|
||||
| timestamp | TIMESTAMP | Event timestamp |
|
||||
| event_data | JSONB | Event content as JSON |
|
||||
|
||||
### app_states
|
||||
|
||||
| Column | Type | Description |
|
||||
| ----------- | ------------ | --------------------------- |
|
||||
| app_name | VARCHAR(128) | Application identifier (PK) |
|
||||
| state | JSONB | Application-level state |
|
||||
| update_time | TIMESTAMP | Last update timestamp |
|
||||
|
||||
### user_states
|
||||
|
||||
| Column | Type | Description |
|
||||
| ----------- | ------------ | --------------------------- |
|
||||
| app_name | VARCHAR(128) | Application identifier (PK) |
|
||||
| user_id | VARCHAR(128) | User identifier (PK) |
|
||||
| state | JSONB | User-level state |
|
||||
| update_time | TIMESTAMP | Last update timestamp |
|
||||
|
||||
### adk_internal_metadata
|
||||
|
||||
| Column | Type | Description |
|
||||
| ------ | ------------ | -------------- |
|
||||
| key | VARCHAR(128) | Metadata key |
|
||||
| value | VARCHAR(256) | Metadata value |
|
||||
|
||||
## Configuration
|
||||
|
||||
### Connection URL Format
|
||||
|
||||
```python
|
||||
postgresql+asyncpg://username:password@host:port/database
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```python
|
||||
from google.adk.sessions.database_session_service import DatabaseSessionService
|
||||
from google.adk.runners import Runner
|
||||
|
||||
# Initialize with PostgreSQL URL
|
||||
session_service = DatabaseSessionService(
|
||||
"postgresql+asyncpg://postgres:postgres@localhost:5432/adk_sessions"
|
||||
)
|
||||
|
||||
# Use with Runner
|
||||
runner = Runner(
|
||||
app_name="my_app",
|
||||
agent=my_agent,
|
||||
session_service=session_service,
|
||||
)
|
||||
```
|
||||
|
||||
### Advanced Configuration
|
||||
|
||||
Pass additional SQLAlchemy engine options:
|
||||
|
||||
```python
|
||||
session_service = DatabaseSessionService(
|
||||
"postgresql+asyncpg://postgres:postgres@localhost:5432/adk_sessions",
|
||||
pool_size=10,
|
||||
max_overflow=20,
|
||||
pool_timeout=30,
|
||||
pool_recycle=1800,
|
||||
)
|
||||
```
|
||||
|
||||
## Running the Sample
|
||||
|
||||
### 1. Start PostgreSQL
|
||||
|
||||
Using Docker:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Or use an existing PostgreSQL instance.
|
||||
|
||||
### 2. Configure Connection
|
||||
|
||||
Create a `.env` file:
|
||||
|
||||
```bash
|
||||
POSTGRES_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/adk_sessions
|
||||
GOOGLE_CLOUD_PROJECT=<your-gcp-project-id>
|
||||
GOOGLE_CLOUD_LOCATION=us-central1
|
||||
GOOGLE_GENAI_USE_ENTERPRISE=true
|
||||
```
|
||||
|
||||
Or run export command.
|
||||
|
||||
```bash
|
||||
export POSTGRES_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/adk_sessions
|
||||
export GOOGLE_CLOUD_PROJECT=$(gcloud config get-value project)
|
||||
export GOOGLE_CLOUD_LOCATION=us-central1
|
||||
export GOOGLE_GENAI_USE_ENTERPRISE=true
|
||||
```
|
||||
|
||||
### 3. Run the Agent
|
||||
|
||||
```bash
|
||||
python main.py
|
||||
```
|
||||
|
||||
Or use the ADK:
|
||||
|
||||
```bash
|
||||
adk run .
|
||||
```
|
||||
|
||||
## Session Persistence
|
||||
|
||||
Sessions and events are persisted across application restarts:
|
||||
|
||||
```python
|
||||
# First run - creates a new session
|
||||
session = await session_service.create_session(
|
||||
app_name="my_app",
|
||||
user_id="user1",
|
||||
session_id="persistent-session-123",
|
||||
)
|
||||
|
||||
# Later run - retrieves the existing session
|
||||
session = await session_service.get_session(
|
||||
app_name="my_app",
|
||||
user_id="user1",
|
||||
session_id="persistent-session-123",
|
||||
)
|
||||
```
|
||||
|
||||
## State Management
|
||||
|
||||
PostgreSQL's JSONB type provides efficient storage for state data:
|
||||
|
||||
- **Session state**: Stored in `sessions.state`
|
||||
- **User state**: Stored in `user_states.state`
|
||||
- **App state**: Stored in `app_states.state`
|
||||
|
||||
## Production Considerations
|
||||
|
||||
1. **Connection Pooling**: Use `pool_size` and `max_overflow` for high-traffic applications
|
||||
1. **SSL/TLS**: Always use encrypted connections in production
|
||||
1. **Backups**: Implement regular backup strategies for session data
|
||||
1. **Indexing**: The default schema includes primary key indexes; add additional indexes based on query patterns
|
||||
1. **Monitoring**: Monitor connection pool usage and query performance
|
||||
Reference in New Issue
Block a user