Package com.inductiveautomation.historian.gateway.api.query
package com.inductiveautomation.historian.gateway.api.query
Historian engines and the metadata used to route their queries. Callers submit public query
options through the pipeline, which resolves aggregate semantics and splits work among engines
and platform folds. Engines stream results to processors and advertise the aggregates and
capabilities they support.
For native aggregate calls, NativeQueryContext carries the pipeline's
per-key directives and live post bounds separately from caller options. This context belongs to
one engine invocation and stays on the gateway; it is neither an extended property nor part of
the RPC wire. Direct engine callers pass NativeQueryContext.NONE.
-
ClassDescriptionBase class for query engines.Gateway-level catalog that answers which aggregates apply to a source by routing to the right
QueryEngine, and holds the gateway's own folds.Definitions two or more engines compute.An engine-own or shared aggregate's definition: its id, label key, output type, parameters and the predicates the pipeline reads.What the gateway asks an engine to do for one aggregated key it computes natively: how to treat windows without samples, which window edges to return, and the signal's shape between samples.The windows the engine returns edges for: the first and last stored sample of each.How the engine treats a window without samples.A versioned node in a historian: uniquely identified, with a source path, an optional data type, a creation time, and an optional retirement time.Identity of aHistoricalNode.HistoricalNodeTree<N extends HistoricalNode>APathTreeofHistoricalNodes keyed byQualifiedPath, with recursive removal that also removes parent nodes left without children.The versions of one node identity, sorted by created timestamp ascending, with lookups by exact created timestamp and by point in time.bigint-shaped id used by relational Historians.Pipeline-supplied context for one aggregated query computed natively by an engine: the directive for each key, the live post bound of each key that has one, and whether the batch runs the classic tag history calculation.Reads historical data for a historian: browsing, raw, aggregated and complex point queries, plus the capabilities and node metadata the query pipeline uses.RetirementAwareNodeTree<N extends HistoricalNode>AHistoricalNodeTreethat propagates retirement up the path hierarchy.SeedResults<V>The pre and post seed values of a query, by node, identified byHistoricalNodeId.UUID-shaped node id, for backends keyed by UUID such as QuestDB, SQLite and file-backed ones.