Expand description
Metadata database abstraction.
Modules§
- entities
- migrator
- ops
- pipelines
- sync
sync_operationsrepository surface.- uuid_
hex - UUID ↔ 32-char hex string conversions.
Structs§
- Cost
ByModel Row - Single per-model row for
GET /api/v1/sessions/cost-by-model. Parity with the Python response items atcognee/api/v1/sessions/routers/get_sessions_router.py:241-251. - Dataset
Configuration - Dataset
Configuration Patch - Graph
Edge - Graph
Metrics - Graph
Node - Noop
Pipeline RunRepository PipelineRunRepositorythat ignores all writes and returns empty results for reads.- Notebook
- A single row from the
notebookstable. - Notebook
Update Patch - Fields that can be updated in a
PUT /{notebook_id}call. - Pipeline
Run - Pipeline
RunWith Attribution Row - Row returned by
PipelineRunRepository::list_recent_with_attribution. - SeaOrm
Checkpoint Store - SeaORM-backed implementation of
CheckpointStorethat writes to thegraph_sync_checkpointstable. - SeaOrm
Pipeline RunRepository - SeaORM-backed implementation of
PipelineRunRepository. - SeaOrm
Sync Operation Repository - SeaORM impl of
SyncOperationRepository. Cheap to clone (interiorArc). - Search
History Entry - Session
List Filters - Filters for
SessionLifecycleDb::list_session_rows. Field-for-field parity with Python’slist_session_rowskeyword arguments atcognee/modules/session_lifecycle/metrics.py:365-374. - Session
List Page - Paginated envelope returned by
list_session_rows. Parity with Python’sSessionListPagedataclass atmetrics.py:351-362. - Session
RowWith Status - Wraps a stored
session_recordsrow plus the read-time effective status (abandonedfor stale running rows). Mirrors Python’sSessionRowWithStatusdataclass atcognee/modules/session_lifecycle/metrics.py:336-348. - Session
Stats - Aggregate counters for
GET /api/v1/sessions/stats. Field-for-field parity with the Python response body atcognee/api/v1/sessions/routers/get_sessions_router.py:179-196. - Sync
Operation Row - Snapshot of one
sync_operationsrow (every column). - TaskRun
Enums§
- Database
Connection - Handle a database connection depending on the backend enabled by the feature
flags. This creates a database pool. This will be
Cloneunless the feature flagmockis enabled. - Database
Error - Pipeline
RunStatus - Search
History Entry Type - Sync
Operation Status - Status enum used by the repository surface. String values match Python’s JSON column verbatim.
Constants§
- TUTORIAL_
BASICS_ ID - UUID5(NAMESPACE_OID, “Cognee Basics - tutorial 🧠”)
- TUTORIAL_
PYTHON_ DEV_ ID - UUID5(NAMESPACE_OID, “Python Development with Cognee - tutorial 🧠”)
Traits§
- AclDb
- Access control list database trait.
- Checkpoint
Store - Abstraction over persistent timestamp checkpoints keyed by string.
- Dataset
Config Db - Delete
Db - Ingest
Db - Notebook
Db - CRUD operations for the
notebookstable. - Pipeline
RunRepository - Persistence abstraction for pipeline run status rows.
- Search
History Db - Session
Lifecycle Db - Repository trait for
/api/v1/sessions/*. See module docs. - Sync
Operation Repository - Persistence trait for the cloud sync router.
Functions§
- connect
- Open a connection to the relational database.
- database_
system_ label - Map the active SeaORM backend to a
cognee.db.systemstring matching the values used by the vector / graph adapters. - initialize
- Run all pending migrations on an existing connection.
- seed_
tutorials_ if_ first_ call - Seed the two tutorial notebooks for
user_idif not already present.