Skip to content

Commit 690aa8b

Browse files
author
Scott Lyons
authored
Adding ready_state to Dataset reference (#573)
1 parent 55420ca commit 690aa8b

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

spiceaidocs/docs/reference/spicepod/datasets.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,24 @@ Retries utilize a [Fibonacci backoff strategy](https://en.wikipedia.org/wiki/Fib
226226

227227
Optional. Defines the maximum number of retry attempts when refresh retries are enabled. The default is undefined, allowing for unlimited attempts.
228228

229+
## `acceleration.ready_state`
230+
231+
Supports one of two values:
232+
233+
* `on_registration`: Mark the dataset as ready immediately, and queries on this table will fall back to the underlying source directly until the initial acceleration is complete
234+
* `on_load`: Mark the dataset as ready only after the initial acceleration. Queries against the dataset will return an error before the load has been completed.
235+
236+
```yaml
237+
datasets:
238+
- from: s3://my_bucket/my_dataset/
239+
name: my_dataset
240+
params:
241+
...
242+
acceleration:
243+
enabled: true
244+
ready_state: on_registration # or on_load
245+
```
246+
229247
## `acceleration.params`
230248

231249
Optional. Parameters to pass to the acceleration engine. The parameters are specific to the acceleration engine used.

0 commit comments

Comments
 (0)