Package com.inductiveautomation.ignition.common.sqltags.history

Interface TagHistoryQueryParams

All Known Implementing Classes:
BasicTagHistoryQueryParams, RealtimeTagHistoryQueryParams, TagHistoryCache.TimeAlteredParams, TagHistoryPenDatasource
public interface TagHistoryQueryParams
This interface defines the parameters for a tag history query.

  • Method Details

    • getPaths

      @Nonnull List<? extends Path> getPaths()
      The paths to query. The "source" field of the tag path is the historical provider that contains the tag. Tags from multiple providers may be requested at the same time.

    • getAliases

      List<String> getAliases()
      If not null, must be a 1-to-1 list corresponding to tag paths. Specifies names that will be used when representing the tag instead of the tag path. In other words, these are the values that will be used for column names in Wide return mode, or "Tag names" in tall return mode.

    • getStartDate

      Date getStartDate()
      The starting range of the query.

    • getEndDate

      Date getEndDate()
      The ending range of the query. If null, the query will be considered "realtime", and will cover up to the current time.

    • getReturnSize

      int getReturnSize()
      How many results are desired. -1 means "raw", 0 means "natural", and positive numbers are fixed rows. The definitions of "-1" and "0" may vary according to provider.

    • getAggregationMode

      Aggregate getAggregationMode()
      Specifies how aggregation should occur. Aggregation is how data is handled when multiple values exist for a certain window of time. The window is defined as the time range divided by the number of results, and therefore this setting doesn't apply when using raw result mode.

    • getColumnAggregationModes

      List<Aggregate> getColumnAggregationModes()
      If not null, must be 1-to-1 list corresponding to tag paths, specifying the aggregation mode for the column. If the list is null, or a particular entry is null, the general aggregation mode will be used instead.

    • getReturnFormat

      ReturnFormat getReturnFormat()
      Specifies the desired format of the resulting dataset. "Wide" results provide a column per row, "tall" instead has columns for path, time, value, and quality.

    • getQueryFlags

      Flags getQueryFlags()
      Optional flags that provide additional query settings. Tag provider dependent, though some reserved flags are defined in TagHistoryQueryFlags