dbdocs 0.18.0 → 0.19.0

package/README.md

@@ -65,7 +65,7 @@ USAGE
   $ dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING] [-o <value>]
 
 ARGUMENTS
-  DATABASE-TYPE      your database type (postgres, mysql, mssql, snowflake, bigquery)
+  DATABASE-TYPE      your database type (postgres, mysql, mssql, oracle, snowflake, bigquery)
   CONNECTION-STRING  your database connection string (See below examples for more details)
 
 FLAGS
@@ -81,6 +81,8 @@ EXAMPLES
     $ 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;'
+  Oracle:
+    $ db2dbml oracle 'your_username/your_password@localhost:1521/dbname' -o database.dbml
   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:

package/oclif.manifest.json

@@ -81,7 +81,7 @@
       "aliases": [],
       "args": {
         "database-type": {
-          "description": "your database type (postgres, mysql, mssql, snowflake, bigquery)",
+          "description": "your database type (postgres, mysql, mssql, oracle, snowflake, bigquery)",
           "name": "database-type",
           "required": true
         },
@@ -92,7 +92,7 @@
         }
       },
       "description": "Generate DBML directly from a database",
-      "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  Password-based authentication:\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;'\n  Key pair authentication:\n    $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;AUTHENTICATOR=SNOWFLAKE_JWT;PRIVATE_KEY_PATH=<path_to_your_private_key.p8>;PASSPHRASE=<your_private_key_passphrase>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\n  \n  Note: If you did not use passphrase to encrypt your private key, you can leave the \"PASSPHRASE\" empty.\n  \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.",
+      "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;'\nOracle:\n  $ db2dbml oracle 'your_username/your_password@localhost:1521/dbname'\nSnowflake:\n  Password-based authentication:\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;'\n  Key pair authentication:\n    $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;AUTHENTICATOR=SNOWFLAKE_JWT;PRIVATE_KEY_PATH=<path_to_your_private_key.p8>;PASSPHRASE=<your_private_key_passphrase>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\n  \n  Note: If you did not use passphrase to encrypt your private key, you can leave the \"PASSPHRASE\" empty.\n  \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": {
           "char": "o",
@@ -379,5 +379,5 @@
       ]
     }
   },
-  "version": "0.18.0"
+  "version": "0.19.0"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "dbdocs",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
   },
   "dependencies": {
-    "@dbml/connector": "5.2.0",
-    "@dbml/core": "5.2.0",
+    "@dbml/connector": "5.3.0",
+    "@dbml/core": "5.3.0",
     "@oclif/core": "1.26.2",
     "@oclif/plugin-help": "6.2.32",
     "axios": "^1.12.0",

package/src/commands/db2dbml.js

@@ -51,7 +51,7 @@ Db2dbmlCommand.description = 'Generate DBML directly from a database';
 Db2dbmlCommand.args = [
   {
     name: 'database-type',
-    description: 'your database type (postgres, mysql, mssql, snowflake, bigquery)',
+    description: 'your database type (postgres, mysql, mssql, oracle, snowflake, bigquery)',
     required: true,
   },
   {
@@ -76,6 +76,8 @@ Db2dbmlCommand.examples = [
   "  $ 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;'",
+  'Oracle:',
+  "  $ db2dbml oracle 'your_username/your_password@localhost:1521/dbname'",
   'Snowflake:',
   '  Password-based authentication:',
   "    $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'",
@@ -113,10 +115,11 @@ function getConnectionOpt (argv) {
     }
 
     // Check if the arg is a connection string using regex
-    const connectionStringRegex = /^.*[:;]/;
+    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;
+      // Example (oracle): username/password@[//]host[:port][/service_name]
       connectionOpt.connection = arg;
     }
 

package/src/utils/constants.js

@@ -19,7 +19,7 @@ const LOGIN_METHODS = {
   GITHUB_GOOGLE: 'GitHub/Google',
 };
 
-const SUPPORTED_DATABASE_CONNECTORS = ['postgres', 'mysql', 'mssql', 'snowflake', 'bigquery'];
+const SUPPORTED_DATABASE_CONNECTORS = ['postgres', 'mysql', 'mssql', 'oracle', 'snowflake', 'bigquery'];
 
 /**
  * Match window path