Databricks SQL Driver for NodeJS (Beta)

!http://www.apache.org/licenses/LICENSE-2.0.txt

Description

The Databricks SQL Driver for NodeJS is a Javascript driver for applications that connect to Databricks clusters and SQL warehouses. This project is a fork of Hive Driver which connects via Thrift API.

NOTE: This Driver is Beta.

Documentation

For detailed documentation and usage examples, read the Getting Started guide.

Requirements

- Node.js 14 or newer

Installation

``bash
npm i @databricks/sql
`

Usage

examples/usage.js

`javascript
const { DBSQLClient } = require('@databricks/sql');

const client = new DBSQLClient();

client
.connect({
host: '**.databricks.com',
path: '/sql/1.0/endpoints/',
token: 'dapi**',
})
.then(async (client) => {
const session = await client.openSession();

const queryOperation = await session.executeStatement('SELECT "Hello, World!"', { runAsync: true });
const result = await queryOperation.fetchAll();
await queryOperation.close();

console.table(result);

await session.close();
await client.close();
})
.catch((error) => {
console.log(error);
});
`

Run Tests

$3

You can run all unit tests, or specify a specific test to run:

`bash
npm test
npm test
`

$3

Before running end-to-end tests, create a file named tests/e2e/utils/config.local.js and set the Databricks SQL connection info:

`javascript
{
host: '*.databricks.com',
path: '/sql/1.0/endpoints/*',
token: 'dapi*',
database: ['catalog', 'database'],
}
`

Then run

`bash
npm run e2e
npm run e2e
``

Contributing

See CONTRIBUTING.md

Issues

If you find any issues, feel free to create an issue or send a pull request directly.

License

Apache License 2.0