@dbml/cli 3.6.1 → 3.7.0

package/__test__/db2dbml/postgres/schema.sql

@@ -0,0 +1,156 @@
+-- Create users table
+CREATE TABLE users (
+  user_id SERIAL PRIMARY KEY,
+  username VARCHAR(50) UNIQUE NOT NULL,
+  email VARCHAR(100) UNIQUE NOT NULL,
+  password_hash VARCHAR(255) NOT NULL,
+  first_name VARCHAR(50),
+  last_name VARCHAR(50),
+  full_name VARCHAR(100),
+  date_of_birth DATE,
+  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+  last_login TIMESTAMP WITH TIME ZONE,
+  is_active BOOLEAN DEFAULT TRUE,
+  CONSTRAINT chk_email_format CHECK (email ~* '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$'),
+  CONSTRAINT chk_age CHECK (date_of_birth <= CURRENT_DATE - INTERVAL '13 years')
+);
+
+-- Create an index on the email column for faster lookups
+CREATE INDEX idx_users_email ON users (email);
+
+CREATE UNIQUE INDEX ON "users" ("user_id");
+
+CREATE INDEX "User Name" ON "users" ("full_name");
+
+CREATE INDEX ON "users" ("is_active", ((lower(full_name))));
+
+-- Create products table
+CREATE TABLE products (
+  product_id SERIAL PRIMARY KEY,
+  name VARCHAR(100) NOT NULL,
+  description TEXT,
+  price DECIMAL(10, 2) NOT NULL,
+  stock_quantity INTEGER NOT NULL DEFAULT 0,
+  category VARCHAR(50),
+  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+  is_available BOOLEAN DEFAULT TRUE,
+  CONSTRAINT chk_price_positive CHECK (price > 0),
+  CONSTRAINT chk_stock_non_negative CHECK (stock_quantity >= 0)
+);
+
+-- Create an index on the category column for faster filtering
+CREATE INDEX idx_products_category ON products (category);
+
+-- Create orders table
+CREATE TABLE orders (
+  order_id SERIAL PRIMARY KEY,
+  user_id INTEGER NOT NULL,
+  order_date TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+  total_amount DECIMAL(12, 2) NOT NULL,
+  status VARCHAR(20) DEFAULT 'pending',
+  shipping_address TEXT NOT NULL,
+  billing_address TEXT NOT NULL,
+  CONSTRAINT fk_user FOREIGN KEY (user_id) REFERENCES users(user_id) ON DELETE CASCADE,
+  CONSTRAINT chk_total_amount_positive CHECK (total_amount > 0),
+  CONSTRAINT chk_status CHECK (status IN ('pending', 'processing', 'shipped', 'delivered', 'cancelled'))
+);
+
+-- Create an index on the user_id and order_date columns for faster querying
+CREATE INDEX idx_orders_user_date ON orders (user_id, order_date);
+
+-- Create order_items table
+CREATE TABLE order_items (
+  order_item_id SERIAL PRIMARY KEY,
+  order_id INTEGER NOT NULL,
+  product_id INTEGER NOT NULL,
+  quantity INTEGER NOT NULL,
+  unit_price DECIMAL(10, 2) NOT NULL,
+  CONSTRAINT fk_order FOREIGN KEY (order_id) REFERENCES orders(order_id) ON DELETE CASCADE,
+  CONSTRAINT fk_product FOREIGN KEY (product_id) REFERENCES products(product_id) ON DELETE CASCADE,
+  CONSTRAINT chk_quantity_positive CHECK (quantity > 0),
+  CONSTRAINT chk_unit_price_positive CHECK (unit_price > 0),
+  CONSTRAINT uq_order_product UNIQUE (order_id, product_id)
+);
+
+-- Create a composite index on order_id and product_id for faster joins
+CREATE INDEX idx_order_items_order_product ON order_items (order_id, product_id);
+
+-- Create a table with default values for string types
+CREATE TABLE all_string_types (
+  text_col TEXT DEFAULT 'default_text',
+  varchar_col VARCHAR(100) DEFAULT 'default_varchar',
+  char_col CHAR(10) DEFAULT 'default_char',
+  character_varying_col CHARACTER VARYING(50) DEFAULT 'default_character_varying',
+  character_col CHARACTER(5) DEFAULT 'default_character',
+  name_col NAME DEFAULT 'default_name',
+  bpchar_col BPCHAR(15) DEFAULT 'default_bpchar',
+  text_array_col TEXT[] DEFAULT ARRAY['default_text1', 'default_text2'],
+  json_col JSON DEFAULT '{"default_key": "default_value"}',
+  jsonb_col JSONB DEFAULT '{"default_key": "default_value"}'
+);
+
+-- Create a table with default value for number type, boolean type, date type
+CREATE TABLE all_default_values (
+  id SERIAL PRIMARY KEY,  -- A primary key column
+  boolean_col BOOLEAN DEFAULT TRUE,  -- BOOLEAN type with default value
+  integer_col INTEGER DEFAULT 42,  -- INTEGER type with default value
+  numeric_col NUMERIC(10, 2) DEFAULT 99.99,  -- NUMERIC type with default value
+  date_col DATE DEFAULT CURRENT_DATE,  -- DATE type with default value
+  date_col_specific DATE DEFAULT '2024-01-01',  -- DATE with a specific default value
+  timestamp_col TIMESTAMP DEFAULT CURRENT_TIMESTAMP,  -- TIMESTAMP with default value
+  timestamp_col_specific TIMESTAMP DEFAULT '2024-01-01 12:00:00',  -- TIMESTAMP with a specific default value
+  -- New columns that calculate default values based on formulas
+  date_plus_7_days DATE DEFAULT (CURRENT_DATE + INTERVAL '7 days'),  -- 7 days from current date
+  date_minus_30_days DATE DEFAULT (CURRENT_DATE - INTERVAL '30 days'),  -- 30 days before current date
+  timestamp_plus_1_hour TIMESTAMP DEFAULT (CURRENT_TIMESTAMP + INTERVAL '1 hour'),  -- 1 hour from current timestamp
+  timestamp_minus_15_minutes TIMESTAMP DEFAULT (CURRENT_TIMESTAMP - INTERVAL '15 minutes')  -- 15 minutes before current timestamp
+);
+
+-- Create a table with user-defined data types
+CREATE TYPE gender_type AS ENUM ('Male', 'Female', 'Other');
+
+CREATE TABLE user_define_data_types (
+  id SERIAL PRIMARY KEY,
+  name VARCHAR(50),
+  gender gender_type,
+  age int4range,  -- Using built-in int4range for age range
+  height FLOAT,
+  weight FLOAT
+);
+
+-- Create table with comments
+CREATE TABLE table_with_comments (
+  id SERIAL PRIMARY KEY,
+  name VARCHAR(100),
+  description TEXT,
+  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Add comments
+COMMENT ON TABLE table_with_comments IS 'This table stores information about various items.';
+COMMENT ON COLUMN table_with_comments.id IS 'Unique identifier for each item.';
+COMMENT ON COLUMN table_with_comments.name IS 'Name of the item.';
+COMMENT ON COLUMN table_with_comments.description IS 'Detailed description of the item.';
+COMMENT ON COLUMN table_with_comments.created_at IS 'Timestamp when the item was created.';
+
+-- Create Authors table
+CREATE TABLE Authors (
+  AuthorID SERIAL,
+  NationalityID INT,
+  AuthorName VARCHAR(100),
+  BirthYear INT,
+  PRIMARY KEY (AuthorID, NationalityID) -- Use composite primary key
+);
+
+-- Create Books table
+CREATE TABLE Books (
+  BookID SERIAL PRIMARY KEY,
+  AuthorID INT,
+  NationalityID INT,
+  ISBN VARCHAR(20),
+  Title VARCHAR(200),
+  UNIQUE (ISBN),
+  CONSTRAINT FK_AuthorNationality FOREIGN KEY (AuthorID, NationalityID)
+    REFERENCES Authors (AuthorID, NationalityID) ON DELETE CASCADE
+);

package/__test__/db2dbml/postgres/stdout.txt

@@ -0,0 +1 @@
+  ✔ Generated DBML file from database's connection: schema.dbml

package/__test__/db2dbml_bin.js

@@ -0,0 +1,5 @@
+// eslint-disable-next-line
+require = require('esm')(module);
+const { db2dbml } = require('../src');
+
+db2dbml(process.argv);

package/__test__/dbml2sql/filename --mysql --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: MySQL
--- Generated at: 2024-06-12T04:31:50.947Z
+-- Generated at: 2024-08-11T02:27:52.128Z
 
 CREATE TABLE `orders` (
   `id` int PRIMARY KEY AUTO_INCREMENT,

package/__test__/dbml2sql/filename --oracle --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: Oracle
--- Generated at: 2024-06-12T04:31:51.438Z
+-- Generated at: 2024-08-11T02:27:53.200Z
 
 CREATE TABLE "orders" (
   "id" int GENERATED AS IDENTITY PRIMARY KEY,

package/__test__/dbml2sql/filename --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: PostgreSQL
--- Generated at: 2024-06-12T04:31:51.928Z
+-- Generated at: 2024-08-11T02:27:54.276Z
 
 CREATE TYPE "orders_status" AS ENUM (
   'created',

package/__test__/dbml2sql/filename --postgres --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: PostgreSQL
--- Generated at: 2024-06-12T04:31:52.172Z
+-- Generated at: 2024-08-11T02:27:54.808Z
 
 CREATE TYPE "orders_status" AS ENUM (
   'created',

package/__test__/dbml2sql/filenames --mysql --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: MySQL
--- Generated at: 2024-06-12T04:31:52.902Z
+-- Generated at: 2024-08-11T02:27:56.421Z
 
 CREATE TABLE `staff` (
   `id` int PRIMARY KEY,

package/__test__/dbml2sql/filenames --oracle --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: Oracle
--- Generated at: 2024-06-12T04:31:53.397Z
+-- Generated at: 2024-08-11T02:27:57.507Z
 
 CREATE TABLE "staff" (
   "id" int PRIMARY KEY,

package/__test__/dbml2sql/filenames --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: PostgreSQL
--- Generated at: 2024-06-12T04:31:53.893Z
+-- Generated at: 2024-08-11T02:27:58.615Z
 
 CREATE TABLE "staff" (
   "id" int PRIMARY KEY,

package/__test__/dbml2sql/filenames --postgres --out-file/out-files/schema.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: PostgreSQL
--- Generated at: 2024-06-12T04:31:54.144Z
+-- Generated at: 2024-08-11T02:27:59.155Z
 
 CREATE TABLE "staff" (
   "id" int PRIMARY KEY,

package/__test__/dbml2sql/multiple_schema_mssql/out-files/multiple_schema.out.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: SQL Server
--- Generated at: 2024-06-12T04:31:54.881Z
+-- Generated at: 2024-08-11T02:28:00.785Z
 
 CREATE SCHEMA [schemaB]
 GO

package/__test__/dbml2sql/multiple_schema_mysql/out-files/multiple_schema.out.sql

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: MySQL
--- Generated at: 2024-06-12T04:31:55.123Z
+-- Generated at: 2024-08-11T02:28:01.320Z
 
 CREATE SCHEMA `schemaB`;
 

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

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: Oracle
--- Generated at: 2024-06-12T04:31:55.366Z
+-- Generated at: 2024-08-11T02:28:01.857Z
 
 CREATE USER "C##test01"
 NO AUTHENTICATION

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

@@ -1,6 +1,6 @@
 -- SQL dump generated using DBML (dbml.dbdiagram.io)
 -- Database: PostgreSQL
--- Generated at: 2024-06-12T04:31:55.612Z
+-- Generated at: 2024-08-11T02:28:02.391Z
 
 CREATE SCHEMA "schemaB";
 

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

@@ -1,3 +1,12 @@
 2024-06-12T04:31:55.864Z
 undefined
 
+2024-08-09T00:04:56.460Z
+undefined
+
+2024-08-09T03:07:55.701Z
+undefined
+
+2024-08-11T02:28:02.933Z
+undefined
+

package/__test__/sql2dbml/filename --snowflake stdout/stdout.txt

@@ -1,7 +1,7 @@
 Table "HP_TEST"."CUSTOMERS" {
   "CUSTOMER_ID" "NUMBER(38, 0)" [pk, not null, increment]
-  "FIRST_NAME" VARCHAR(50) [not null, default: "'John'"]
-  "LAST_NAME" VARCHAR(50) [not null, default: "'Doe'"]
+  "FIRST_NAME" VARCHAR(50) [not null, default: 'John']
+  "LAST_NAME" VARCHAR(50) [not null, default: 'Doe']
   "EMAIL" VARCHAR(100)
   "SECOND_EMAIL" VARCHAR(100)
   "UNIQUE_NAME" VARCHAR(100) [unique, not null, default: `CONCAT(FIRST_NAME, LAST_NAME, EMAIL)`]
@@ -196,19 +196,19 @@ Table "t_default_14" {
 }
 
 Table "t_default_15" {
-  "v" varchar(32) [default: "'hey'"]
+  "v" varchar(32) [default: 'hey']
 }
 
 Table "t_default_16" {
-  "v" varchar(32) [unique, default: "'hey'"]
+  "v" varchar(32) [unique, default: 'hey']
 }
 
 Table "t_default_17" {
-  "v" varchar(32) [unique, default: "'hey'"]
+  "v" varchar(32) [unique, default: 'hey']
 }
 
 Table "t_default_18" {
-  "v" varchar(32) [pk, default: "'hey'"]
+  "v" varchar(32) [pk, default: 'hey']
 }
 
 Table "t_masking_1" {

package/__test__/sql2dbml/syntax-error/dbml-error.log

@@ -1,3 +1,12 @@
 2024-06-12T04:32:03.429Z
 undefined
 
+2024-08-09T00:05:09.112Z
+undefined
+
+2024-08-09T03:08:08.840Z
+undefined
+
+2024-08-11T02:28:22.795Z
+undefined
+

package/__test__/sql2dbml/syntax-error-duplicate-endpoints --mssql/dbml-error.log

@@ -1,3 +1,12 @@
 2024-06-12T04:32:03.669Z
 undefined
 
+2024-08-09T00:05:09.476Z
+undefined
+
+2024-08-09T03:08:09.208Z
+undefined
+
+2024-08-11T02:28:23.316Z
+undefined
+

package/__test__/sql2dbml/syntax-error-duplicate-endpoints --mysql/dbml-error.log

@@ -1,3 +1,12 @@
 2024-06-12T04:32:04.090Z
 undefined
 
+2024-08-09T00:05:09.972Z
+undefined
+
+2024-08-09T03:08:09.727Z
+undefined
+
+2024-08-11T02:28:24.073Z
+undefined
+

package/bin/db2dbml.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+/* eslint-disable */
+
+require('../lib').db2dbml(process.argv);

package/dbml-error.log

@@ -0,0 +1,53 @@
+2024-08-07T02:44:57.506Z
+Error: Error: connect ECONNREFUSED 127.0.0.1:3306
+    at _callee8$ (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:474:17)
+    at tryCatch (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:1357)
+    at Generator.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:4174)
+    at Generator.throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:2208)
+    at asyncGeneratorStep (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:17:103)
+    at _throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:18:291)
+    at processTicksAndRejections (node:internal/process/task_queues:96:5)
+
+2024-08-07T02:51:24.263Z
+Error: Error: MySQL connection error:
+    at _callee8$ (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:485:17)
+    at tryCatch (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:1357)
+    at Generator.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:4174)
+    at Generator.throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:2208)
+    at asyncGeneratorStep (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:17:103)
+    at _throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:18:291)
+    at processTicksAndRejections (node:internal/process/task_queues:96:5)
+
+2024-08-07T02:52:34.901Z
+Error: Error: MySQL connection error: Error: connect ECONNREFUSED 127.0.0.1:3306
+    at _callee8$ (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:485:17)
+    at tryCatch (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:1357)
+    at Generator.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:4174)
+    at Generator.throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:2208)
+    at asyncGeneratorStep (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:17:103)
+    at _throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:18:291)
+    at processTicksAndRejections (node:internal/process/task_queues:96:5)
+
+2024-08-07T02:53:35.536Z
+Error: Error: MySQL connection error: Error: connect ECONNREFUSED 127.0.0.1:3306
+    at _callee8$ (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:485:17)
+    at tryCatch (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:1357)
+    at Generator.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:4174)
+    at Generator.throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:16:2208)
+    at asyncGeneratorStep (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:17:103)
+    at _throw (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/parse/connection/mysql/utils/sql.js:18:291)
+    at processTicksAndRejections (node:internal/process/task_queues:96:5)
+
+2024-08-12T04:39:12.767Z
+TypeError [ERR_INVALID_URL]: Invalid URL
+    at new NodeError (node:internal/errors:387:5)
+    at URL.onParseError (node:internal/url:565:9)
+    at new URL (node:internal/url:641:5)
+    at Function.parseUrl (/Users/huylm/code/dbx/dbml/node_modules/mysql2/lib/connection_config.js:263:23)
+    at new ConnectionConfig (/Users/huylm/code/dbx/dbml/node_modules/mysql2/lib/connection_config.js:75:34)
+    at Object.exports.createConnection (/Users/huylm/code/dbx/dbml/node_modules/mysql2/index.js:10:35)
+    at createConnection (/Users/huylm/code/dbx/dbml/node_modules/mysql2/promise.js:252:31)
+    at _callee$ (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/connectors/mysqlConnector.js:41:48)
+    at tryCatch (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/connectors/mysqlConnector.js:14:1357)
+    at Generator.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-core/lib/connectors/mysqlConnector.js:14:4174)
+

package/lib/cli/connector.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = connectionHandler;
+var _core = require("@dbml/core");
+var _figures = _interopRequireDefault(require("figures"));
+var _chalk = _interopRequireDefault(require("chalk"));
+var _path = _interopRequireDefault(require("path"));
+var _utils = require("./utils");
+var _outputConsolePlugin = _interopRequireDefault(require("./outputPlugins/outputConsolePlugin"));
+var _outputFilePlugin = _interopRequireDefault(require("./outputPlugins/outputFilePlugin"));
+var _logger = _interopRequireDefault(require("../helpers/logger"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+async function connectionHandler(program) {
+  try {
+    const {
+      connection,
+      format
+    } = (0, _utils.getConnectionOpt)(program.args);
+    const opts = program.opts();
+    if (!opts.outFile && !opts.outDir) {
+      const res = await _core.importer.generateDbml(connection, format);
+      _outputConsolePlugin.default.write(res);
+    } else if (opts.outFile) {
+      const res = await _core.importer.generateDbml(connection, format);
+      new _outputFilePlugin.default((0, _utils.resolvePaths)(opts.outFile)).write(res);
+
+      // bearer:disable javascript_lang_logger
+      console.log(`  ${_chalk.default.green(_figures.default.main.tick)} Generated DBML file from database's connection: ${_path.default.basename(opts.outFile)}`);
+    }
+  } catch (error) {
+    _logger.default.error(error);
+  }
+}

package/lib/cli/index.js

@@ -3,18 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.db2dbml = db2dbml;
 exports.dbml2sql = dbml2sql;
 exports.sql2dbml = sql2dbml;
 var _commander = _interopRequireDefault(require("commander"));
 var _import = _interopRequireDefault(require("./import"));
 var _export = _interopRequireDefault(require("./export"));
+var _connector = _interopRequireDefault(require("./connector"));
 var _package = _interopRequireDefault(require("../../package.json"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function showHelp(args) {
+  if (args.length < 3) _commander.default.help();
+}
 function dbml2sql(args) {
   _commander.default.version(_package.default.version);
   _commander.default.usage('[options] <files...>').option('--mysql').option('--postgres').option('--mssql').option('--oracle').option('-o, --out-file <pathspec>', 'compile all input files into a single files');
   // .option('-d, --out-dir <pathspec>', 'compile an input directory of dbml files into an output directory');
 
+  showHelp(args);
   _commander.default.parse(args);
   (0, _export.default)(_commander.default);
 }
@@ -23,6 +29,28 @@ function sql2dbml(args) {
   _commander.default.usage('[options] <files...>').option('--mysql').option('--mysql-legacy').option('--postgres').option('--postgres-legacy').option('--mssql').option('--snowflake').option('-o, --out-file <pathspec>', 'compile all input files into a single files');
   // .option('-d, --out-dir <pathspec>', 'compile an input directory of sql files into an output directory');
 
+  showHelp(args);
   _commander.default.parse(args);
   (0, _import.default)(_commander.default);
+}
+function db2dbml(args) {
+  _commander.default.version(_package.default.version);
+
+  // Q: How to write the arguments description for the below usage?
+  // A: The usage description is written in the following way:
+  //    - <format> your database format (postgres, mysql, mssql)
+  //    - <connection-string> your database connection string
+  //    - postgres: postgresql://user:password@localhost:5432/dbname
+  //    - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate
+  const description = `
+    <format> your database format (postgres, mysql, mssql)
+    <connection-string> your database connection string:
+      - postgres: postgresql://user:password@localhost:5432/dbname
+      - mysql: mysql://user:password@localhost:3306/dbname
+      - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;'
+  `;
+  _commander.default.usage('<format> <connection-string> [options]').description(description).option('-o, --out-file <pathspec>', 'compile all input files into a single files');
+  showHelp(args);
+  _commander.default.parse(args);
+  (0, _connector.default)(_commander.default);
 }

package/lib/cli/utils.js

@@ -4,12 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.generate = generate;
+exports.getConnectionOpt = getConnectionOpt;
 exports.getFormatOpt = getFormatOpt;
 exports.resolvePaths = resolvePaths;
 exports.validateInputFilePaths = validateInputFilePaths;
 var _path2 = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _core = require("@dbml/core");
+var _lodash = require("lodash");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function resolvePaths(paths) {
   if (!Array.isArray(paths)) {
@@ -35,6 +37,24 @@ function getFormatOpt(opts) {
   });
   return format;
 }
+function getConnectionOpt(args) {
+  const supportedDatabases = ['postgres', 'mysql', 'mssql'];
+  const defaultConnectionOpt = {
+    connection: args[0],
+    format: 'unknown'
+  };
+  return (0, _lodash.reduce)(args, (connectionOpt, arg) => {
+    if (supportedDatabases.includes(arg)) connectionOpt.format = arg;
+    // Check if the arg is a connection string using regex
+    const connectionStringRegex = /^.*[:;]/;
+    if (connectionStringRegex.test(arg)) {
+      // Example: jdbc:mysql://localhost:3306/mydatabase
+      // Example: odbc:Driver={SQL Server};Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
+      connectionOpt.connection = arg;
+    }
+    return connectionOpt;
+  }, defaultConnectionOpt);
+}
 function generate(inputPaths, transform, outputPlugin) {
   inputPaths.forEach(_path => {
     const source = _fs.default.readFileSync(_path, 'utf-8');

package/lib/connectors/Connector.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fetchSchemaJson = void 0;
+var _PostgresConnector = require("./PostgresConnector");
+var _MssqlConnector = require("./MssqlConnector");
+const fetchSchemaJson = async (connection, format) => {
+  switch (format) {
+    case 'postgres':
+      return (0, _PostgresConnector.fetchSchemaJson)(connection);
+    case 'mssql':
+      return (0, _MssqlConnector.fetchSchemaJson)(connection);
+    default:
+      throw new Error(`Unsupported connection format: ${format}`);
+  }
+};
+exports.fetchSchemaJson = fetchSchemaJson;