marci-db

TypeScript client for MarciDB — a NoSQL database with a schema-first approach.

Installation

npm install marcidb-client
# or
bun add marcidb-client

Setup

1. Create a schema.marci file in your project root:

model User {
    name    String
    posts   Post[]  @bind(Post.author)
}

model Post {
    title   String
    author  User?
}

2. Generate the client:

marcidb generate
# or with custom paths
marcidb generate schema.marci node_modules/.marcidb/client

3. Start your MarciDB server and connect:

import { marcidb } from "marcidb-client";

const db = marcidb("http://localhost:3000");

Usage

import { marcidb } from "marcidb-client";

const db = marcidb("http://localhost:3000");

// Find
const users = await db.user.findMany({
  id: true,
  name: true,
});

// Insert
const id = await db.user.insert({
  name: "Alice",
});

// Update
await db.user.update({ id: 1 }, {
  name: "Bob",
});

// Delete
await db.user.delete({ id: 1 });

Requirements

• Node.js 18+ or Bun
• MarciDB server running

Re-generating types

After every change to schema.marci, re-run:

marcidb generate

If types don't update in VSCode, run TypeScript: Restart TS Server (Ctrl+Shift+P).