vcdb

Node.js client + CLI for Velocity Database.

• Website: https://velocitydb.org
• GitHub Organization: https://github.com/velocitydb-org

Features

• vcdb init creates install files for your project.
• vcdb generate reads schema.vcdb and generates velocity/modals/*.json.
• JSON-based models: {"name":"string"} format.
• Prisma-style delegates: create, findMany, findUnique, update, delete, upsert.
• Coded error system (VCDB_E_*) with actionable hints.

Install

npm i vcdb

Project Links

• Official Site: https://velocitydb.org
• GitHub Org: https://github.com/velocitydb-org

CLI

vcdb init
vcdb generate
vcdb validate

Generated structure:

velocity/
  schema.vcdb
  vcdb.config.json
  modals/
    User.json

Schema (Prisma-like)

datasource db {
  provider = "velocity"
  host = "127.0.0.1"
  port = 2005
  username = "admin"
  password = "admin1234"
}

model User {
  id String @id
  name String
  email String
  createdAt DateTime
}

Client Usage

import { createClient } from "vcdb";

const db = createClient({
  host: "127.0.0.1",
  port: 2005,
  username: "admin",
  password: "admin1234",
  modelsDir: "./velocity/modals"
});

await db.$connect();

const user = await db.user.create({
  data: { name: "Mert", email: "[email protected]", createdAt: new Date().toISOString() }
});

const list = await db.user.findMany({ where: { name: "Mert" }, limit: 50 });

await db.$disconnect();

Error Codes

Examples:

• VCDB_E_CONFIG_INVALID
• VCDB_E_CONNECTION_FAILED
• VCDB_E_AUTH_FAILED
• VCDB_E_QUERY_FAILED
• VCDB_E_MODEL_NOT_FOUND
• VCDB_E_SCHEMA_PARSE
• VCDB_E_VALIDATION_FAILED

Each thrown VCDBError contains:

• code
• message
• hint
• details