Skip to main content

Spice.ai Data Connector

The Spice.ai Data Connector enables federated SQL query across datasets in the Spice.ai Cloud Platform. Access to these datasets requires a free Spice.ai account.

Configuration​

Secrets​

Secrets will be written to a .env file by using the spice login command and logging in with an active Spice AI account. Learn more about the Env Secret Store.

  • api_key: A Spice.ai API key.
  • token: An active personal access token that is configured when logging in to spice via spice login.

Parameters​

from​

The Spice.ai Cloud Platform dataset URI. To query a dataset in a public Spice.ai App, use the format spice.ai/<org>/<app>/datasets/<dataset_name>.

params​

The Spice.ai Cloud Platform data connector can be configured by providing the following params. Use the secret replacement syntax to load the secret from a secret store, e.g. ${secrets:SPICEAI_API_KEY}.

Parameter NameDescription
spiceai_api_keyThe Spice.ai Cloud Platform API key to connect with.
endpointThe Flight endpoint for Spice.ai Cloud Platform to connect to.
http_endpointThe HTTP endpoint for Spice.ai Cloud Platform to connect to.

Example​

- from: spice.ai/spiceai/quickstart/datasets/taxi_trips
name: taxi_trips
- from: spice.ai/spiceai/tpch/datasets/customer
name: tpch.customer

Full Configuration Example​

- from: spice.ai/spiceai/tpch/datasets/customer
name: tpch.customer
params:
spiceai_api_key: ${secrets:spiceai_api_key}
acceleration:
enabled: true

Cookbook​