dbdocs 0.11.1 → 0.12.1

package/README.md

@@ -1,8 +1,6 @@
 dbdocs
 ======
 
-
-
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/dbdocs.svg)](https://npmjs.org/package/dbdocs)
 [![Downloads/week](https://img.shields.io/npm/dw/dbdocs.svg)](https://npmjs.org/package/dbdocs)
@@ -12,6 +10,7 @@ dbdocs
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
+
 # Usage
 <!-- usage -->
 ```sh-session
@@ -29,7 +28,7 @@ USAGE
 # Commands
 <!-- commands -->
 * [`dbdocs build [FILEPATH]`](#dbdocs-build-filepath)
-* [`dbdocs db2dbml [FORMAT] [CONNECTION-STRING`](#dbdocs-db2dbml-format-connection-string)
+* [`dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING`](#dbdocs-db2dbml-database-type-connection-string)
 * [`dbdocs help [COMMAND]`](#dbdocs-help-command)
 * [`dbdocs login`](#dbdocs-login)
 * [`dbdocs logout`](#dbdocs-logout)
@@ -44,7 +43,7 @@ USAGE
 
 build docs
 
-```
+```bash
 USAGE
   $ dbdocs build [FILEPATH]
 
@@ -56,20 +55,17 @@ OPTIONS
   --project=project        project name
 ```
 
-## `dbdocs db2dbml [FORMAT] [CONNECTION-STRING]`
+## `dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING]`
 
 Generate DBML directly from a database
 
 ```bash
 USAGE
-  $ dbdocs db2dbml [FORMAT] [CONNECTION-STRING] [-o <value>]
+  $ dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING] [-o <value>]
 
 ARGUMENTS
-  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;'
+  DATABASE-TYPE      your database type (postgres, mysql, mssql, snowflake, bigquery)
+  CONNECTION-STRING  your database connection string (See below examples for more details)
 
 FLAGS
   -o, --outFile=/path-to-your-file  output file path
@@ -77,13 +73,33 @@ FLAGS
 DESCRIPTION
   Generate DBML directly from a database
 
+EXAMPLES
+  Postgres:
+    $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'
+  MySQL:
+    $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'
+  MSSQL:
+    $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'
+  Snowflake:
+    $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'
+  BigQuery:
+    $ db2dbml bigquery /path_to_json_credential.json
+
+    Note: Your JSON credential file must contain:
+    {
+      "project_id": "your-project-id",
+      "client_email": "your-client-email",
+      "private_key": "your-private-key",
+      "datasets": ["dataset_1", "dataset_2", ...]
+    }
+    If "datasets" key is not provided or is empty, it will fetch all datasets.
 ```
 
 ## `dbdocs help [COMMAND]`
 
 display help for dbdocs
 
-```
+```bash
 USAGE
   $ dbdocs help [COMMAND]
 
@@ -98,7 +114,7 @@ OPTIONS
 
 login to dbdocs
 
-```
+```bash
 USAGE
   $ dbdocs login
 
@@ -110,7 +126,7 @@ DESCRIPTION
 
 logout
 
-```
+```bash
 USAGE
   $ dbdocs logout
 
@@ -122,7 +138,7 @@ DESCRIPTION
 
 list projects
 
-```
+```bash
 USAGE
   $ dbdocs ls
 
@@ -134,7 +150,7 @@ DESCRIPTION
 
 set password for your project or remove password
 
-```
+```bash
 USAGE
   $ dbdocs password
 
@@ -148,7 +164,7 @@ OPTIONS
 
 remove project
 
-```
+```bash
 USAGE
   $ dbdocs remove [PROJECT_NAME]
 
@@ -160,7 +176,7 @@ ARGUMENTS
 
 change your username
 
-```
+```bash
 USAGE
   $ dbdocs rename
 
@@ -172,7 +188,7 @@ DESCRIPTION
 
 generate or revoke your authentication token
 
-```
+```bash
 USAGE
   $ dbdocs token
 
@@ -185,7 +201,7 @@ OPTIONS
 
 validate docs content
 
-```
+```bash
 USAGE
   $ dbdocs validate [FILEPATH]
 

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.11.1","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name","multiple":false},"public":{"name":"public","type":"boolean","description":"anyone with the URL can access","helpGroup":"sharing","allowNo":false,"exclusive":["private","password"]},"private":{"name":"private","type":"boolean","description":"only invited people can access","helpGroup":"sharing","allowNo":false,"exclusive":["public","password"]},"password":{"name":"password","type":"option","char":"p","description":"anyone with the URL + password can access","helpGroup":"sharing","multiple":false,"exclusive":["public","private"]}},"args":[{"name":"filepath","description":"dbml file path"}]},"db2dbml":{"id":"db2dbml","description":"Generate DBML directly from a database","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"outFile":{"name":"outFile","type":"option","char":"o","description":"output file path","helpValue":"/path-to-your-file","multiple":false}},"args":[{"name":"format","description":"your database format (postgres, mysql, mssql)","required":true},{"name":"connection-string","description":"your database connection string:\n    - postgres: postgresql://user:password@localhost:5432/dbname\n    - mysql: mysql://user:password@localhost:3306/dbname\n    - mssql: 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;'","required":true}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name","multiple":false},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password","multiple":false},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove project","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"rename":{"id":"rename","description":"change your username","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}
+{"version":"0.12.1","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name","multiple":false},"public":{"name":"public","type":"boolean","description":"anyone with the URL can access","helpGroup":"sharing","allowNo":false,"exclusive":["private","password"]},"private":{"name":"private","type":"boolean","description":"only invited people can access","helpGroup":"sharing","allowNo":false,"exclusive":["public","password"]},"password":{"name":"password","type":"option","char":"p","description":"anyone with the URL + password can access","helpGroup":"sharing","multiple":false,"exclusive":["public","private"]}},"args":[{"name":"filepath","description":"dbml file path"}]},"db2dbml":{"id":"db2dbml","description":"Generate DBML directly from a database","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"examples":"Postgres:\n  $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'\nMySQL:\n  $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'\nMSSQL:\n  $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'\nSnowflake:\n  $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\nBigQuery:\n  $ db2dbml bigquery /path_to_json_credential.json\n \n  Note: Your JSON credential file must contain:\n  {\n    \"project_id\": \"your-project-id\",\n    \"client_email\": \"your-client-email\",\n    \"private_key\": \"your-private-key\",\n    \"datasets\": [\"dataset_1\", \"dataset_2\", ...]\n  }\n  If \"datasets\" key is not provided or is empty, it will fetch all datasets.","flags":{"outFile":{"name":"outFile","type":"option","char":"o","description":"output file path","helpValue":"/path-to-your-file","multiple":false}},"args":[{"name":"database-type","description":"your database type (postgres, mysql, mssql, snowflake, bigquery)","required":true},{"name":"connection-string","description":"your database connection string (See below examples for more details)","required":true}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name","multiple":false},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password","multiple":false},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove project","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"rename":{"id":"rename","description":"change your username","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdocs",
-  "version": "0.11.1",
+  "version": "0.12.1",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -9,8 +9,8 @@
     "oclif/**/ansi-regex": "^3.0.1"
   },
   "dependencies": {
-    "@dbml/connector": "^3.7.2",
-    "@dbml/core": "3.7.3",
+    "@dbml/connector": "3.8.0",
+    "@dbml/core": "3.8.0",
     "@oclif/core": "1.12.1",
     "@oclif/plugin-help": "5.1.12",
     "axios": "^1.7.4",

package/src/commands/db2dbml.js

@@ -1,11 +1,11 @@
-/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable max-len */
 /* eslint-disable no-use-before-define */
 /* eslint-disable no-param-reassign */
 const { Command, Flags } = require('@oclif/core');
 const { importer } = require('@dbml/core');
 const { connector } = require('@dbml/connector');
 const ora = require('ora');
-const { SUPPORTED_DATABASE_CONNECTORS } = require('../utils/constants');
+const { SUPPORTED_DATABASE_CONNECTORS, WINDOW_FILE_PATH_REGEX, UNIX_FILE_PATH_REGEX } = require('../utils/constants');
 const { writeToConsole, writeToFileAsync } = require('../utils/output-writer');
 
 class Db2dbmlCommand extends Command {
@@ -14,12 +14,12 @@ class Db2dbmlCommand extends Command {
 
     try {
       const { flags, argv } = await this.parse(Db2dbmlCommand);
-      const { format, connection } = getConnectionOpt(argv);
+      const { databaseType, connection } = getConnectionOpt(argv);
 
       spinner.text = 'Connecting to database...';
       spinner.start();
 
-      const schemaJson = await connector.fetchSchemaJson(connection, format);
+      const schemaJson = await connector.fetchSchemaJson(connection, databaseType);
       spinner.succeed('Connecting to database... done.');
 
       spinner.start('Generating DBML ...');
@@ -50,16 +50,13 @@ Db2dbmlCommand.description = 'Generate DBML directly from a database';
 
 Db2dbmlCommand.args = [
   {
-    name: 'format',
-    description: 'your database format (postgres, mysql, mssql)',
+    name: 'database-type',
+    description: 'your database type (postgres, mysql, mssql, snowflake, bigquery)',
     required: true,
   },
   {
     name: 'connection-string',
-    description: `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;'`,
+    description: 'your database connection string (See below examples for more details)',
     required: true,
   },
 ];
@@ -72,19 +69,41 @@ Db2dbmlCommand.flags = {
   }),
 };
 
+Db2dbmlCommand.examples = [
+  'Postgres:',
+  "  $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'",
+  'MySQL:',
+  "  $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'",
+  'MSSQL:',
+  "  $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'",
+  'Snowflake:',
+  "  $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'",
+  'BigQuery:',
+  '  $ db2dbml bigquery /path_to_json_credential.json',
+  ' ',
+  '  Note: Your JSON credential file must contain:',
+  '  {',
+  '    "project_id": "your-project-id",',
+  '    "client_email": "your-client-email",',
+  '    "private_key": "your-private-key",',
+  '    "datasets": ["dataset_1", "dataset_2", ...]',
+  '  }',
+  '  If "datasets" key is not provided or is empty, it will fetch all datasets.',
+].join('\n');
+
 /**
  * @param {string[]} argv
  * @returns {{ format: string, connection: string}}
  */
 function getConnectionOpt (argv) {
   const defaultConnectionOpt = {
-    format: 'unknown',
-    connection: argv[1],
+    connection: argv[0],
+    databaseType: 'unknown',
   };
 
   const options = argv.reduce((connectionOpt, arg) => {
     if (SUPPORTED_DATABASE_CONNECTORS.includes(arg)) {
-      connectionOpt.format = arg;
+      connectionOpt.databaseType = arg;
     }
 
     // Check if the arg is a connection string using regex
@@ -95,6 +114,11 @@ function getConnectionOpt (argv) {
       connectionOpt.connection = arg;
     }
 
+    // check if the arg is a valid path to credential json file
+    if (WINDOW_FILE_PATH_REGEX.test(arg) || UNIX_FILE_PATH_REGEX.test(arg)) {
+      connectionOpt.connection = arg;
+    }
+
     return connectionOpt;
   }, defaultConnectionOpt);
 

package/src/utils/constants.js

@@ -19,7 +19,24 @@ const LOGIN_METHODS = {
   GITHUB_GOOGLE: 'GitHub/Google',
 };
 
-const SUPPORTED_DATABASE_CONNECTORS = ['postgres', 'mysql', 'mssql'];
+const SUPPORTED_DATABASE_CONNECTORS = ['postgres', 'mysql', 'mssql', 'snowflake', 'bigquery'];
+
+/**
+ * Match window path
+ * Eg:
+ * - C:\Documents\code\credential.json
+ * - C:/Documents/code/credential.json
+ */
+const WINDOW_FILE_PATH_REGEX = /^[a-zA-Z]:[\\/](?:[^<>:"/\\|?*\n\r]+[\\/])*[^<>:"/\\|?*\n\r]*$/;
+
+/**
+ * Match unix system path
+ * Eg:
+ * - /Users/dev/code/credential.json
+ * - ~/code/credential.json
+ * - ./code/credential.json
+ */
+const UNIX_FILE_PATH_REGEX = /^(\/|\.\/|~\/|\.\.\/)([^<>:"|?*\n\r]*\/?)*[^<>:"|?*\n\r]*$/;
 
 module.exports = {
   PROJECT_GENERAL_ACCESS_TYPE,
@@ -27,4 +44,6 @@ module.exports = {
   FLAG_HELP_GROUP,
   LOGIN_METHODS,
   SUPPORTED_DATABASE_CONNECTORS,
+  WINDOW_FILE_PATH_REGEX,
+  UNIX_FILE_PATH_REGEX,
 };