Skip to content

Commit

Permalink
Update the SpiceAI data connector docs (#673)
Browse files Browse the repository at this point in the history
  • Loading branch information
phillipleblanc authored Dec 15, 2024
1 parent 92f7159 commit 99fa9cd
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions spiceaidocs/docs/components/data-connectors/spiceai.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ The [Spice.ai](https://spice.ai/) Data Connector enables federated SQL query acr
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](/components/secret-stores/env).

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

### Parameters

- `from`: The Spice.ai dataset ID. For instance `spice.ai/eth.recent_blocks` or `spice.ai/eth.recent_traces`
- `from`: The Spice.ai dataset ID. For instance `spice.ai/eth.recent_blocks` or `spice.ai/eth.recent_traces`. To query a dataset in a shared Spicepod, use the format `spice.ai/<org>/<app>/datasets/<dataset_id>`.

## Example

Expand All @@ -27,6 +27,11 @@ Secrets will be written to a `.env` file by using the `spice login` command and
name: eth_recent_blocks
```
```yaml
- from: spice.ai/spiceai/tpch/datasets/customer
name: tpch.customer
```
## Full Configuration Example
```yaml
Expand All @@ -36,17 +41,4 @@ Secrets will be written to a `.env` file by using the `spice login` command and
spiceai_api_key: ${secrets:spiceai_api_key}
acceleration:
enabled: true
refresh_mode: append
```
:::warning[Limitations]
`refresh_mode: append` is supported for the following datasets:

- eth.recent_blocks
- eth.recent_transactions
- eth.recent_traces

All other datasets need to be configured with `refresh_mode: full`.

:::

0 comments on commit 99fa9cd

Please sign in to comment.