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

doc change for time format #315

Merged
merged 3 commits into from
Jul 12, 2024
Merged

doc change for time format #315

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faa43ab
doc change for time format
y-f-u Jul 11, 2024
60a34b8
add example
y-f-u Jul 12, 2024
78c89f1
Merge branch 'trunk' into doc-change-for-time-format
y-f-u Jul 12, 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
9 changes: 6 additions & 3 deletions spiceaidocs/docs/reference/spicepod/datasets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,14 @@ Required to enable a retention policy on the dataset.
## `time_format`

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.
- `timestamp` - Default. Timestamp without a timezone. E.g. `2016-06-22 19:10:25` with data type `timestamp`.
- `timestamptz` - Timestamp with a timezone. E.g. `2016-06-22 19:10:25-07` with data type `timestamptz`.
- `unix_seconds` - Unix timestamp in seconds. E.g. `1718756687`.
- `unix_millis` - Unix timestamp in milliseconds. E.g. `1718756687000`.
- `ISO8601` - [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

Spice emits a warning if the `time_column` from the data source is incompatible with the `time_format` config.

:::warning[Limitations]

- String-based columns are assumed to be ISO8601 format.
Expand Down