From 18143608dc46efacdd03dbb4abc0928ac958ca98 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 13 Dec 2022 13:30:50 -0800 Subject: [PATCH] doc update --- docs/parsers/cbt.md | 14 ++++++++++---- docs/utils.md | 3 +++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/parsers/cbt.md b/docs/parsers/cbt.md index ed3a5a39..8cb4e104 100644 --- a/docs/parsers/cbt.md +++ b/docs/parsers/cbt.md @@ -10,11 +10,17 @@ Google's BigTable). No effort is made to convert the data types of the values in the cells. -The timestamps of the cells are converted to Python's isoformat. +The `timestamp_epoch` calculated timestamp field is naive. (i.e. based on +the local time of the system the parser is run on) -Raw output contains all cells for each column (including timestamps in -converted to Python's isoformat), while the normal output contains only the -latest value for each column. +The `timestamp_epoch_utc` calculated timestamp field is timezone-aware and +is only available if the timestamp has a UTC timezone. + +The `timestamp_iso` calculated timestamp field will only include UTC +timezone information if the timestamp has a UTC timezone. + +Raw output contains all cells for each column (including timestamps), while +the normal output contains only the latest value for each column. Usage (cli): diff --git a/docs/utils.md b/docs/utils.md index fc57b97e..61fe19ff 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -233,3 +233,6 @@ Returns a timestamp object with the following attributes: utc (int | None): aware timestamp only if UTC timezone detected in datetime string. None if conversion fails. + iso (str | None): ISO string - timezone information is output + only if UTC timezone is detected in the datetime string. +