Skip to content

Commit 71fbfa8

Browse files
committed
docs: add sql-storage-adapter as persistence layer in README
Added callout block after vector store table documenting @framers/sql-storage-adapter — 7 database adapters with auto-detection, powering SqlVectorStore and all SQL-backed storage.
1 parent c95afb1 commit 71fbfa8

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -606,6 +606,25 @@ graph TD
606606
| `QdrantVectorStore` | `@framers/agentos/rag` | Cloud-hosted vector database |
607607
| `Neo4jVectorStore` | `@framers/agentos/rag` | Neo4j 5.x native vector indexes with shared connection pooling |
608608

609+
> **Database Persistence: [`@framers/sql-storage-adapter`](https://github.com/framersai/sql-storage-adapter)**
610+
>
611+
> All SQL-backed storage in AgentOS — including `SqlVectorStore`, conversation persistence, and memory archival — is powered by the `@framers/sql-storage-adapter` package. It provides a unified interface across 7 database backends with automatic runtime detection:
612+
>
613+
> | Adapter | Runtime | Use Case |
614+
> |---------|---------|----------|
615+
> | `better-sqlite3` | Node.js | Production (default) |
616+
> | `pg` | Node.js | PostgreSQL for cloud deployments |
617+
> | `sql.js` | Browser/WASM | Client-side storage |
618+
> | `capacitor` | Mobile | iOS/Android via Capacitor |
619+
> | `electron` | Desktop | Electron apps with IPC bridge |
620+
> | `indexeddb` | Browser | Fallback browser storage |
621+
> | `memory` | Any | Testing and development |
622+
>
623+
> ```typescript
624+
> import { createDatabase } from '@framers/sql-storage-adapter';
625+
> const db = await createDatabase(); // auto-detects best adapter
626+
> ```
627+
609628
**GraphRAG:**
610629
611630
AgentOS supports both in-memory `GraphRAGEngine` and persistent `Neo4jGraphRAGEngine` (at `src/rag/graphrag/`) for knowledge-graph-enhanced retrieval:

0 commit comments

Comments
 (0)