Enum Class EngineCapabilities.QueryCapability
java.lang.Object
java.lang.Enum<EngineCapabilities.QueryCapability>
com.inductiveautomation.historian.common.query.EngineCapabilities.QueryCapability
- All Implemented Interfaces:
Serializable, Comparable<EngineCapabilities.QueryCapability>, Constable
- Enclosing interface:
EngineCapabilities
public static enum EngineCapabilities.QueryCapability
extends Enum<EngineCapabilities.QueryCapability>
The query features an engine can declare.
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSupportsqueryAnnotationsnatively.Can efficiently tail(lastSeenTs, now]for append-only delta queries.Fetches bounding values itself, inline, on raw and aggregated queries: the latest value before the start and the next after the end, as set by theBoundingMode.Supports column-reference aggregates.HonorsexcludeObservationsonDataPointQueryOptions.SupportsqueryMetadatanatively.SupportsAggregatedQueryOptionsnatively.SupportsRawQueryOptionsnatively.Recognizes theNO_PREPROCESSED_DATAhint carried onDataPointQueryOptions.getExtendedProperties()viaHistorianProperties.NO_PREPROCESSED_DATA.Supports non-NoParamsAggregateSpec.Platform-sideAggregateFunctionaggregation is available via the catalog.Filters byDataPointQueryOptions.getQualityLevelFilter()at the engine, for example in a SQLWHERE.SupportsQualityLevelFilteronDataPointQueryOptions.HonorsHistorianBrowseTraits.RETIREMENT_STATEat browse time and setsBrowseResultProperties.RETIRED_TIMEon each result whose node has a retirement timestamp.Serves aggregated queries from its own pre-aggregated tier when it can;NO_PREPROCESSED_DATAbypasses the tier per query.Recognizes theNO_SCANCLASS_VALIDATIONhint carried onDataPointQueryOptions.getExtendedProperties()viaHistorianProperties.NO_SCE_VALIDATION.Supports time-weighted fill (LINEAR/PREVIOUS) natively.Returns window edges where anEngineDirectiveasks, and under gapNONEreturns only rows with samples behind them. -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.static EngineCapabilities.QueryCapability[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
QUALITY_LEVEL_FILTER
SupportsQualityLevelFilteronDataPointQueryOptions. -
EXCLUDE_OBSERVATIONS
HonorsexcludeObservationsonDataPointQueryOptions. -
NATIVE_RAW
SupportsRawQueryOptionsnatively. -
NATIVE_AGGREGATED
SupportsAggregatedQueryOptionsnatively. -
PLATFORM_FALLBACK_AGGREGATES
Platform-sideAggregateFunctionaggregation is available via the catalog. -
PARAMETERIZED_AGGREGATES
Supports non-NoParamsAggregateSpec. -
COLUMN_REF_AGGREGATES
Supports column-reference aggregates. -
ANNOTATIONS
SupportsqueryAnnotationsnatively. -
METADATA
SupportsqueryMetadatanatively. -
APPEND_ONLY_DELTA_EFFICIENT
Can efficiently tail(lastSeenTs, now]for append-only delta queries. -
TIME_WEIGHTED_FILL
Supports time-weighted fill (LINEAR/PREVIOUS) natively. -
WINDOW_EDGES
Returns window edges where anEngineDirectiveasks, and under gapNONEreturns only rows with samples behind them. Edges are the first and last samples with a value at a level the query admits. -
SCAN_CLASS_VALIDATION
Recognizes theNO_SCANCLASS_VALIDATIONhint carried onDataPointQueryOptions.getExtendedProperties()viaHistorianProperties.NO_SCE_VALIDATION. Engines without scan classes do not declare this and ignore the property. -
BOUNDING_VALUES
Fetches bounding values itself, inline, on raw and aggregated queries: the latest value before the start and the next after the end, as set by theBoundingMode. On aggregated queries this covers the keys the engine renders inline, perQueryEngine.boundsInline; the platform reads the boundary samples for the rest. -
RETIRED_NODE_AWARE
HonorsHistorianBrowseTraits.RETIREMENT_STATEat browse time and setsBrowseResultProperties.RETIRED_TIMEon each result whose node has a retirement timestamp. Engines without this flag may ignore the trait and must leave the property absent. -
NO_PREPROCESSED_DATA
Recognizes theNO_PREPROCESSED_DATAhint carried onDataPointQueryOptions.getExtendedProperties()viaHistorianProperties.NO_PREPROCESSED_DATA. When set, the engine bypasses its pre-aggregated tier and reads raw storage. Engines with their own rollup tiers should expose them through a dedicated capability. -
QUALITY_FILTERING
Filters byDataPointQueryOptions.getQualityLevelFilter()at the engine, for example in a SQLWHERE. Engines without this rely on the pipeline's fallback filtering. -
ROLLUP_TIERS
Serves aggregated queries from its own pre-aggregated tier when it can;NO_PREPROCESSED_DATAbypasses the tier per query. Informational; no pipeline stage branches on it.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-