SurrealDB

SurrealDb stores Agent, Team, and Workflow sessions, memories, knowledge, evaluations, and traces in SurrealDB. See the SurrealDB documentation for server and connection setup.

Usage

Install the surrealdb and openai packages:

uv pip install surrealdb openai

Run SurrealDB

Install Docker Desktop, then start SurrealDB on port 8000:

docker run --rm --pull always -p 8000:8000 surrealdb/surrealdb:latest start --user root --pass root

surrealdb_for_agent.py

from agno.agent import Agent
from agno.db.surrealdb import SurrealDb

SURREALDB_URL = "ws://localhost:8000"
SURREALDB_USER = "root"
SURREALDB_PASSWORD = "root"
SURREALDB_NAMESPACE = "agno"
SURREALDB_DATABASE = "surrealdb_for_agent"

credentials = {"username": SURREALDB_USER, "password": SURREALDB_PASSWORD}
db = SurrealDb(
    client=None,
    db_url=SURREALDB_URL,
    db_creds=credentials,
    db_ns=SURREALDB_NAMESPACE,
    db_db=SURREALDB_DATABASE,
)

agent = Agent(db=db)

Parameters

Parameter	Type	Default	Description
`id`	`Optional[str]`	-	The ID of the database instance. UUID by default.
`client`	`Optional[Union[BlockingWsSurrealConnection, BlockingHttpSurrealConnection]]`	-	A blocking connection, either HTTP or WebSocket.
`db_url`	`str`	-	The SurrealDB connection URL.
`db_creds`	`dict[str, str]`	-	Database credentials dictionary (username, password).
`db_ns`	`str`	-	The SurrealDB namespace to use.
`db_db`	`str`	-	The SurrealDB database name 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 user 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 documents data.
`culture_table`	`Optional[str]`	-	Name of the table to store cultural knowledge data.
`traces_table`	`Optional[str]`	-	Name of the table to store traces.
`spans_table`	`Optional[str]`	-	Name of the table to store spans.

Get Started

Basics

Advanced

Production

Providers

Other

Additional Resources

Usage

Run SurrealDB

Parameters

​Usage

​Run SurrealDB

​Parameters

Usage

Run SurrealDB

Parameters