Package com.inductiveautomation.historian.common.model.options
package com.inductiveautomation.historian.common.model.options
Caller-supplied historian query settings shared by gateway, client and Designer code. Query
options and keys describe the requested sources, time range, aggregates and result behavior; RPC
adapters preserve these choices across gateway boundaries.
Data point options distinguish an absent quality filter or bounding configuration from an explicit choice through their requested-value accessors. Their effective accessors provide defaults for direct engine calls; the gateway pipeline resolves absent values per batch. Builders compute defaults and derived windows without changing their configuration.
Each aggregated key carries its own Interpolation, or inherits the query's.
Stepped, Sloped and Auto read the window edges by that shape; None reads only the window's own
samples. A key's fill touches only a window the calculation left without a value. Native engine
directives and live seeds belong to the gateway's invocation context, outside this model.
-
ClassDescriptionBase class for query options: query keys, time range, return size and extended properties.AbstractQueryOptions.BaseBuilder<K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>, B extends AbstractQueryOptions.BaseBuilder<K,
T, B>> Base builder forAbstractQueryOptions.Query key for an aggregated query: a source path, anAggregateSpec, a fill mode, an interpolation and a constant.Options for an aggregated query: the base data point query settings plus the time window each aggregate is computed over.Builder forAggregatedQueryOptions; adds the time window and aggregation settings to the common query settings.Marker for the typed parameter records carried by anAggregateSpec; each parameterized aggregate declares its own record.An aggregate's type and typed parameters.Key for querying the annotations of a path; its point type isStandardComplexPointType.ANNOTATION.Options for an annotation query: the shared query options plus anAnnotationFilteron author and type.Builder forAnnotationQueryOptions.Which bounding samples an aggregate query fetches beyond its time range: the latest sample strictly beforestartTime(pre-bound) and the earliest strictly afterendTime(post-bound).Bounding-value configuration: the mode and the optional lookback and lookforward horizons the pipeline'sBoundingValueResolveruses when it must fetch boundary samples itself.Policy for the search horizon of a bounding-value read, shared by every consumer ofBoundingOptions.lookback()andBoundingOptions.lookforward().AQueryKeyfor complex points, identified by a value of typeI.ComplexQueryOptions<K extends ComplexQueryKey<?>>Query options for complex points.AQueryKeyfor standard points, raw or aggregated.DataPointQueryOptions<K extends DataPointQueryKey>Base options for data point queries: observation exclusion, quality level filtering and bounding values.DataPointQueryOptions.DataQueryBuilder<K extends DataPointQueryKey, B extends DataPointQueryOptions.DataQueryBuilder<K,B>> Builder forDataPointQueryOptions.SentinelrecordTypeof aParameterSchemadecoded where the original params class is unavailable, such as the designer decoding a gateway-specific type likeStatsAggParams.How an aggregated key reads the signal between its samples, and whether its windows take edge values.Output shape of theResultWriterOptions.ObjectType.JSONsink.Key for querying the metadata of a path; its point type isStandardComplexPointType.METADATA.Options for a metadata query: the shared query options keyed byMetadataQueryKey, plus a property filter.Builder forMetadataQueryOptions.Sentinel for unparameterized aggregates.Escape hatch for aggregates whose schema isn't formalized.Describes the parameter contract of anAggregationType, for frontend rendering and for decoding the parameters of a parameterized aggregate.Parameters of a single-percentile aggregate such as APPROX_PERCENTILE.Base of all query keys: identifies one queried series and the point type it yields.Options for querying a queryableTemporalPointtype: the query keys, the point type, an optional time range, and an optional return size.Key for querying the raw points of a path; its point type isStandardDataPointType.ATOMIC.Options for a raw query; the query key is aRawQueryKey.Builder forRawQueryOptions.Options for how query results are written: object type, result format, JSON shape and column naming.Builder forResultWriterOptions.The kind of object a query returns.How the data is laid out in the result.Delimiter parameter of STRING_AGG and STRING_DISTINCT_AGG.