Package com.inductiveautomation.historian.gateway.api.query

Interface QueryInterface

All Known Implementing Classes:
CsvHistorian, MemoryBackedHistorian
public interface QueryInterface
The HistorianQueryInterface provides methods for querying historical data.

  • Method Details

    • browse

      default Results<Result> browse(QualifiedPath root, BrowseFilter filter)

    • browse

      void browse(QualifiedPath root, BrowseFilter filter, BrowsePublisher results)
      Browses the historical data starting from the provided root path.
      Parameters:
      root - The root path to start browsing from.
      filter - The filter to apply while browsing.
      results - The publisher to publish the results to.

    • queryValues

      default void queryValues(List<ResultNodeDefinition> definitions, ValueFilter filter, ValuePublisher publisher)
      Queries historical data for the provided definitions.
      Parameters:
      definitions - The definitions to query.
      filter - The filter to apply when querying values.
      publisher - The publisher to publish values to.

    • queryMetadata

      default void queryMetadata(List<QualifiedPath> paths, MetadataFilter filter, MetadataPublisher publisher)
      Queries metadata for the provided paths.
      Parameters:
      paths - The paths to query metadata for.
      filter - The filter to apply when querying metadata.
      publisher - The publisher to publish the results to.

    • queryAnnotations

      default void queryAnnotations(List<QualifiedPath> paths, AnnotationFilter filter, AnnotationPublisher publisher)
      Queries annotations for the provided paths.
      Parameters:
      paths - The paths to query annotations for.
      filter - The filter to apply when querying annotations.
      publisher - The publisher to publish the results to.

    • getNativeAggregates

      default Set<Aggregate> getNativeAggregates()
      Gets the supported aggregates. By default, this method returns an empty set. Should only include system defined aggregates if this implementation shadows them natively.

      When a query occurs, any aggregates that are supported will be queried directly. Any that are not natively supported should be attempted to be calculated from raw data using the platform aggregates.
      Returns:
      The set of supported aggregates.