spiceai/docs

spiceai/docs/README.md

title: 'JavaScript SDK' description: 'Connect to Spice using the JavaScript SDK' pagination_prev: null pagination_next: null tags:

sdk
javascript
nodejs

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

JavaScript SDK for Spice.ai

github.com/spiceai/spice.js (opens in a new tab)

:::note[Parameterized Queries] Parameterized queries are supported via the sql() method with a parameters option. See Parameterized Queries (opens in a new tab) for more information. :::

Install

Connect to spice runtime

Create a SpiceClient using default configuration:

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

const main = async () => {
  const spiceClient = new SpiceClient();

  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();

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

const main = async () => {
  const spiceClient = new SpiceClient();

  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();

Or pass custom flight address:

const spiceClient = new SpiceClient({
  flightUrl: 'my_remote_spice_instance:50051'
});

const spiceClient = new SpiceClient({
  flightUrl: 'my_remote_spice_instance:50051'
});