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.

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

Add spiceai data connector docs #157

Merged
merged 3 commits into from
Mar 27, 2024
Merged
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions spiceaidocs/docs/data-connectors/spiceai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: 'Spice.ai Data Connector'
sidebar_label: 'Spice.ai Data Connector'
description: 'Spice.ai Data Connector Documentation'
---

The [Spice.ai](https://spice.ai/) Data Connector enables federated SQL query across datasets in the [Spice.ai Cloud Platform](https://docs.spice.ai/building-blocks/datasets). Access to these datasets require a free [Spice.ai account](https://spice.ai/login).

## Configuration
### Secrets
Secrets will be automatically conifgured by using the `spice login` command and loggin in with an active Spice AI account.

- `key`: A Spice.ai API key.
- `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`

## Example

```yaml
- from: spice.ai/eth.recent_blocks
name: eth_recent_blocks
```

## Full Configuration Example
```yaml
- from: spice.ai/eth.recent_blocks
name: eth_recent_blocks
acceleration:
enabled: true
refresh_mode: append
```

## 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`.