-
Couldn't load subscription status.
- Fork 18
Update dataset spicepod reference #102
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
Merged
+138
−530
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| --- | ||
| type: docs | ||
| title: "Datasets" | ||
| linkTitle: "Datasets" | ||
| description: 'Datasets YAML reference' | ||
| weight: 80 | ||
| --- | ||
|
|
||
| A Spicepod can contain one or more datasets referenced by relative path, or defined inline. | ||
|
|
||
| # `datasets` | ||
|
|
||
| Inline example: | ||
|
|
||
| `spicepod.yaml` | ||
| ```yaml | ||
| datasets: | ||
| - from: spice.ai/eth/beacon/eigenlayer | ||
| name: strategy_manager_deposits | ||
| params: | ||
| app: goerli-app | ||
| acceleration: | ||
| enabled: true | ||
| mode: inmemory # / file | ||
| engine: arrow # / duckdb | ||
| refresh_interval: 1h | ||
| refresh_mode: full / append # update / incremental | ||
| retention: 30m | ||
| ``` | ||
|
|
||
| `spicepod.yaml` | ||
| ```yaml | ||
| datasets: | ||
| - from: databricks.com/spiceai/datasets | ||
| name: uniswap_eth_usd | ||
| params: | ||
| environment: prod | ||
| acceleration: | ||
| enabled: true | ||
| mode: inmemory # / file | ||
| engine: arrow # / duckdb | ||
| refresh_interval: 1h | ||
| refresh_mode: full / append # update / incremental | ||
| retention: 30m | ||
| ``` | ||
|
|
||
| `spicepod.yaml` | ||
| ```yaml | ||
| datasets: | ||
| - from: local/Users/phillip/data/test.parquet | ||
| name: test | ||
| acceleration: | ||
| enabled: true | ||
| mode: inmemory # / file | ||
| engine: arrow # / duckdb | ||
| refresh_interval: 1h | ||
| refresh_mode: full / append # update / incremental | ||
| retention: 30m | ||
| ``` | ||
|
|
||
| Relative path example: | ||
|
|
||
| `spicepod.yaml` | ||
| ```yaml | ||
| datasets: | ||
| - from: datasets/uniswap_v2_eth_usdc | ||
| ``` | ||
|
|
||
| `datasets/uniswap_v2_eth_usdc/dataset.yaml` | ||
| ```yaml | ||
| name: spiceai.uniswap_v2_eth_usdc | ||
| type: overwrite | ||
| source: spice.ai | ||
| auth: spice.ai | ||
| acceleration: | ||
| enabled: true | ||
| refresh: 1h | ||
| ``` | ||
|
|
||
| ## `name` | ||
|
|
||
| The name of the dataset. This is used to reference the dataset in the pod manifest, as well as in external data sources. | ||
|
|
||
| ## `type` | ||
|
|
||
| The type of dataset. The following types are supported: | ||
|
|
||
| - `overwrite` - Overwrites the dataset with the contents of the dataset source. | ||
| - `append` - Appends new data from dataset source to the dataset. | ||
|
|
||
| ## `source` | ||
|
|
||
| The source of the dataset. The following sources are supported: | ||
|
|
||
| - `spice.ai` | ||
| - `dremio` (coming soon) | ||
| - `databricks` (coming soon) | ||
|
|
||
| ## `auth` | ||
|
|
||
| Optional. The authentication profile to use to connect to the dataset source. Use `spice login` to create a new authentication profile. | ||
|
|
||
| If not specified, the default profile for the data source is used. | ||
|
|
||
| ## `acceleration` | ||
|
|
||
| Optional. Accelerate queries to the dataset by caching data locally. | ||
|
|
||
| ## `acceleration.enabled` | ||
|
|
||
| Optional. Enable or disable acceleration. | ||
|
|
||
| ## `acceleration.refresh` | ||
|
|
||
| Optional. The interval to refresh the data for the dataset if the dataset type is overwrite. Specified as a [duration literal]({{<ref "reference/duration">}}). | ||
|
|
||
| For `append` datasets, the refresh interval not used. | ||
|
|
||
| i.e. `1h` for 1 hour, `1m` for 1 minute, `1s` for 1 second, etc. | ||
|
|
||
| ## `acceleration.retention` | ||
|
|
||
| Optional. Only supported for `append` datasets. Specifies how long to retain data updates from the data source before they are deleted. Specified as a [duration literal]({{<ref "reference/duration">}}). | ||
|
|
||
| If not specified, the default retention is to keep all data. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably shouldn't use the word caching here (or even locally).