Skip to content

Document spice refresh command #200

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 1 commit into from
Apr 15, 2024
+30 −1
Merged

Document spice refresh command #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions spiceaidocs/docs/cli/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ spice [command] [--help]
| [login](/cli/reference/login) | Login to the Spice.ai Platform |
| [models](/cli/reference/models) | Lists models loaded by the Spice runtime |
| [pods](/cli/reference/pods) | Lists Spicepods loaded by the Spice runtime |
| [refresh](/cli/reference/refresh) | Refreshes an accelerated dataset loaded by the Spice runtime |
| [run](/cli/reference/run) | Run Spice - starts the Spice runtime, installing if necessary |
| [sql](/cli/reference/sql) | Start an interactive SQL query session against the Spice runtime |
| [status](/cli/reference/status) | Spice runtime status |
Expand Down
28 changes: 28 additions & 0 deletions spiceaidocs/docs/cli/reference/refresh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Refresh"
sidebar_label: "refresh"
pagination_prev: null
pagination_next: null
---

Refreshes an accelerated dataset loaded by the Spice runtime

### Usage:
```shell
spice refresh [dataset] [flags]
```

`dataset` - an accelerated dataset name

#### Flags:
- `-h`, `--help` Print this help message

### Examples:
```shell
>>> spice refresh taxi_trips

Refreshing dataset taxi_trips ...
Dataset refresh triggered for taxi_trips.
```


2 changes: 1 addition & 1 deletion spiceaidocs/docs/local-acceleration/index.md
View file
Open in desktop
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

The data refresh interval for an accelerated dataset in `full` mode can be specified via [refresh_interval](/reference/spicepod/datasets#accelerationrefresh_interval) parameter (see Example section below) or triggered via API (`POST`, `/v1/datasets/:name/refresh`).
The data refresh interval for an accelerated dataset in `full` mode can be specified via [refresh_interval](/reference/spicepod/datasets#accelerationrefresh_interval) parameter (see Example section below), triggered via [refresh](cli/reference/refresh) command or API (`POST`, `/v1/datasets/:name/refresh`).

An example CuRL

Expand Down