danielkitchener / snowflake-connector-nodejs

NodeJS driver

---

NodeJS Driver for Snowflake

---

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 <https://docs.snowflake.net/manuals/user-guide/nodejs-driver.html>_

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"
},

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