Skip to content

Commit 6d87ac8

Browse files
committed
improved spice.ai catalog docs
1 parent 9dac484 commit 6d87ac8

1 file changed

Lines changed: 26 additions & 8 deletions

File tree

website/docs/components/catalogs/spiceai.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ catalogs:
2020
- from: spice.ai:demo-org/tpch # Load tables from the `demo-org` organization's `tpch` app
2121
name: marketplace # Tables will be available in the "marketplace" catalog
2222
params:
23-
spiceai_api_key: ${secrets:SPICEAI_API_KEY} # Spice.ai API key to login to the organization and app
23+
spiceai_api_key: ${secrets:SPICEAI_API_KEY} # Spice.ai API key
24+
spiceai_region: us-east-1 # Required: Spice Cloud region
2425
include:
2526
- "tpch.part*" # include only the tables from the "tpch" schema and that start with "part"
2627
- "tpch.supplier" # also include the "supplier" table
@@ -44,12 +45,12 @@ sql> show tables;
4445
The `from` field specifies which organization and application to load tables from. The format is:
4546

4647
```shell
47-
spice.ai/[organization]/[application][/catalog_name]
48+
spice.ai/<organization>/<application>[/<catalog_name>]
4849
```
4950

50-
- `organization`: The Spice.ai organization that owns the application
51-
- `application`: The specific application to load tables from
52-
- `catalog_name`: (optional): A specific catalog within the application. If not specified, the application's default catalog is used
51+
- `organization`: The Spice.ai organization that owns the application.
52+
- `application`: The specific application to load tables from.
53+
- `catalog_name` (optional): A specific catalog within the application. Defaults to `spice` if not specified.
5354

5455
For example:
5556

@@ -161,11 +162,28 @@ include:
161162

162163
## `params`
163164

164-
The following parameters are supported for configuring the connection to the Spice Cloud catalog/tables:
165+
### Authentication
165166

166-
| Parameter Name | Definition |
167+
| Parameter Name | Description |
167168
|---------------|------------|
168-
| `spiceai_api_key` | Authorization API key from the Spice.ai Cloud Platform, used to login to the specified organization and app. |
169+
| `spiceai_api_key` | API key from the Spice.ai Cloud Platform. Takes precedence over `spiceai_token`. |
170+
| `spiceai_token` | Legacy alias for `spiceai_api_key`. Used only if `spiceai_api_key` is not set. |
171+
172+
### Region
173+
174+
| Parameter Name | Description |
175+
|---------------|------------|
176+
| `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`. |
177+
178+
### Endpoint Overrides
179+
180+
These parameters override the default endpoints derived from `spiceai_region`. They are typically only needed for development or custom deployments.
181+
182+
| Parameter Name | Description |
183+
|---------------|------------|
184+
| `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. |
185+
| `spiceai_endpoint` | Custom Arrow Flight endpoint for query execution. Takes precedence over `spiceai_flight_endpoint`. |
186+
| `spiceai_flight_endpoint` | Legacy alias for `spiceai_endpoint`. Used only if `spiceai_endpoint` is not set. |
169187

170188
## Cookbook
171189

0 commit comments

Comments
 (0)