---

NodeJS Driver for Snowflake

---

❗	For production-affecting issues related to the driver, please create a case with Snowflake Support.

Install

Include snowflake-sdk in dependencies section in package.json

{
  "name": "",
  "version": "",
  "dependencies": {
    "...": "...",        
    "snowflake-sdk": "^1.1.0",
    "...": "..."
  }
}

And run the npm install

Docs

For detailed documentation and basic usage examples, please see the documentation at NodeJS Driver for Snowflake.

Test

Prepare for Test

Set the Snowflake connection info in parameters.json and place it in $HOME:

{
  "testconnection": {
    "SNOWFLAKE_TEST_USER":      "<your_user>",
    "SNOWFLAKE_TEST_PASSWORD":  "<your_password>",
    "SNOWFLAKE_TEST_ACCOUNT":   "<your_account>",
    "SNOWFLAKE_TEST_WAREHOUSE": "<your_warehouse>",
    "SNOWFLAKE_TEST_DATABASE":  "<your_database>",
    "SNOWFLAKE_TEST_SCHEMA":    "<your_schema>",
    "SNOWFLAKE_TEST_ROLE":      "<your_role>"
  }
}

Run Tests

npm test

To specify which test to run, change the "test" value on "package.json":

"scripts": {
  "test": "mocha test/unit/snowflake_test.js"
},

To run all unit test:

"scripts": {
  "test": "mocha test/unit/**/*.js"
},

Getting the Code Coverage

1. Go to nodejs project directory

cd snowflake-connector-nodejs

2. Install the node connector

npm install .

3. Install the nyc module which displays the code coverage

npm install nyc

4. Edit the package.json file and replace the specified test with the one below:

"scripts": {
  "test": "nyc mocha test/**/*.js"
},

5. Using git bash, run the "npm test" command and include the connection parameters in the same line:

SNOWFLAKE_TEST_USER="user" SNOWFLAKE_TEST_PASSWORD="password" SNOWFLAKE_TEST_ACCOUNT="account" SNOWFLAKE_TEST_WAREHOUSE="warehouse" SNOWFLAKE_TEST_DATABASE="db" SNOWFLAKE_TEST_SCHEMA="schema" npm test

6. The code coverage results will be displayed in the console when the test finishes executing

Note: git bash is the console used for installing the node connector, the nyc module, and running "npm test"

Package

The npm package can be built by the command:

npm pack

Note it is not required to build a package to run tests blow.

Development

Reformat Source code

Use WebStorm code style file to format the source code.

format.sh -mask "*.js" -settings $(pwd)/webstorm-codestyle.xml -R $(pwd)/lib/ -R $(pwd)/test -R $(pwd)/system_test