Skip to content
Nizhal

Storage

Copy page 
import { postgresStorage, buildPostgresProvisionPlan } from "@nizhal/server/adapters";


const storage = postgresStorage({ connectionString: process.env.DATABASE_URL! });
await storage.provision({ schema, syncRules });

StorageAdapter interface

Section titled “StorageAdapter interface”
  • getChanges — cursor pull with bucket scope, tombstones, removedBuckets
  • transaction — atomic mutator execution
  • claimMutation / recordApplied — idempotent push + client-id reconciliation
  • provision — DDL from schema + sync rules

buildPostgresProvisionPlan returns raw SQL statements for inspection or CI diffing.

What provision creates

Section titled “What provision creates”
  • updated_at / deleted_at on synced tables
  • _nizhal_sync_control loop-gate + per-table change log
  • _nizhal_mutations — idempotency + client→server ID map
  • _nizhal_tombstones — delete propagation
  • _nizhal_client_buckets — scope tracking
  • Indexes for cursor scans

No logical replication. Runs on managed Postgres (Neon, RDS, Supabase) without superuser WAL settings.

CLI

Section titled “CLI”
Terminal window
nizhal migrate --config nizhal.config.js

See CLI reference.

Custom adapters

Section titled “Custom adapters”

StorageAdapter is the seam for alternate backends (D1/SQLite backlog). Phase 0 ships Postgres only; the interface exists so a second backend is a new adapter, not a rewrite.