@dbml/connector 3.10.2 → 3.11.0

package/dist/connectors/snowflakeConnector.js

@@ -65,26 +65,43 @@ const connectToSnowflake = async (config) => {
         logLevel,
         additionalLogToConsole: isDebugMode,
     });
+    // https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-options#authentication-options
+    let authConfig = {};
+    switch (config.AUTHENTICATOR) {
+        case 'SNOWFLAKE_JWT':
+            // https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-authenticate#label-nodejs-key-pair-authentication
+            // Support private key file
+            authConfig = {
+                privateKeyPath: config.PRIVATE_KEY_PATH,
+                privateKeyPass: config.PASSPHRASE,
+            };
+            break;
+        case 'SNOWFLAKE':
+        case undefined:
+            authConfig = {
+                password: config.PWD,
+            };
+            break;
+        default:
+            throw new Error('Unsupported authenticator');
+    }
     // "SERVER=myaccount.snowflakecomputing.com;UID=myusername;PWD=mypassword;DATABASE=mydatabase;WAREHOUSE=mywarehouse;ROLE=myrole";
-    const connection = snowflake_sdk_1.default.createConnection({
+    const connectionOptions = {
+        authenticator: config.AUTHENTICATOR,
         account: config.SERVER,
         username: config.UID,
-        password: config.PWD,
         database: config.DATABASE,
         warehouse: config.WAREHOUSE,
         sfRetryMaxLoginRetries: 3,
         timeout: 10000,
-    });
-    try {
-        // Connect to Snowflake
-        await connect(connection);
-        // Execute the query
-        await executeQuery(connection, 'SELECT CURRENT_VERSION();');
-        return connection;
-    }
-    catch (err) {
-        throw err;
-    }
+        ...authConfig,
+    };
+    const connection = snowflake_sdk_1.default.createConnection(connectionOptions);
+    // Connect to Snowflake
+    await connect(connection);
+    // Execute the query
+    await executeQuery(connection, 'SELECT CURRENT_VERSION();');
+    return connection;
 };
 const convertQueryBoolean = (val) => val === 'YES';
 const getFieldType = (data_type, character_maximum_length, numeric_precision, numeric_scale) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbml/connector",
-  "version": "3.10.2",
+  "version": "3.11.0",
   "description": "This package was created to fetch the schema JSON from many kind of databases.",
   "author": "huy.phung.sw@gmail.com",
   "license": "MIT",
@@ -35,10 +35,10 @@
     "mssql": "^11.0.1",
     "mysql2": "^3.11.0",
     "pg": "^8.12.0",
-    "snowflake-sdk": "^1.12.0"
+    "snowflake-sdk": "^2.0.3"
   },
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "59a06de19f675bf9af31bdb9801d8e022ef87529"
+  "gitHead": "eb05b8cd85092e62152c6a994d9c0568a1d898de"
 }

package/src/connectors/snowflakeConnector.ts

@@ -7,7 +7,8 @@
 // Snowflake does not support indexes for standard tables.
 //
 
-import snowflake, { Connection, LogLevel } from 'snowflake-sdk';
+import snowflake from 'snowflake-sdk';
+import type { Connection, LogLevel, ConnectionOptions } from 'snowflake-sdk';
 import { parseSchema } from '../utils/parseSchema';
 import {
   DatabaseSchema,
@@ -93,30 +94,51 @@ const connectToSnowflake = async (config: Record<string, string>): Promise<Conne
     additionalLogToConsole: isDebugMode,
   });
 
+  // https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-options#authentication-options
+  let authConfig = {};
+  switch (config.AUTHENTICATOR) {
+    case 'SNOWFLAKE_JWT':
+      // https://docs.snowflake.com/en/developer-guide/node-js/nodejs-driver-authenticate#label-nodejs-key-pair-authentication
+      // Support private key file
+      authConfig = {
+        privateKeyPath: config.PRIVATE_KEY_PATH,
+        privateKeyPass: config.PASSPHRASE,
+      };
+      break;
+
+    case 'SNOWFLAKE':
+    case undefined:
+      authConfig = {
+        password: config.PWD,
+      };
+      break;
+
+    default:
+      throw new Error('Unsupported authenticator');
+  }
+
   // "SERVER=myaccount.snowflakecomputing.com;UID=myusername;PWD=mypassword;DATABASE=mydatabase;WAREHOUSE=mywarehouse;ROLE=myrole";
-  const connection = snowflake.createConnection({
+  const connectionOptions: ConnectionOptions = {
+    authenticator: config.AUTHENTICATOR,
     account: config.SERVER,
     username: config.UID,
-    password: config.PWD,
     database: config.DATABASE,
     warehouse: config.WAREHOUSE,
     sfRetryMaxLoginRetries: 3,
     timeout: 10000,
-  });
+    ...authConfig,
+  };
 
-  try {
-    // Connect to Snowflake
-    await connect(connection);
+  const connection = snowflake.createConnection(connectionOptions);
 
-    // Execute the query
-    await executeQuery(connection, 'SELECT CURRENT_VERSION();');
+  // Connect to Snowflake
+  await connect(connection);
 
-    return connection;
-  } catch (err) {
-    throw err;
-  }
-}
+  // Execute the query
+  await executeQuery(connection, 'SELECT CURRENT_VERSION();');
 
+  return connection;
+};
 
 const convertQueryBoolean = (val: string | null) => val === 'YES';