Identifies Geo Time Series™ which MAY have data within a given key range, assuming those keys are bounds of an SST file.
This function is key to identifying which SST files should be purged using
If no token and selectors are specified in the parameter list of
SSTFIND, all Geo Time Series™ will be considered, otherwise, only those matching the entered criteria will be used.
The return value of the
SSTFIND function is a list of lists, each inner list containing 3 fields,
gts field is either an actual empty Geo Time Series™, but with all metadata set, or
gts is not null, it means that the Geo Time Series™ may have data in the file given because its internal id falls within the key range. If
null, it means there is a Geo Time Series™ that may exist in the file but whose metadata (class and labels) were not matched by the provided selectors. This is a helpful hint to indicate that there may be some data in the file which belong to series you were not initially interested in.
The values of
maxts indicate between which timestamps
gts may have datapoints. If the id of
gts is not matched by either the smallest or largest key of the range, both
maxts will have extreme values (respectively
MAXLONG). If the
gts id matches one of the bounds, the
maxts fields will have more meaningful values.
Keys of datapoints start with
), keys for metadata start with0x4d
SSTFIND is called with metadata keys, the fields
maxts will be set to
SSTFIND is called with keys for both metadata and data, an error is raised indicating that
SSTFIND cannot determine what lies inside hydrid files.
Keys invalid for both metadata and data will also lead to an invalid key range error.