Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the SpiceAI data connector docs #673

Merged
merged 1 commit into from
Dec 15, 2024
Merged

Update the SpiceAI data connector docs #673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 7 additions & 15 deletions spiceaidocs/docs/components/data-connectors/spiceai.md
View file
Open in desktop
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`.

:::
Loading