@dbml/cli 5.1.0 → 5.3.0

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/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/stdout.txt

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

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

@@ -0,0 +1,74 @@
+Enum "orders_status" {
+  "created"
+  "running"
+  "done"
+  "failure"
+}
+
+Enum "product status" {
+  "Out of Stock"
+  "In Stock"
+}
+
+Table "orders" {
+  "id" SERIAL [pk, increment]
+  "user_id" int [unique, not null]
+  "status" orders_status
+  "created_at" varchar
+}
+
+Table "order_items" {
+  "order_id" int
+  "product_id" int
+  "quantity" int [default: 1]
+}
+
+Table "products" {
+  "id" int [pk]
+  "name" varchar
+  "merchant_id" int [not null]
+  "price" int
+  "status" "product status"
+  "created_at" datetime [default: `now()`]
+
+  Indexes {
+    (merchant_id, status) [name: "product_status"]
+    id [type: hash, unique]
+  }
+}
+
+Table "users" {
+  "id" int [pk]
+  "full_name" varchar
+  "email" varchar [unique]
+  "gender" varchar
+  "date_of_birth" varchar
+  "created_at" varchar
+  "country_code" int
+}
+
+Table "merchants" {
+  "id" int [pk]
+  "merchant_name" varchar
+  "country_code" int
+  "created_at" varchar
+  "admin_id" int
+}
+
+Table "countries" {
+  "code" int [pk]
+  "name" varchar
+  "continent_name" varchar
+}
+
+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 --postgres --out-file/out-files/schema.dbml

@@ -0,0 +1,74 @@
+Enum "orders_status" {
+  "created"
+  "running"
+  "done"
+  "failure"
+}
+
+Enum "product status" {
+  "Out of Stock"
+  "In Stock"
+}
+
+Table "orders" {
+  "id" SERIAL [pk, increment]
+  "user_id" int [unique, not null]
+  "status" orders_status
+  "created_at" varchar
+}
+
+Table "order_items" {
+  "order_id" int
+  "product_id" int
+  "quantity" int [default: 1]
+}
+
+Table "products" {
+  "id" int [pk]
+  "name" varchar
+  "merchant_id" int [not null]
+  "price" int
+  "status" "product status"
+  "created_at" datetime [default: `now()`]
+
+  Indexes {
+    (merchant_id, status) [name: "product_status"]
+    id [type: hash, unique]
+  }
+}
+
+Table "users" {
+  "id" int [pk]
+  "full_name" varchar
+  "email" varchar [unique]
+  "gender" varchar
+  "date_of_birth" varchar
+  "created_at" varchar
+  "country_code" int
+}
+
+Table "merchants" {
+  "id" int [pk]
+  "merchant_name" varchar
+  "country_code" int
+  "created_at" varchar
+  "admin_id" int
+}
+
+Table "countries" {
+  "code" int [pk]
+  "name" varchar
+  "continent_name" varchar
+}
+
+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/filenames --mysql --out-file/out-files/schema.dbml

@@ -0,0 +1,170 @@
+Table "staff" {
+  "id" int [pk]
+  "first_name" varchar(255)
+  "last_name" varchar(255)
+  "address_id" int
+  "picture" blob
+  "email" varchar(255)
+  "store_id" int
+  "active" boolean
+  "user_name" varchar(255)
+  "password" varchar(255)
+  "last_update" timestamp
+}
+
+Table "store" {
+  "id" int [pk]
+  "manager_staff_id" int
+  "address_id" int
+  "last_update" timestamp
+}
+
+Table "payment" {
+  "id" int [pk]
+  "customer_id" int
+  "staff_id" int
+  "rental_id" int
+  "amount" decimal
+  "payment_date" datetime
+  "last_update" timestamp
+}
+
+Table "rental" {
+  "id" int [pk]
+  "rental_date" datetime
+  "inventory_id" int
+  "customer_id" int
+  "return_date" datetime
+  "staff_id" int
+  "last_update" timestamp
+}
+
+Ref:"store"."id" < "staff"."store_id"
+
+Ref:"staff"."id" < "store"."manager_staff_id"
+
+Ref:"staff"."id" < "payment"."staff_id"
+
+Ref:"rental"."id" < "payment"."rental_id"
+
+Ref:"staff"."id" < "rental"."staff_id"
+Table "country" {
+  "id" int [pk]
+  "country" varchar(255)
+  "last_update" timestamp
+}
+
+Table "city" {
+  "id" int [pk]
+  "city" varchar(255)
+  "country_id" int
+  "last_update" timestamp
+}
+
+Table "address" {
+  "id" int [pk]
+  "address" varchar(255)
+  "address2" varchar(255)
+  "district" varchar(255)
+  "city_id" int
+  "postal_code" varchar(255)
+  "phone" varchar(255)
+  "last_update" timestamp
+}
+
+Table "customer" {
+  "id" int [pk]
+  "store_id" int
+  "first_name" varchar(255)
+  "last_name" varchar(255)
+  "email" varchar(255)
+  "address_id" int
+  "active" boolean
+  "create_Date" timestamp
+  "last_update" timestamp
+
+  Indexes {
+    (id, first_name) [type: btree, name: "customer_index_0"]
+  }
+}
+
+Ref:"country"."id" < "city"."country_id"
+
+Ref:"city"."id" < "address"."city_id"
+
+Ref:"address"."id" < "customer"."address_id"
+Table "category" {
+  "id" int [pk]
+  "name" varchar(255)
+  "last_update" timestamp
+}
+
+Table "film_category" {
+  "id" int [pk]
+  "category_id" int
+  "last_update" timestamp
+}
+
+Table "language" {
+  "id" int [pk]
+  "name" varchar(255)
+  "last_update" timestamp
+}
+
+Table "film_text" {
+  "id" int [pk]
+  "film_id" int
+  "title" varchar(255)
+  "description" text
+}
+
+Table "actor" {
+  "id" int [pk]
+  "first_name" varchar(255)
+  "last_name" varchar(255)
+  "last_update" timestamp
+}
+
+Table "film" {
+  "id" int [pk]
+  "title" varchar(255)
+  "description" text
+  "releaase_year" int
+  "language_id" int
+  "original_language_id" int
+  "rental_duration" int
+  "rental_rate" decimal
+  "length" int
+  "replacement_cost" decimal
+  "rating" varchar(255)
+  "special_feature" varchar(255)
+  "last_update" timestamp
+}
+
+Table "film_actor" {
+  "id" int [pk]
+  "film_id" int
+  "actor_id" int
+  "last_update" timestamp
+}
+
+Table "inventory" {
+  "id" int [pk]
+  "film_id" int
+  "store_id" int
+  "last_update" timestamp
+}
+
+Ref:"category"."id" < "film_category"."category_id"
+
+Ref:"inventory"."film_id" < "film_text"."film_id"
+
+Ref:"language"."id" < "film"."language_id"
+
+Ref:"language"."id" < "film"."original_language_id"
+
+Ref:"film"."id" < "film_actor"."film_id"
+
+Ref:"actor"."id" < "film_actor"."actor_id"
+
+Ref:"film"."id" < "inventory"."film_id"