@dbml/cli 3.7.4 → 3.8.1

package/__test__/db2dbml/postgres/expect-out-files/schema.dbml

@@ -1,3 +1,33 @@
+Enum "dbml_test"."enum_type1" {
+  "value1"
+  "value2"
+}
+
+Enum "dbml_test"."enum_type3" {
+  "value4"
+  "value5"
+}
+
+Table "dbml_test"."table1" {
+  "id" int4 [pk, not null, increment]
+  "status" dbml_test.enum_type1
+}
+
+Table "dbml_test"."table3" {
+  "id" int4 [pk, not null, increment]
+  "status" dbml_test.enum_type3
+}
+
+Enum "enum_type1" {
+  "value1"
+  "value2"
+}
+
+Enum "enum_type2" {
+  "value1"
+  "value3"
+}
+
 Enum "gender_type" {
   "Male"
   "Female"
@@ -94,6 +124,16 @@ Table "products" {
   }
 }
 
+Table "table1" {
+  "id" int4 [pk, not null, increment]
+  "status" enum_type1
+}
+
+Table "table2" {
+  "id" int4 [pk, not null, increment]
+  "status" enum_type2
+}
+
 Table "table_with_comments" {
   "id" int4 [pk, not null, increment, note: 'Unique identifier for each item.']
   "name" varchar(100) [note: 'Name of the item.']

package/__test__/db2dbml/postgres/schema.sql

@@ -1,4 +1,6 @@
 -- Create users table
+CREATE SCHEMA dbml_test;
+
 CREATE TABLE users (
   user_id SERIAL PRIMARY KEY,
   username VARCHAR(50) UNIQUE NOT NULL,
@@ -154,3 +156,32 @@ CREATE TABLE Books (
   CONSTRAINT FK_AuthorNationality FOREIGN KEY (AuthorID, NationalityID)
     REFERENCES Authors (AuthorID, NationalityID) ON DELETE CASCADE
 );
+
+-- Create enum types in the public schema
+CREATE TYPE public.enum_type1 AS ENUM ('value1', 'value2');
+CREATE TYPE public.enum_type2 AS ENUM ('value1', 'value3');
+
+-- Create enum types in the dbml_test schema
+CREATE TYPE dbml_test.enum_type1 AS ENUM ('value1', 'value2');
+CREATE TYPE dbml_test.enum_type3 AS ENUM ('value4', 'value5');
+
+-- Optionally, create tables to use these enum types
+CREATE TABLE public.table1 (
+  id SERIAL PRIMARY KEY,
+  status public.enum_type1
+);
+
+CREATE TABLE public.table2 (
+  id SERIAL PRIMARY KEY,
+  status public.enum_type2
+);
+
+CREATE TABLE dbml_test.table1 (
+  id SERIAL PRIMARY KEY,
+  status dbml_test.enum_type1
+);
+
+CREATE TABLE dbml_test.table3 (
+  id SERIAL PRIMARY KEY,
+  status dbml_test.enum_type3
+);

package/dbml-error.log

@@ -57,3 +57,85 @@ Error: Load credential error: ENOENT: no such file or directory, open 'bigquery'
     at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:256:27)
     at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
 
+2024-08-26T04:32:24.565Z
+Error: Load credential error: ENOENT: no such file or directory, open 'bigquery'
+    at loadCredentialFromFile (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/utils/credential-loader.js:13:19)
+    at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:259:27)
+    at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
+
+2024-08-26T09:05:40.128Z
+Error: Load credential error: ENOENT: no such file or directory, open '/Users/huylm/code/dbx/dbml/packages/dbml-connector/keys/bq-test-key.json'
+    at loadCredentialFromFile (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/utils/credential-loader.js:13:19)
+    at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:259:27)
+    at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
+
+2024-08-26T09:06:55.525Z
+Error: Load credential error: ENOENT: no such file or directory, open '/Users/huylm/code/dbx/bq-test-key.json'
+    at loadCredentialFromFile (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/utils/credential-loader.js:13:19)
+    at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:259:27)
+    at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
+
+2024-08-26T09:12:14.323Z
+Error: Load credential error: ENOENT: no such file or directory, open '/Users/huylm/Users/huylm/code/dbx/bq-test-key.json'
+    at loadCredentialFromFile (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/utils/credential-loader.js:13:19)
+    at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:259:27)
+    at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
+
+2024-08-26T09:12:39.045Z
+Error: Load credential error: ENOENT: no such file or directory, open '/Users/huylm/code/dbx/dbml/packages/dbml-connector/keys/bq-test-key.json'
+    at loadCredentialFromFile (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/utils/credential-loader.js:13:19)
+    at async fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/bigqueryConnector.js:259:27)
+    at async connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:24)
+
+2024-08-26T09:38:34.868Z
+Error: Unsupported connection format: unknown
+    at Object.fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/connector.js:19:19)
+    at connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:51)
+    at Object.db2dbml (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/index.js:66:26)
+    at Object.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-cli/bin/db2dbml.js:4:19)
+    at Module._compile (node:internal/modules/cjs/loader:1256:14)
+    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
+    at Module.load (node:internal/modules/cjs/loader:1119:32)
+    at Module._load (node:internal/modules/cjs/loader:960:12)
+    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
+    at node:internal/main/run_main_module:23:47
+
+2024-08-27T04:10:42.077Z
+InvalidParameterError: Invalid account. The specified value must be a valid subdomain string.
+    at createError (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/errors.js:536:17)
+    at exports.checkArgumentValid (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/errors.js:270:11)
+    at consolidateHostAndAccount (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/connection/connection_config.js:82:12)
+    at new ConnectionConfig (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/connection/connection_config.js:192:5)
+    at createConnection (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/core.js:79:7)
+    at Object.createConnection (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/core.js:102:16)
+    at connectToSnowflake (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:69:48)
+    at fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:260:24)
+    at Object.fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/connector.js:17:61)
+    at connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:51)
+
+2024-08-27T04:12:47.369Z
+InvalidParameterError: Invalid account. The specified value must be a valid subdomain string.
+    at createError (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/errors.js:536:17)
+    at exports.checkArgumentValid (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/errors.js:270:11)
+    at consolidateHostAndAccount (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/connection/connection_config.js:82:12)
+    at new ConnectionConfig (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/connection/connection_config.js:192:5)
+    at createConnection (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/core.js:79:7)
+    at Object.createConnection (/Users/huylm/code/dbx/dbml/node_modules/snowflake-sdk/lib/core.js:102:16)
+    at connectToSnowflake (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:69:48)
+    at fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:261:24)
+    at Object.fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/connector.js:17:61)
+    at connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:51)
+
+2024-08-27T04:13:16.756Z
+Error: Test throw
+    at connectToSnowflake (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:68:11)
+    at fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/snowflakeConnector.js:261:24)
+    at Object.fetchSchemaJson (/Users/huylm/code/dbx/dbml/packages/dbml-connector/dist/connectors/connector.js:17:61)
+    at connectionHandler (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/connector.js:24:51)
+    at Object.db2dbml (/Users/huylm/code/dbx/dbml/packages/dbml-cli/lib/cli/index.js:58:26)
+    at Object.<anonymous> (/Users/huylm/code/dbx/dbml/packages/dbml-cli/bin/db2dbml.js:4:19)
+    at Module._compile (node:internal/modules/cjs/loader:1256:14)
+    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
+    at Module.load (node:internal/modules/cjs/loader:1119:32)
+    at Module._load (node:internal/modules/cjs/loader:960:12)
+

package/lib/cli/connector.js

@@ -18,10 +18,10 @@ async function connectionHandler(program) {
   try {
     const {
       connection,
-      format
+      databaseType
     } = (0, _utils.getConnectionOpt)(program.args);
     const opts = program.opts();
-    const schemaJson = await _connector.connector.fetchSchemaJson(connection, format);
+    const schemaJson = await _connector.connector.fetchSchemaJson(connection, databaseType);
     if (!opts.outFile && !opts.outDir) {
       const res = _core.importer.generateDbml(schemaJson);
       _outputConsolePlugin.default.write(res);

package/lib/cli/index.js

@@ -12,6 +12,8 @@ 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 }; }
+/* eslint-disable max-len */
+
 function showHelp(args) {
   if (args.length < 3) _commander.default.help();
 }
@@ -35,21 +37,26 @@ function sql2dbml(args) {
 }
 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)
+  const description = `Generate DBML directly from a database
+    <database-type>     your database format (postgres, mysql, mssql, snowflake, bigquery)
     <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;'
+                        - postgres: 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2,schema3'
+                        - mysql: 'mysql://user:password@localhost:3306/dbname'
+                        - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2,schema3;'
+                        - snowflake: 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2,schema3;'
+                        - bigquery: /path_to_json_credential.json
+
+                        For BigQuery, your JSON credential file must contain the following keys:
+                          {
+                            "project_id": "your-project-id",
+                            "client_email": "your-client-email",
+                            "private_key": "your-private-key",
+                            "datasets": ["dataset_1", "dataset_2", ...]
+                          }
+
+                        Note: If the "datasets" key is not provided or is an empty array, it will fetch information from all datasets.
   `;
-  _commander.default.usage('<format> <connection-string> [options]').description(description).option('-o, --out-file <pathspec>', 'compile all input files into a single files');
+  _commander.default.usage('<database-type> <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

@@ -38,13 +38,13 @@ function getFormatOpt(opts) {
   return format;
 }
 function getConnectionOpt(args) {
-  const supportedDatabases = ['postgres', 'mysql', 'mssql'];
+  const supportedDatabases = ['postgres', 'mysql', 'mssql', 'snowflake', 'bigquery'];
   const defaultConnectionOpt = {
     connection: args[0],
-    format: 'unknown'
+    databaseType: 'unknown'
   };
   return (0, _lodash.reduce)(args, (connectionOpt, arg) => {
-    if (supportedDatabases.includes(arg)) connectionOpt.format = arg;
+    if (supportedDatabases.includes(arg)) connectionOpt.databaseType = arg;
     // Check if the arg is a connection string using regex
     const connectionStringRegex = /^.*[:;]/;
     if (connectionStringRegex.test(arg)) {
@@ -52,6 +52,11 @@ function getConnectionOpt(args) {
       // Example: odbc:Driver={SQL Server};Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
       connectionOpt.connection = arg;
     }
+    const windowFilepathRegex = /^[a-zA-Z]:[\\/](?:[^<>:"/\\|?*\n\r]+[\\/])*[^<>:"/\\|?*\n\r]*$/;
+    const unixFilepathRegex = /^(\/|\.\/|~\/|\.\.\/)([^<>:"|?*\n\r]*\/?)*[^<>:"|?*\n\r]*$/;
+    if (windowFilepathRegex.test(arg) || unixFilepathRegex.test(arg)) {
+      connectionOpt.connection = arg;
+    }
     return connectionOpt;
   }, defaultConnectionOpt);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/cli",
-  "version": "3.7.4",
+  "version": "3.8.1",
   "description": "",
   "main": "lib/index.js",
   "license": "Apache-2.0",
@@ -26,8 +26,8 @@
   ],
   "dependencies": {
     "@babel/cli": "^7.21.0",
-    "@dbml/connector": "^3.7.4",
-    "@dbml/core": "^3.7.4",
+    "@dbml/connector": "^3.8.1",
+    "@dbml/core": "^3.8.1",
     "bluebird": "^3.5.5",
     "chalk": "^2.4.2",
     "commander": "^2.20.0",
@@ -55,7 +55,7 @@
       "^.+\\.js$": "babel-jest"
     }
   },
-  "gitHead": "316fd7ce4039ce9b622c30fbb2d03ab2198bd7eb",
+  "gitHead": "40a25ded1488372f082739f6d43e45f2ad918e7e",
   "engines": {
     "node": ">=18"
   }

package/src/cli/connector.js

@@ -13,9 +13,9 @@ import logger from '../helpers/logger';
 
 export default async function connectionHandler (program) {
   try {
-    const { connection, format } = getConnectionOpt(program.args);
+    const { connection, databaseType } = getConnectionOpt(program.args);
     const opts = program.opts();
-    const schemaJson = await connector.fetchSchemaJson(connection, format);
+    const schemaJson = await connector.fetchSchemaJson(connection, databaseType);
 
     if (!opts.outFile && !opts.outDir) {
       const res = importer.generateDbml(schemaJson);

package/src/cli/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 import program from 'commander';
 import importHandler from './import';
 import exportHandler from './export';
@@ -49,21 +50,27 @@ function sql2dbml (args) {
 function db2dbml (args) {
   program.version(projectInfo.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)
+  const description = `Generate DBML directly from a database
+    <database-type>     your database format (postgres, mysql, mssql, snowflake, bigquery)
     <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;'
+                        - postgres: 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2,schema3'
+                        - mysql: 'mysql://user:password@localhost:3306/dbname'
+                        - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2,schema3;'
+                        - snowflake: 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2,schema3;'
+                        - bigquery: /path_to_json_credential.json
+
+                        For BigQuery, your JSON credential file must contain the following keys:
+                          {
+                            "project_id": "your-project-id",
+                            "client_email": "your-client-email",
+                            "private_key": "your-private-key",
+                            "datasets": ["dataset_1", "dataset_2", ...]
+                          }
+
+                        Note: If the "datasets" key is not provided or is an empty array, it will fetch information from all datasets.
   `;
   program
-    .usage('<format> <connection-string> [options]')
+    .usage('<database-type> <connection-string> [options]')
     .description(description)
     .option('-o, --out-file <pathspec>', 'compile all input files into a single files');
 

package/src/cli/utils.js

@@ -34,14 +34,14 @@ function getFormatOpt (opts) {
 }
 
 function getConnectionOpt (args) {
-  const supportedDatabases = ['postgres', 'mysql', 'mssql'];
+  const supportedDatabases = ['postgres', 'mysql', 'mssql', 'snowflake', 'bigquery'];
   const defaultConnectionOpt = {
     connection: args[0],
-    format: 'unknown',
+    databaseType: 'unknown',
   };
 
   return reduce(args, (connectionOpt, arg) => {
-    if (supportedDatabases.includes(arg)) connectionOpt.format = arg;
+    if (supportedDatabases.includes(arg)) connectionOpt.databaseType = arg;
     // Check if the arg is a connection string using regex
     const connectionStringRegex = /^.*[:;]/;
     if (connectionStringRegex.test(arg)) {
@@ -50,6 +50,13 @@ function getConnectionOpt (args) {
       connectionOpt.connection = arg;
     }
 
+    const windowFilepathRegex = /^[a-zA-Z]:[\\/](?:[^<>:"/\\|?*\n\r]+[\\/])*[^<>:"/\\|?*\n\r]*$/;
+    const unixFilepathRegex = /^(\/|\.\/|~\/|\.\.\/)([^<>:"|?*\n\r]*\/?)*[^<>:"|?*\n\r]*$/;
+
+    if (windowFilepathRegex.test(arg) || unixFilepathRegex.test(arg)) {
+      connectionOpt.connection = arg;
+    }
+
     return connectionOpt;
   }, defaultConnectionOpt);
 }