skemabase-js

skemabase-js

JavaScript SDK for parsing plain-English database schemas into a JSON intermediate representation (IR), generating SQL DDL, and creating Mermaid ER diagrams.

Installation

npm install skemabase-js

Usage

import { parse, generateSQL, generateMermaidDiagram } from 'skemabase-js';

const schema = `
  User has attributes: username unique, email unique, created_at:timestamp default now()
  User has many Post
  Post has attributes: title not null, body, created_at:timestamp default now()
`;

const ir = parse(schema);
const sql = generateSQL(ir, { dialect: 'postgresql' });
console.log(sql);

const diagram = generateMermaidDiagram(ir);
console.log(diagram);

API

• parse(text: string): Array
• generateSQL(ir: Array, options?: { dialect: 'postgresql' | 'sqlite' }): string
• generateMermaidDiagram(ir: Array): string

  Documentation

  See the SkemaBase CLI Reference for command-line usage, and the root README for full project documentation.

  License

  MIT