@stambha/vault-sql
v0.2.2
Published
SQL drivers for Stambha Vault — SQLite and PostgreSQL backends
Maintainers
Readme
@stambha/vault-sql
SQL drivers for Stambha Vault — SQLite (Node 22.5+ built-in) and PostgreSQL backends.
Part of the @stambha monorepo · GitHub
Install
npm install @stambha/vault-sql @stambha/vaultRequires Node.js 22.5+ (for node:sqlite).
Quick start
SQLite
import { Vault } from "@stambha/vault";
import { SQLiteDriver } from "@stambha/vault-sql";
import { GuildBlueprint } from "./schemas/GuildBlueprint.js";
const vault = new Vault({ driver: new SQLiteDriver({ path: "./data/vault.sqlite" }) });
vault.registerLedger("guild", { blueprint: GuildBlueprint });
await vault.init();PostgreSQL
import { PostgresDriver } from "@stambha/vault-sql";
const vault = new Vault({
driver: new PostgresDriver({
connectionString: process.env.DATABASE_URL!,
}),
});
vault.registerLedger("guild", { blueprint: GuildBlueprint });
await vault.init();Drivers create the vault table automatically on init().
Key exports
| Export | Purpose |
|--------|---------|
| SQLiteDriver | File-backed SQLite storage |
| PostgresDriver | PostgreSQL storage |
| VAULT_TABLE | Shared table name constant |
Related packages
| Package | Role |
|---------|------|
| @stambha/vault | Blueprints, Ledger, Record API |
| @stambha/core | Use settings in commands |
Development
pnpm --filter @stambha/vault-sql build
pnpm --filter @stambha/vault-sql test