@picadeck/drizzle-parser

Drizzle ORM parser for Picadeck Schema Visualizer. Converts Drizzle schema objects into UniversalSchema for interactive visualization.

Installation

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

Peer dependency: drizzle-orm 0.30.x -- 0.38.x

Usage

import express from "express";
import { schemaVisualizer } from "@picadeck/core";
import { parseDrizzleSchema } from "@picadeck/drizzle-parser";
import * as schema from "./db/schema";

const app = express();

app.use(
  "/schema",
  schemaVisualizer({
    parser: () => parseDrizzleSchema(schema),
    models: [],
    theme: "dark",
  })
);

app.listen(3000);

API

parseDrizzleSchema(schema, database?)

Parses Drizzle table definitions into a UniversalSchema.

import { parseDrizzleSchema } from "@picadeck/drizzle-parser";
import * as schema from "./db/schema";

const result = parseDrizzleSchema(schema, "postgresql");

The schema parameter is the module object containing your Drizzle table definitions (e.g., pgTable, mysqlTable, sqliteTable).

The optional database parameter ('postgresql' | 'mysql' | 'sqlite') improves type normalization. If omitted, it is inferred from the table builder functions.

Supported Databases

• PostgreSQL (pgTable, pgEnum)
• MySQL (mysqlTable, mysqlEnum)
• SQLite (sqliteTable)

License

MIT