Package ai.spice

Class SpiceClient

java.lang.Object

ai.spice.SpiceClient

public class SpiceClient
extends Object

Client to execute SQL queries against Spice.ai Cloud and Spice.ai OSS

Constructor Summary

Constructors

Constructor	Description
SpiceClient(String appId, String apiKey, URI flightAddress)	Constructs a new SpiceClient instance with the specified parameters

Method Summary

Modifier and Type	Method	Description
static SpiceClientBuilder	builder()	Returns a new instance of SpiceClientBuilder
org.apache.arrow.flight.FlightStream	query(String sql)	Executes a sql query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SpiceClient

public SpiceClient(String appId,
 String apiKey,
 URI flightAddress)

Constructs a new SpiceClient instance with the specified parameters

Parameters:

appId - the application ID used to identify the client application

apiKey - the API key used for authentication with Spice.ai services

flightAddress - the URI of the flight address for connecting to Spice.ai services

Method Details

builder

public static SpiceClientBuilder builder()
                                  throws URISyntaxException

Returns a new instance of SpiceClientBuilder

Returns:

A new SpiceClientBuilder instance

Throws:

URISyntaxException - if there is an error in constructing the URI

query

public org.apache.arrow.flight.FlightStream query(String sql)

Executes a sql query

Parameters:

sql - the SQL query to execute

Returns:

a FlightStream with the query results