PostgresDb class.
You can get started with Neon following their Get Started guide.
You can also read more about the PostgresDb class in its section.
Usage
Install thesqlalchemy, psycopg, and openai packages:
uv pip install sqlalchemy psycopg openai
neon_for_agent.py
from agno.agent import Agent
from agno.db.postgres import PostgresDb
from os import getenv
# Get your Neon database URL, using the postgresql+psycopg:// scheme
NEON_DB_URL = getenv("NEON_DB_URL")
# Setup the Neon database
db = PostgresDb(db_url=NEON_DB_URL)
# Setup your Agent with the Database
agent = Agent(db=db)
Params
| Parameter | Type | Default | Description |
|---|---|---|---|
id | Optional[str] | - | The ID of the database instance. UUID by default. |
db_url | Optional[str] | - | The database URL to connect to. |
db_engine | Optional[Engine] | - | The SQLAlchemy database engine to use. |
db_schema | Optional[str] | - | The database schema to use. |
session_table | Optional[str] | - | Name of the table to store Agent, Team and Workflow sessions. |
memory_table | Optional[str] | - | Name of the table to store memories. |
metrics_table | Optional[str] | - | Name of the table to store metrics. |
eval_table | Optional[str] | - | Name of the table to store evaluation runs data. |
knowledge_table | Optional[str] | - | Name of the table to store knowledge content. |
culture_table | Optional[str] | - | Name of the table to store cultural knowledge. |
traces_table | Optional[str] | - | Name of the table to store traces. |
spans_table | Optional[str] | - | Name of the table to store spans. |
versions_table | Optional[str] | - | Name of the table to store schema versions. |
components_table | Optional[str] | - | Name of the table to store components. |
component_configs_table | Optional[str] | - | Name of the table to store component configurations. |
component_links_table | Optional[str] | - | Name of the table to store links between components. |
learnings_table | Optional[str] | - | Name of the table to store learnings. |
schedules_table | Optional[str] | - | Name of the table to store cron schedules. |
schedule_runs_table | Optional[str] | - | Name of the table to store schedule run history. |
approvals_table | Optional[str] | - | Name of the table to store human approval requests. |
auth_tokens_table | Optional[str] | - | Name of the table to store OAuth tokens for external services. |
service_accounts_table | Optional[str] | - | Name of the table to store service accounts. |
mcp_oauth_clients_table | Optional[str] | - | Name of the table to store MCP OAuth client registrations. |
mcp_oauth_transactions_table | Optional[str] | - | Name of the table to store MCP OAuth transactions. |
mcp_oauth_codes_table | Optional[str] | - | Name of the table to store MCP OAuth authorization codes. |
mcp_oauth_refresh_tokens_table | Optional[str] | - | Name of the table to store MCP OAuth refresh tokens. |
mcp_oauth_keys_table | Optional[str] | - | Name of the table to store MCP OAuth signing keys. |
create_schema | bool | True | Whether to create the database schema if it doesn't exist. Set to False when the schema is managed externally. |