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

rename refresh_interval to refresh_check_interval #208

Merged
merged 1 commit into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion spiceaidocs/docs/data-accelerators/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ datasets:
acceleration:
enabled: true
refresh_mode: full
refresh_interval: 10m
refresh_check_interval: 10m
refresh_sql: |
SELECT * FROM accelerated_dataset WHERE city = 'Seattle'
```
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/deployment/kubernetes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,6 @@ spicepod:
acceleration:
enabled: true
# Uncomment to refresh the acceleration on a schedule
# refresh_interval: 1h
# refresh_check_interval: 1h
# refresh_mode: full
```
4 changes: 2 additions & 2 deletions spiceaidocs/docs/local-acceleration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Dataset acceleration can be configured in `full` (the entire dataset is refreshe

## Refresh Interval

For accelerated datasets in `full` mode, the [`refresh_interval`](/reference/spicepod/datasets#accelerationrefresh_interval) parameter controls how often the accelerated dataset is refreshed.
For accelerated datasets in `full` mode, the [`refresh_check_interval`](/reference/spicepod/datasets#accelerationrefresh_check_interval) parameter controls how often the accelerated dataset is refreshed.

Accelerated datasets can also be refreshed on-demand via the `refresh` CLI command or `POST /v1/datasets/:name/refresh` API endpoint.

Expand Down Expand Up @@ -69,7 +69,7 @@ datasets:
acceleration:
enabled: true
refresh_mode: full
refresh_interval: 10s
refresh_check_interval: 10s
```

- The dataset `eth.recent_blocks` will be accelerated locally by the Spice runtime. The data will be refreshed every 10 seconds.
Expand Down
8 changes: 4 additions & 4 deletions spiceaidocs/docs/reference/spicepod/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ datasets:
enabled: true
mode: memory # / file
engine: arrow # / duckdb / sqlite / postgres
refresh_interval: 1h
refresh_check_interval: 1h
refresh_mode: full / append # update / incremental
```

Expand All @@ -36,7 +36,7 @@ datasets:
enabled: true
mode: memory # / file
engine: arrow # / duckdb
refresh_interval: 1h
refresh_check_interval: 1h
refresh_mode: full / append # update / incremental
```

Expand Down Expand Up @@ -141,9 +141,9 @@ Optional. How to refresh the dataset. The following values are supported:
- `full` - Refresh the entire dataset.
- `append` - Append new data to the dataset.

## `acceleration.refresh_interval`
## `acceleration.refresh_check_interval`

Optional. How often data should be refreshed. Only supported for `full` refresh_mode datasets. For `append` datasets, the refresh interval not used.
Optional. How often data should be refreshed. Only supported for `full` refresh_mode datasets. For `append` datasets, the refresh check interval not used.

See [Duration](../duration/index.md)

Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/reference/spicepod/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ datasets:
acceleration:
enabled: true
refresh_mode: full
refresh_interval: 1h
refresh_check_interval: 1h
```

## `models`
Expand Down