From 6234d3ebe7c28d4b3fe0688dc5f45e2746a712cc Mon Sep 17 00:00:00 2001 From: Phillip LeBlanc Date: Wed, 11 Dec 2024 16:44:11 +0900 Subject: [PATCH] Update the SpiceAI data connector docs --- .../components/data-connectors/spiceai.md | 22 ++++++------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/spiceaidocs/docs/components/data-connectors/spiceai.md b/spiceaidocs/docs/components/data-connectors/spiceai.md index 8e9b1cc0..d62eb3a8 100644 --- a/spiceaidocs/docs/components/data-connectors/spiceai.md +++ b/spiceaidocs/docs/components/data-connectors/spiceai.md @@ -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///datasets/`. ## Example @@ -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 @@ -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`. - -:::