Package ai.spice

Class SpiceClient

java.lang.Object

ai.spice.SpiceClient

All Implemented Interfaces:

AutoCloseable

public class SpiceClient
extends Object
implements AutoCloseable

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, URI httpAddress, int maxRetries)	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
void	close()
org.apache.arrow.flight.FlightStream	query(String sql)	Executes a sql query
void	refresh(String dataset)

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,
 URI httpAddress,
 int maxRetries)

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

httpAddress - the URI of the Spice.ai runtime HTTP address

maxRetries - the maximum number of connection retries for the client

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)
                                           throws ExecutionException

Executes a sql query

Parameters:

sql - the SQL query to execute

Returns:

a FlightStream with the query results

Throws:

ExecutionException - if there is an error executing the query

refresh

public void refresh(String dataset)
             throws ExecutionException

Throws:

ExecutionException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception