Skip to content

Archive, sampling contract and types

API reference

The store that reads archives, the window a read returns, and the metadata and sampling contract types an archive carries.

Name Summary
tsdive.TagStore Read-only view over root/<source_id>/<point_id>.parquet files.
tsdive.SingleFileStore Read-only view over one explicit parquet file (no layout assumptions).
tsdive.Window One tag's samples from start to end and the data physics of the read.
tsdive.Source A read-only window provider over process time series.
tsdive.TagMeta Static metadata for one tag.
tsdive.TagIdentity Immutable archive coordinates of a tag.
tsdive.Role Control-loop role of a tag. Nullable on TagMeta; populated when known.
tsdive.EngRange Engineering range as zero/span (the historian's own representation).
tsdive.SamplingContract Declares how a window's samples were produced.
tsdive.AggregateType OPC UA Part 13 aggregate flavour, when the source is an aggregate.
tsdive.CalculationBasis PI AF CalculationBasis values relevant to a window read.
tsdive.RetrievalMode How raw samples were retrieved from the archive.