@picadeck/sql-parser

SQL DDL parser for Picadeck Schema Visualizer. Parses raw SQL CREATE TABLE statements into UniversalSchema for interactive visualization.

Installation

npm install @picadeck/sql-parser @picadeck/core

No peer dependencies -- uses node-sql-parser internally.

Usage

import express from "express";
import { schemaVisualizer } from "@picadeck/core";
import { parseSQLFile } from "@picadeck/sql-parser";

const app = express();

app.use(
  "/schema",
  schemaVisualizer({
    parser: () => parseSQLFile("./schema.sql", "postgresql"),
    models: [],
    theme: "light",
  })
);

app.listen(3000);

API

parseSQLToSchema(sql, dialect)

Parses a SQL DDL string into a UniversalSchema.

import { parseSQLToSchema } from "@picadeck/sql-parser";

const result = parseSQLToSchema(
  `CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL
  );`,
  "postgresql"
);

if (result.success) {
  console.log(result.schema);
} else {
  console.error(result.error);
}

parseSQLFile(filePath, dialect)

Reads a .sql file from disk and parses it.

import { parseSQLFile } from "@picadeck/sql-parser";

const result = await parseSQLFile("./migrations/schema.sql", "mysql");

Return Format

Both functions return { success: true, schema: UniversalSchema } on success or { success: false, error: string } on failure.

SQLDialect

Supported dialects: 'postgresql' | 'mysql'

License

MIT