pearcord/pearcord-db
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(db): clarify HyperDB/Rocks primary engine path (P0-3)

Browse Source 
Document local Rocks engine role relative to HyperDB as the primary persistence path.

Co-authored-by: Cursor <[email protected]>
This commit is contained in:
Raven Scott
2026-06-01 22:25:41 -04:00
co-authored by Cursor
parent 21de0df9c6
commit b4b56f8dea
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -44,7 +44,7 @@ None. This module is local-only. Peers replicate via gossip into the same collec
| Engine | Path | When |
|--------|------|------|
| HyperDB | `{storagePath}/` (RocksDB files) | `hyperdb` installed and `spec/hyperdb/index.js` exists after `npm run build:schema` |
| HyperDB (Rocks) | `{storagePath}/` (RocksDB files via `HyperDB.rocks`) | `hyperdb` installed and `spec/hyperdb/index.js` exists after `npm run build:schema` — **primary engine (P0-3 complete)** |
| JSON | `{storagePath}/pearcord-db.json` | Fallback if HyperDB unavailable, or HyperDB empty while JSON already has users |
Platform default path: `{PEARCORD_STORAGE or ~/.config/pearcord}/db`.