From 690aa8b479b312e8d0cac4f4a87214a90bd726b7 Mon Sep 17 00:00:00 2001 From: Scott Lyons Date: Thu, 31 Oct 2024 06:39:29 -0700 Subject: [PATCH] Adding `ready_state` to Dataset reference (#573) --- .../docs/reference/spicepod/datasets.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/spiceaidocs/docs/reference/spicepod/datasets.md b/spiceaidocs/docs/reference/spicepod/datasets.md index 13a57a3d3..acf4ef2de 100644 --- a/spiceaidocs/docs/reference/spicepod/datasets.md +++ b/spiceaidocs/docs/reference/spicepod/datasets.md @@ -226,6 +226,24 @@ Retries utilize a [Fibonacci backoff strategy](https://en.wikipedia.org/wiki/Fib Optional. Defines the maximum number of retry attempts when refresh retries are enabled. The default is undefined, allowing for unlimited attempts. +## `acceleration.ready_state` + +Supports one of two values: + +* `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 +* `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. + +```yaml +datasets: + - from: s3://my_bucket/my_dataset/ + name: my_dataset + params: + ... + acceleration: + enabled: true + ready_state: on_registration # or on_load +``` + ## `acceleration.params` Optional. Parameters to pass to the acceleration engine. The parameters are specific to the acceleration engine used.