@dbml/cli 5.1.0 → 5.2.0

package/__tests__/dbml2sql/multiple_schema_oracle/out-files/multiple_schema.out.sql

@@ -0,0 +1,88 @@
+-- SQL dump generated using DBML (dbml.dbdiagram.io)
+-- Database: Oracle
+-- Generated at: 2025-11-17T14:37:44.428Z
+
+CREATE USER "C##test01"
+NO AUTHENTICATION
+DEFAULT TABLESPACE system
+TEMPORARY TABLESPACE temp
+QUOTA UNLIMITED ON system;
+
+CREATE USER "C##test02"
+NO AUTHENTICATION
+DEFAULT TABLESPACE system
+TEMPORARY TABLESPACE temp
+QUOTA UNLIMITED ON system;
+
+CREATE TABLE "users" (
+  "id" int PRIMARY KEY
+);
+
+CREATE TABLE "products" (
+  "id" int PRIMARY KEY,
+  "user_id" int NOT NULL
+);
+
+CREATE TABLE "C##test02"."users_products" (
+  "users_id" int,
+  "products_id" int,
+  PRIMARY KEY ("users_id", "products_id")
+);
+
+CREATE TABLE "users_products" (
+  "users_id" int,
+  "products_id" int,
+  PRIMARY KEY ("users_id", "products_id")
+);
+
+CREATE TABLE "C##test01"."users_products" (
+  "users_id" int,
+  "products_id" int,
+  PRIMARY KEY ("users_id", "products_id")
+);
+
+CREATE TABLE "C##test01"."users" (
+  "id" int PRIMARY KEY
+);
+
+CREATE TABLE "C##test01"."products" (
+  "id" int PRIMARY KEY,
+  "user_id" int NOT NULL
+);
+
+CREATE TABLE "C##test02"."users" (
+  "id" int PRIMARY KEY
+);
+
+CREATE TABLE "C##test02"."products" (
+  "id" int PRIMARY KEY,
+  "user_id" int NOT NULL
+);
+
+GRANT REFERENCES ON "C##test01"."users" TO PUBLIC;
+
+GRANT REFERENCES ON "users" TO PUBLIC;
+
+GRANT REFERENCES ON "C##test02"."users" TO PUBLIC;
+
+GRANT REFERENCES ON "products" TO PUBLIC;
+
+GRANT REFERENCES ON "C##test02"."products" TO PUBLIC;
+
+ALTER TABLE "products" ADD FOREIGN KEY ("user_id") REFERENCES "C##test01"."users" ("id");
+
+ALTER TABLE "C##test01"."products" ADD FOREIGN KEY ("user_id") REFERENCES "users" ("id");
+
+ALTER TABLE "C##test01"."products" ADD FOREIGN KEY ("user_id") REFERENCES "C##test01"."users" ("id");
+
+ALTER TABLE "C##test02"."users_products" ADD FOREIGN KEY ("users_id") REFERENCES "C##test02"."users" ("id");
+
+ALTER TABLE "C##test02"."users_products" ADD FOREIGN KEY ("products_id") REFERENCES "products" ("id");
+
+ALTER TABLE "users_products" ADD FOREIGN KEY ("users_id") REFERENCES "users" ("id");
+
+ALTER TABLE "users_products" ADD FOREIGN KEY ("products_id") REFERENCES "C##test02"."products" ("id");
+
+ALTER TABLE "C##test01"."users_products" ADD FOREIGN KEY ("users_id") REFERENCES "C##test01"."users" ("id");
+
+ALTER TABLE "C##test01"."users_products" ADD FOREIGN KEY ("products_id") REFERENCES "C##test02"."products" ("id");

package/__tests__/dbml2sql/multiple_schema_pg/out-files/multiple_schema.out.sql

@@ -0,0 +1,67 @@
+-- SQL dump generated using DBML (dbml.dbdiagram.io)
+-- Database: PostgreSQL
+-- Generated at: 2025-11-17T14:37:45.207Z
+
+CREATE SCHEMA "schemaB";
+
+CREATE SCHEMA "ecommerce";
+
+CREATE SCHEMA "schemaA";
+
+CREATE TYPE "job_status" AS ENUM (
+  'created2',
+  'running2',
+  'done2',
+  'failure2'
+);
+
+CREATE TYPE "gender" AS ENUM (
+  'male2',
+  'female2'
+);
+
+CREATE TYPE "schemaB"."gender" AS ENUM (
+  'male',
+  'female'
+);
+
+CREATE TABLE "users" (
+  "id" int PRIMARY KEY,
+  "name" varchar,
+  "pjs" job_status,
+  "pjs2" job_status,
+  "pg" "schemaB".gender,
+  "pg2" gender
+);
+
+CREATE TABLE "products" (
+  "id" int PRIMARY KEY,
+  "name" varchar
+);
+
+CREATE TABLE "ecommerce"."users" (
+  "id" int PRIMARY KEY,
+  "name" varchar,
+  "ejs" job_status,
+  "ejs2" job_status,
+  "eg" "schemaB".gender,
+  "eg2" gender
+);
+
+CREATE TABLE "schemaA"."products" (
+  "id" int PRIMARY KEY,
+  "name" varchar
+);
+
+CREATE TABLE "schemaA"."locations" (
+  "id" int PRIMARY KEY,
+  "name" varchar
+);
+
+ALTER TABLE "schemaA"."products" ADD FOREIGN KEY ("name") REFERENCES "ecommerce"."users" ("id");
+
+ALTER TABLE "schemaA"."locations" ADD FOREIGN KEY ("name") REFERENCES "users" ("id");
+
+ALTER TABLE "ecommerce"."users" ADD FOREIGN KEY ("id") REFERENCES "users" ("id");
+
+ALTER TABLE "ecommerce"."users" ADD CONSTRAINT "name_optional" FOREIGN KEY ("id") REFERENCES "users" ("name");

package/__tests__/dbml2sql/syntax-error/dbml-error.log

@@ -0,0 +1,9 @@
+2025-11-17T09:11:54.568Z
+undefined
+
+2025-11-17T09:51:53.546Z
+undefined
+
+2025-11-17T14:37:45.981Z
+undefined
+

package/{__test__ → __tests__}/dbml2sql_bin.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line
 require = require('esm')(module);
 const { dbml2sql } = require('../src');
 

package/__tests__/sql2dbml/custom-error-alter-table-column-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,6 @@
+CREATE TABLE Users (
+  id TEXT PRIMARY KEY
+);
+
+ALTER TABLE Users
+ADD CONSTRAINT unq UNIQUE (name);

package/__tests__/sql2dbml/custom-error-alter-table-column-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-alter-table-column-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 1 column 1. Column "name" do not exist in table "Users"
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-alter-table-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,2 @@
+ALTER TABLE Users
+ADD CONSTRAINT unq UNIQUE (id);

package/__tests__/sql2dbml/custom-error-alter-table-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-alter-table-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 1 column 13. Table "Users" not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-column-comment-column-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,6 @@
+CREATE TABLE Users (
+  id TEXT
+);
+
+COMMENT ON COLUMN Users.name IS 'fullname';
+

package/__tests__/sql2dbml/custom-error-column-comment-column-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-column-comment-column-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 19. Column "name" not found in table "Users"
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE Users (
+  id TEXT
+);
+
+COMMENT ON COLUMN Posts.title IS 'title';

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-column-comment-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 19. Table "Posts" not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1 @@
+CREATE UNIQUE INDEX idx ON Users(id);

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-create-index-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 1 column 28. Table Users not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/in-files/schema.sql

@@ -0,0 +1,5 @@
+CREATE TABLE Users (
+  id TEXT
+);
+
+COMMENT ON TABLE Posts IS 'id';

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/custom-error-table-comment-table-not-found --oracle/stdout.txt

@@ -0,0 +1,4 @@
+  ERROR: 
+    You have a syntax error at "schema.sql" line 5 column 18. Table "Posts" not found
+
+  A complete log can be found in:

package/__tests__/sql2dbml/filename --mssql --out-file/out-files/schema.dbml

@@ -0,0 +1,25 @@
+Table "UserMaster" {
+  "UserMasterKey" "BIGINT IDENTITY(1,1)" [not null]
+}
+
+Table "CodeDef" {
+  "CdKey" "BIGINT IDENTITY(1,1)" [not null]
+  "Category" NVARCHAR(50) [not null]
+  "Description" NVARCHAR(100)
+  "Code" NVARCHAR(50) [not null]
+  "ParentCdKey" BIGINT
+  "UserMasterKeyAddedBy" BIGINT [not null]
+  "UserMasterKeyLastEditedBy" BIGINT
+  "AddedDtTm" DATETIMEOFFSET(7) [not null]
+  "LastEditedDtTm" DATETIMEOFFSET(7)
+  "EffectiveFromDtTm" DATETIMEOFFSET(7) [not null]
+  "EffectiveThruDtTm" DATETIMEOFFSET(7)
+
+  Indexes {
+    CdKey [pk, name: "PK__CodeDef__4922449ECDD244C3"]
+  }
+}
+
+Ref "fk__CodeDef__ParentCdKey__CodeDef__CdKey":"CodeDef"."CdKey" < "CodeDef"."ParentCdKey"
+
+Ref "fk__CodeDef__UserMasterKeyLastEditedBy__UserMaster_UserMasterKey":"UserMaster"."UserMasterKey" < "CodeDef"."UserMasterKeyLastEditedBy"

package/__tests__/sql2dbml/filename --mysql --out-file/out-files/schema.dbml

@@ -0,0 +1,74 @@
+Enum "orders_status_enum" {
+  "created"
+  "running"
+  "done"
+  "failure"
+}
+
+Enum "products_status_enum" {
+  "Out of Stock"
+  "In Stock"
+}
+
+Table "orders" {
+  "id" int [pk, increment]
+  "user_id" int [unique, not null]
+  "status" orders_status_enum
+  "created_at" varchar(255)
+}
+
+Table "order_items" {
+  "order_id" int
+  "product_id" int
+  "quantity" int [default: 1]
+}
+
+Table "products" {
+  "id" int [pk]
+  "name" varchar(255)
+  "merchant_id" int [not null]
+  "price" int
+  "status" products_status_enum
+  "created_at" datetime [default: `now()`]
+
+  Indexes {
+    (merchant_id, status) [name: "product_status"]
+    id [type: hash, unique, name: "products_index_1"]
+  }
+}
+
+Table "users" {
+  "id" int [pk]
+  "full_name" varchar(255)
+  "email" varchar(255) [unique]
+  "gender" varchar(255)
+  "date_of_birth" varchar(255)
+  "created_at" varchar(255)
+  "country_code" int
+}
+
+Table "merchants" {
+  "id" int [pk]
+  "merchant_name" varchar(255)
+  "country_code" int
+  "created_at" varchar(255)
+  "admin_id" int
+}
+
+Table "countries" {
+  "code" int [pk]
+  "name" varchar(255)
+  "continent_name" varchar(255)
+}
+
+Ref:"orders"."id" < "order_items"."order_id"
+
+Ref:"products"."id" < "order_items"."product_id"
+
+Ref:"countries"."code" < "users"."country_code"
+
+Ref:"countries"."code" < "merchants"."country_code"
+
+Ref:"merchants"."id" < "products"."merchant_id"
+
+Ref:"users"."id" < "merchants"."admin_id"

package/__tests__/sql2dbml/filename --oracle --out-file/expect-out-files/schema.dbml

@@ -0,0 +1,83 @@
+Table "departments" {
+  "dept_id" NUMBER(10) [pk]
+  "dept_name" VARCHAR2(100)
+  "location_id" NUMBER(10)
+  "manager_id" NUMBER(10)
+}
+
+Table "locations" {
+  "location_id" NUMBER(10) [pk]
+  "city" VARCHAR2(100)
+  "country_code" CHAR(2)
+}
+
+Table "countries" {
+  "country_code" CHAR(2) [pk]
+  "country_name" VARCHAR2(100)
+}
+
+Table "employees" {
+  "emp_id" NUMBER(10) [pk]
+  "emp_name" VARCHAR2(100)
+  "department_id" NUMBER(10)
+  "manager_id" NUMBER(10)
+  "hire_date" DATE
+  "location_id" NUMBER(10)
+}
+
+Table "projects" {
+  "project_id" NUMBER(10) [pk]
+  "project_name" VARCHAR2(200)
+  "dept_id" NUMBER(10)
+  "lead_emp_id" NUMBER(10)
+  "backup_emp_id" NUMBER(10)
+}
+
+Table "assignments" {
+  "assignment_id" NUMBER(10) [pk]
+  "emp_id" NUMBER(10)
+  "project_id" NUMBER(10)
+  "start_date" DATE
+}
+
+Table "project_tasks" {
+  "project_id" NUMBER(10)
+  "task_id" NUMBER(10)
+  "task_name" VARCHAR2(200)
+  "assigned_emp_id" NUMBER(10)
+
+  Indexes {
+    (project_id, task_id) [pk]
+  }
+}
+
+Table "task_hours" {
+  "hour_id" NUMBER(10) [pk]
+  "project_id" NUMBER(10)
+  "task_id" NUMBER(10)
+  "hours_worked" NUMBER(5,2)
+}
+
+Ref "fk_emp_dept":"departments"."dept_id" < "employees"."department_id"
+
+Ref "fk_dept_location":"locations"."location_id" < "departments"."location_id"
+
+Ref "fk_loc_country":"countries"."country_code" < "locations"."country_code"
+
+Ref "fk_emp_manager":"employees"."emp_id" < "employees"."manager_id"
+
+Ref "fk_dept_manager":"employees"."emp_id" < "departments"."manager_id"
+
+Ref:"departments"."dept_id" < "projects"."dept_id"
+
+Ref:"employees"."emp_id" < "assignments"."emp_id"
+
+Ref:"projects"."project_id" < "assignments"."project_id"
+
+Ref "fk_task_hours_project_task":"project_tasks".("project_id", "task_id") < "task_hours".("project_id", "task_id")
+
+Ref "fk_proj_lead_emp":"employees"."emp_id" < "projects"."lead_emp_id"
+
+Ref "fk_proj_backup_emp":"employees"."emp_id" < "projects"."backup_emp_id"
+
+Ref "fk_task_assigned_emp":"employees"."emp_id" < "project_tasks"."assigned_emp_id"

package/__tests__/sql2dbml/filename --oracle --out-file/in-files/schema.sql

@@ -0,0 +1,147 @@
+-- Oracle SQL ALTER TABLE ADD FOREIGN KEY Constraint Test Cases
+-- Test setup: Create base tables with primary keys
+CREATE TABLE departments (
+    dept_id NUMBER(10) PRIMARY KEY,
+    dept_name VARCHAR2(100),
+    location_id NUMBER(10),
+    manager_id NUMBER(10)
+);
+
+CREATE TABLE locations (
+    location_id NUMBER(10) PRIMARY KEY,
+    city VARCHAR2(100),
+    country_code CHAR(2)
+);
+
+CREATE TABLE countries (
+    country_code CHAR(2) PRIMARY KEY,
+    country_name VARCHAR2(100)
+);
+
+CREATE TABLE employees (
+    emp_id NUMBER(10) PRIMARY KEY,
+    emp_name VARCHAR2(100),
+    department_id NUMBER(10),
+    manager_id NUMBER(10),
+    hire_date DATE,
+    location_id NUMBER(10)
+);
+
+CREATE TABLE projects (
+    project_id NUMBER(10) PRIMARY KEY,
+    project_name VARCHAR2(200),
+    dept_id NUMBER(10),
+    lead_emp_id NUMBER(10),
+    backup_emp_id NUMBER(10)
+);
+
+CREATE TABLE assignments (
+    assignment_id NUMBER(10) PRIMARY KEY,
+    emp_id NUMBER(10),
+    project_id NUMBER(10),
+    start_date DATE
+);
+
+-- Table with composite primary key
+CREATE TABLE project_tasks (
+    project_id NUMBER(10),
+    task_id NUMBER(10),
+    task_name VARCHAR2(200),
+    assigned_emp_id NUMBER(10),
+    PRIMARY KEY (project_id, task_id)
+);
+
+CREATE TABLE task_hours (
+    hour_id NUMBER(10) PRIMARY KEY,
+    project_id NUMBER(10),
+    task_id NUMBER(10),
+    hours_worked NUMBER(5,2)
+);
+
+-- ============================================
+-- NAMED FOREIGN KEY CONSTRAINTS - BASIC
+-- ============================================
+
+-- Simple single-column FK with constraint name
+ALTER TABLE employees 
+ADD CONSTRAINT fk_emp_dept 
+FOREIGN KEY (department_id) 
+REFERENCES departments(dept_id);
+
+-- Single-column FK referencing different table
+ALTER TABLE departments 
+ADD CONSTRAINT fk_dept_location 
+FOREIGN KEY (location_id) 
+REFERENCES locations(location_id);
+
+-- FK with explicit column name in referenced table
+ALTER TABLE locations 
+ADD CONSTRAINT fk_loc_country 
+FOREIGN KEY (country_code) 
+REFERENCES countries(country_code);
+
+-- Self-referencing FK (hierarchical)
+ALTER TABLE employees 
+ADD CONSTRAINT fk_emp_manager 
+FOREIGN KEY (manager_id) 
+REFERENCES employees(emp_id);
+
+-- Another self-referencing FK on different table
+ALTER TABLE departments 
+ADD CONSTRAINT fk_dept_manager 
+FOREIGN KEY (manager_id) 
+REFERENCES employees(emp_id);
+
+-- ============================================
+-- UNNAMED FOREIGN KEY CONSTRAINTS
+-- ============================================
+
+-- FK without explicit constraint name (Oracle auto-generates)
+ALTER TABLE projects 
+ADD FOREIGN KEY (dept_id) 
+REFERENCES departments(dept_id);
+
+-- Another unnamed FK
+ALTER TABLE assignments 
+ADD FOREIGN KEY (emp_id) 
+REFERENCES employees(emp_id);
+
+-- Unnamed FK with different columns
+ALTER TABLE assignments 
+ADD FOREIGN KEY (project_id) 
+REFERENCES projects(project_id);
+
+-- ============================================
+-- COMPOSITE FOREIGN KEYS (Multiple Columns)
+-- ============================================
+
+-- Two-column composite FK
+ALTER TABLE task_hours 
+ADD CONSTRAINT fk_task_hours_project_task 
+FOREIGN KEY (project_id, task_id) 
+REFERENCES project_tasks(project_id, task_id);
+
+-- ============================================
+-- FOREIGN KEYS WITH ON DELETE ACTIONS
+-- ============================================
+
+-- ON DELETE CASCADE - delete child records when parent is deleted
+ALTER TABLE projects 
+ADD CONSTRAINT fk_proj_lead_emp 
+FOREIGN KEY (lead_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE CASCADE;
+
+-- ON DELETE SET NULL - set FK to NULL when parent is deleted
+ALTER TABLE projects 
+ADD CONSTRAINT fk_proj_backup_emp 
+FOREIGN KEY (backup_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE SET NULL;
+
+-- ON DELETE CASCADE with named constraint
+ALTER TABLE project_tasks 
+ADD CONSTRAINT fk_task_assigned_emp 
+FOREIGN KEY (assigned_emp_id) 
+REFERENCES employees(emp_id) 
+ON DELETE CASCADE;

package/__tests__/sql2dbml/filename --oracle --out-file/options.json

@@ -0,0 +1,8 @@
+{
+  "args": [
+    "./in-files/schema.sql",
+    "--oracle",
+    "-o",
+    "./out-files/schema.dbml"
+  ]
+}

package/__tests__/sql2dbml/filename --oracle --out-file/stdout.txt

@@ -0,0 +1 @@
+  ✔ Generated DBML file from SQL file (Oracle): schema.dbml