API Reference

SpiceClient(params)

The top-level object that connects to Spice.ai

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

• params.http_url (string, optional):

• params.flight_url (string, optional): URL of the endpoint to use (default: localhost:50051, using local Spice Runtime)

Default connection to local Spice Runtime:

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

const spiceClient = new Spiceclient();

Connect to Spice.AI Cloud Platform:

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

const spiceClient = new Spiceclient({
    api_key: 'API_KEY',
    http_url: 'https://data.spiceai.io',
    flight_url: 'flight.spiceai.io:443'
});

Or using shorthand:

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

const spiceClient = new SpiceClient('API_KEY');

SpiceClient Methods

query(queryText: string, onData: (partialData: Table) => void) => Table

• queryText: (string, required): The SQL query to execute

• onData: (callback, optional): The callback function that is used for handling streaming data.

query returns an Apache Arrow Table.

To get the data in JSON format, iterate over each row by calling toArray() on the table and call toJSON() on each row.

const table = await spiceClient.query("SELECT * from tpch.lineitem LIMIT 10")
table.toArray().forEach((row) => {
  console.log(row.toJSON());
});

Get all of the elements for a column by calling getChild(name: string) and then calling toJSON() on the result.

const table = await client.query(
  'SELECT sum(l_extendedprice) as sum_extendedprice FROM tpch.lineitem'
);

let sumExtendedPrice = tableResult.getChild("sum_extendedprice");
console.log(sumExtendedPrice?.toJSON())