Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.firebolt.io/llms.txt

Use this file to discover all available pages before exploring further.

You can use the Node.js SDK to work with Firebolt Core.

​
Prerequisites

  • Node.js 20 and up
  • Firebolt Node.js SDK version 1.14.3 or higher
  • An endpoint running Firebolt Core

​
Installation

npm install firebolt-sdk@^1.14.3

​
Connection

const { Firebolt, FireboltCore } = require('firebolt-sdk');

// Initialize the Firebolt client
const firebolt = Firebolt();

// Connect to Firebolt Core
const connection = await firebolt.connect({
  auth: FireboltCore(),
  engineEndpoint: 'http://localhost:3473',
  database: 'firebolt'
});

// Execute a query
const statement = await connection.execute('SELECT 1');
const { data, meta } = await statement.fetchResult();

​
Further reading