@backwrite/sdk

Official TypeScript/JavaScript client SDK for Backwrite — the programmable distributed backend platform.

Installation

npm install @backwrite/sdk

Quickstart

import { createClient } from "@backwrite/sdk";

// Initialize client with project and branch context
const bw = createClient({
  url: "https://api.backwrite.dev",
  apiKey: process.env.BACKWRITE_SERVICE_KEY!,
  projectId: "bw_proj_01a0eeb720837282bb8ee7835fb9d669",
  branchId: "br_01a0eeb720d473428f7e4733bd999964",
});

// 1. Execute type-safe SQL query with 1ms execution
const { rows } = await bw.query<{ id: string; name: string }>(
  "SELECT id, name FROM users WHERE status = $1 LIMIT 10",
  ["active"]
);

// 2. Query an isolated preview branch
const preview = bw.branch("preview-feat-payments");
await preview.query("INSERT INTO orders (user_id, amount) VALUES ($1, $2)", [rows[0].id, 49.99]);

// 3. Vector Similarity Search
const matches = await bw.vector.search("embeddings_table", [0.024, -0.421, 0.812], {
  topK: 5,
  metric: "cosine",
});

Features

• Branch-Aware Routing: Target production, development, or ephemeral branches seamlessly.
• Transactional Migrations: Apply DDL migrations safely with automated rollback guarantees.
• NATS JetStream CDC: Low-latency change data capture streaming directly from Postgres WAL.
• Vector Embeddings: Native pgvector similarity search with cosine and Euclidean distance metrics.
• Row Level Security: Built-in auth tokens and session handling.

License

Apache-2.0 © Backwrite