Node.js SDK

The Node.js SDK spice.js is the easiest way to use and query Spice.ai with Node.js.

It uses Apache Arrow Flight to efficiently stream data to the client and Apache Arrow Records as data frames which are then easily converted to JavaScript objects/arrays or JSON.

Requirements

• Node.js 20+

Installation

npm

npm install @spiceai/spice@latest --save

yarn

Usage

Import SpiceClient and instantiate a new instance with your configuration.

You can then submit queries using the sql method.

import { SpiceClient } from "@spiceai/spice";

const spiceClient = new SpiceClient({
  apiKey: 'API_KEY',
  httpUrl: 'https://data.spiceai.io',
  flightUrl: 'flight.spiceai.io:443',
});
const table = await spiceClient.sql('SHOW TABLES;');
console.table(table.toArray());

Or using the shorthand with just an API key:

const spiceClient = new SpiceClient('API_KEY');

SpiceClient accepts a config object or a string API key:

• apiKey (string, optional): API key to authenticate with the endpoint.

• flightUrl (string, optional): URL of the Flight endpoint (default: localhost:50051).

• httpUrl (string, optional): URL of the HTTP endpoint (default: http://localhost:8090).

• logging (boolean, optional): Enable or disable logging output (default: true).

sqlJson(query: string) - Execute SQL queries with JSON results

The sqlJson() method executes SQL queries and returns results in a JSON format with schema information.

const result = await spiceClient.sqlJson('SELECT name, age FROM users LIMIT 5');

console.log(`Returned ${result.row_count} rows`);
console.log('Schema:', result.schema);
console.log('Data:', result.data);
console.log(`Query took ${result.execution_time_ms}ms`);

// Access individual rows
result.data.forEach((row) => {
  console.log(`${row.name} is ${row.age} years old`);
});

The response includes:

• row_count: Number of rows returned

• schema: Schema information with field names and types

• data: Array of row objects

• execution_time_ms: Query execution time in milliseconds

Usage with local Spice runtime

Follow the quickstart guide to install and run spice locally.

import { SpiceClient } from '@spiceai/spice';

const main = async () => {
  // uses connection to local runtime by default
  const spiceClient = new SpiceClient();

  // or use custom connection params:
  // const spiceClient = new SpiceClient({
  //   httpUrl: 'http://my_spice_http_host',
  //   flightUrl: 'my_spice_flight_host',
  // });

  const table = await spiceClient.sql(
    'SELECT trip_distance, total_amount FROM taxi_trips ORDER BY trip_distance DESC LIMIT 10;'
  );
  console.table(table.toArray());
};

main();

Check Spice OSS documentation to learn more.

Connection retry

From version 1.0.1 the SpiceClient implements connection retry mechanism (3 attempts by default). The number of attempts can be configured via setMaxRetries:

const spiceClient = new SpiceClient('API_KEY');
spiceClient.setMaxRetries(5); // Setting to 0 will disable retries

Retries are performed for connection and system internal errors. It is the SDK user's responsibility to properly handle other errors, for example RESOURCE_EXHAUSTED (HTTP 429).

Contributing

Contribute to or file an issue with the spice.js library at: https://github.com/spiceai/spice.js.