Query datasets hosted in the Spice.ai Cloud Platform. Discover available public datasets on Spicerack.
Create a Spice.ai Cloud Platform account and login with the CLI using spice login.
Example:
This configuration would load the following tables:
fromThe from field specifies which organization and application to load tables from. The format is:
organization: The Spice.ai organization that owns the application.application: The specific application to load tables from.catalog_name (optional): A specific catalog within the application. Defaults to spice if not specified.For example:
This will create tables like:
If the remote application has tables in custom_catalog like:
They will be available locally as:
nameThe name field defines what catalog name the tables will be available under in the local Spice instance. For example, with the following configuration:
Then tables that exist in the remote application as:
Will be available locally as:
Queries are run against the marketplace catalog, like SELECT * FROM marketplace.schema1.table1.
includeUse the include field to specify which tables to include from the catalog. The include field supports glob patterns to match multiple tables:
schema_name.* - Include all tables from a specific schema*.table_name - Include all tables with a specific name from any schemaschema_name.table_name - Include a specific table from a schemaschema_name.table_prefix* - Include all tables in a schema that start with a prefixMultiple include patterns can be specified and are OR'ed together. For example:
params| Parameter Name | Description |
|---|---|
spiceai_api_key | API key from the Spice.ai Cloud Platform. Takes precedence over spiceai_token. |
spiceai_token | Legacy alias for spiceai_api_key. Used only if spiceai_api_key is not set. |
| Parameter Name | Description |
|---|---|
spiceai_region | The Spice Cloud region to connect to (e.g. us-east-1). Required unless spiceai_http_endpoint is set. To list available regions, run spice cloud regions. |
These parameters override the default endpoints derived from spiceai_region. They are typically only needed for development or custom deployments.
| Parameter Name | Description |
|---|---|
spiceai_http_endpoint | Custom HTTP endpoint for the Spice Cloud catalog API (Iceberg REST catalog compatible). If set, spiceai_region is not required and region validation is skipped. |
spiceai_endpoint | Custom Arrow Flight endpoint for query execution. Takes precedence over spiceai_flight_endpoint. |
spiceai_flight_endpoint | Legacy alias for spiceai_endpoint. Used only if spiceai_endpoint is not set. |