Skip to content

docs: Update params, release spice.ai data connector #864

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

Merged
merged 2 commits into from
Feb 15, 2025
+11 −1
Merged

docs: Update params, release spice.ai data connector #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c754b2
docs: Update params, release spice.ai data connector
peasee Feb 11, 2025
a17fab4
Merge branch 'trunk' into docs/release-spiceai-data-connector
peasee Feb 15, 2025
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
2 changes: 1 addition & 1 deletion website/docs/components/data-connectors/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ Supported Data Connectors include:
| `mysql` | MySQL | Stable | |
| `delta_lake` | Delta Lake | Stable | Delta Lake |
| `graphql` | GraphQL | Release Candidate | JSON |
| `spice.ai` | [Spice.ai][spiceai] | Release Candidate | Arrow Flight |
| `databricks (mode: spark_connect)` | [Databricks][databricks] | Beta | [Spark Connect][spark] |
| `flightsql` | FlightSQL | Beta | Arrow Flight SQL |
| `mssql` | Microsoft SQL Server | Beta | Tabular Data Stream (TDS) |
| `odbc` | ODBC | Beta | ODBC |
| `snowflake` | Snowflake | Beta | Arrow |
| `spark` | Spark | Beta | [Spark Connect][spark] |
| `spice.ai` | [Spice.ai][spiceai] | Beta | Arrow Flight |
| `iceberg` | [Apache Iceberg][iceberg] | Beta | Parquet |
| `abfs` | Azure BlobFS | Alpha | Parquet, CSV |
| `clickhouse` | Clickhouse | Alpha | |
Expand Down
10 changes: 10 additions & 0 deletions website/docs/components/data-connectors/spiceai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ Secrets will be written to a `.env` file by using the `spice login` command and

The Spice.ai Cloud Platform dataset URI. To query a dataset in a public Spice.ai App, use the format `spice.ai/<org>/<app>/datasets/<dataset_name>`.

### `params`

The Spice.ai Cloud Platform data connector can be configured by providing the following `params`. Use the [secret replacement syntax](../secret-stores/index.md) to load the secret from a secret store, e.g. `${secrets:SPICEAI_API_KEY}`.

| Parameter Name | Description |
| ----------------- | -------------------------------------------------------------- |
| `spiceai_api_key` | The Spice.ai Cloud Platform API key to connect with. |
| `endpoint` | The Flight endpoint for Spice.ai Cloud Platform to connect to. |
| `http_endpoint` | The HTTP endpoint for Spice.ai Cloud Platform to connect to. |

## Example

```yaml
Expand Down
Loading