Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.77 KB

README.md

File metadata and controls

93 lines (64 loc) · 2.77 KB
icon
node

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 Apache 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

Installation

{% tabs %} {% tab title="npm" %}

npm install @spiceai/spice --save

{% endtab %}

{% tab title="yarn" %}

yarn add @spiceai/spice

{% endtab %} {% endtabs %}

Usage

Import SpiceClient and instantiate a new instance with an API Key.

You can then submit queries using the query function.

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

const spiceClient = new SpiceClient("API_KEY");
const table = await spiceClient.query(
  'SELECT number, "timestamp", gas_used FROM eth.recent_blocks LIMIT 10'
);
console.table(table.toArray());

SpiceClient has the following arguments:

  • apiKey (string, required): API key to authenticate with the endpoint.
  • url (string, optional): URL of the endpoint to use (default: flight.spiceai.io:443)

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({
  //   http_url: 'http://my_spice_http_host',
  //   flight_url: 'my_spice_flight_host',
  // });

  const table = await spiceClient.query(
    '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.