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.

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

Jump to bottom

add docs for refresh period #209

Merged
merged 4 commits into from
Apr 26, 2024
Merged

add docs for refresh period #209

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66388f6
add docs for refresh period
y-f-u Apr 24, 2024
a74acc1
wording
y-f-u Apr 26, 2024
0632812
add example
y-f-u Apr 26, 2024
e9c0f54
rename refresh_period
y-f-u Apr 26, 2024
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
10 changes: 9 additions & 1 deletion spiceaidocs/docs/reference/spicepod/datasets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Required to enable a retention policy on the dataset.
Optional. The format of the `time_column`. The following values are supported:
- `unix_seconds` - Default. Unix timestamp in seconds.
- `unix_millis` - Unix timestamp in milliseconds.
- `ISO8601` - [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
- `ISO8601` - [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

:::warning[Current Limitations]
- any string-based column is assumed to be ISO8601 format.
Expand Down Expand Up @@ -159,6 +159,14 @@ Must be of the form `SELECT * FROM {name} WHERE {refresh_filter}`. `{name}` is t
- Queries for data that have been filtered out will not fall back to querying against the federated table.
:::

## `acceleration.refresh_data_period`

Optional. A duration to filter dataset refresh source queries to recent data (duration into past from now). Requires `time_column` and `time_format` to also be configured. Only supported for `full` refresh mode datasets.

For example, `refresh_data_period: 24h` will include only records with a timestamp within the last 24 hours.

y-f-u marked this conversation as resolved.
Show resolved Hide resolved
See [Duration](../duration/index.md)

## `acceleration.params`

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