Skip to main content

Getting Started

Installation​

Install using npm, yarn, or pnpm:

# this version is still in beta
npm i snowflake-promise@beta

The Snowflake SDK will be automatically installed as a peerDependency, if it is not already installed.

The Basics​

Promisify your Connection​

This library’s main function is promisifyConnection which augments a Snowflake Connection to allow using Promises.

Here’s how to use promisifyConnection:

import { promisifyConnection } from 'snowflake-promise';

const connection = promisifyConnection(
  snowflake.createConnection({
    account: account,
    username: user,
    password: password,
    application: application,
  }),
);

Pass any Snowflake Connection object to promisifyConnection to receive an augmented PromisifiedConnection object that supports Promises. Then you can use methods like connect and execute with Promises:

// The same methods you would have called on the original Connection
// object, but now they return Promises and don’t need callbacks.

await connection.connect();

const { statement, resultsPromise } = connection.execute({
    sqlText: 'SELECT * FROM YOUR_TABLE'
});

const results = await resultsPromise;
console.log(results);

Callbacks are still supported​

When calling promisified functions like connect or execute, if you pass a callback, the function will be invoked in callback mode, and will not return a Promise. In other words, existing code that uses callbacks will continue to work exactly as before.

Promise methods return a resultsPromise object​

tip

For more details on the Promisified execute method, including why it doesn't directly return query results, see the API documentation.

When using Promises, the execute method returns an object with a statement property and a resultsPromise property. Its interface looks like this:

{
  statement: PromisifiedStatement,
  resultsPromise: Promise<RowType[] | undefined>
}

You should await the resultsPromise to get the query results:

// The execute method returns an object with a resultsPromise property
const { resultsPromise } = await connection.execute({
    sqlText: 'SELECT * FROM YOUR_TABLE'
});

// Await the resultsPromise to get the query results
const results = await resultsPromise;
console.log(results);

Which methods are promisified?​

In addition to connect and execute, any method that previously required a callback will be promisified.

The full list of methods that are promisified is found in the API Reference.