MongoDB Database

Use MongoDB for agent session storage and persistence.

Kern supports using MongoDB as a database with the MongoDb class.

Tip

v2 Migration Support: If you're upgrading from Kern v1, MongoDB is fully supported in the v2 migration script. See the migration guide for details.

Usage

1from kern.agent import Agent
2from kern.db.mongo import MongoDb
3
4# MongoDB connection settings
5db_url = "mongodb://localhost:27017"
6
7db = MongoDb(db_url=db_url)
8
9# Setup your Agent with the Database
10agent = Agent(db=db)

Run MongoDB

Install docker desktop and run MongoDB on port 27017 using:

1docker run -d \
2  --name local-mongo \
3  -p 27017:27017 \
4  -e MONGO_INITDB_ROOT_USERNAME=mongoadmin \
5  -e MONGO_INITDB_ROOT_PASSWORD=secret \
6  mongo

Params

Parameter	Type	Default	Description
`id`	`Optional[str]`	-	The ID of the database instance. UUID by default.
`db_client`	`Optional[MongoClient]`	-	The MongoDB client to use.
`db_name`	`Optional[str]`	-	The name of the database to use.
`db_url`	`Optional[str]`	-	The database URL to connect to.
`session_collection`	`Optional[str]`	-	Name of the collection to store sessions.
`memory_collection`	`Optional[str]`	-	Name of the collection to store memories.
`metrics_collection`	`Optional[str]`	-	Name of the collection to store metrics.
`eval_collection`	`Optional[str]`	-	Name of the collection to store evaluation runs.
`knowledge_collection`	`Optional[str]`	-	Name of the collection to store knowledge documents.
`traces_collection`	`Optional[str]`	-	Name of the collection to store traces.
`spans_collection`	`Optional[str]`	-	Name of the collection to store spans.