@luminati-io/snowflake-sdk

NodeJS Driver for Snowflake

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

Install
======================================================================

Run npm i snowflake-sdk in your existing NodeJs project.

Docs
======================================================================

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

Test
======================================================================

Prepare for tests
----------------------------------------------------------------------

Specify env variables:

``
export SNOWFLAKE_TEST_USER=
export SNOWFLAKE_TEST_PASSWORD=
export SNOWFLAKE_TEST_ACCOUNT=
export SNOWFLAKE_TEST_WAREHOUSE=
export SNOWFLAKE_TEST_DATABASE=
export SNOWFLAKE_TEST_SCHEMA=
export SNOWFLAKE_TEST_PROTOCOL=
export SNOWFLAKE_TEST_HOST=
export SNOWFLAKE_TEST_PORT=
`

Run hang webserver:
`
python3 ci/container/hang_webserver.py 12345 &
`

Run tests
----------------------------------------------------------------------

Run unit tests:
`
npm test
`
or
`
npm run test:unit
`

To run single test file use test:single script, e.g. run tests in test/unit/snowflake_test.js only:

`
npm run test:single -- test/unit/snowflake_test.js
`

Run integration tests:
`
npm run test:integration
`

Manual test
----------------------------------------------------------------------

Specify env variables:

`
export RUN_MANUAL_TESTS_ONLY=true
export SNOWFLAKE_TEST_OKTA_USER=
export SNOWFLAKE_TEST_OKTA_PASS=
export SNOWFLAKE_TEST_OKTA_AUTH=
export SNOWFLAKE_TEST_OAUTH_TOKEN=
export SNOWFLAKE_TEST_BROWSER_USER=
`

Run manual connection test for different authenticators
`
npm run test:manual
`

Getting the code coverage
----------------------------------------------------------------------

Run tests and show code coverage report
`
npm run test:ci:coverage
`

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
----------------------------------------------------------------------

Check formatting on all files:

`
npm run lint:check:all
`

Check formatting of single file or directory e.g. test/unit/snowflake_test.js:

`
npm run lint:check -- test/unit/snowflake_test.js
`

Fix potentially fixable formatting errors and warnings of single file or directory e.g. test/unit/logger:

`
npm run lint:fix -- test/unit/logger
``