com.inductiveautomation.ignition.gateway.sqltags.history

Interface TagHistoryProvider

All Known Implementing Classes:

LegacyTagHistoryProvider, TagHistoryProvider, TagHistorySplitterProvider

public interface TagHistoryProvider

A TagHistoryProvider is a entity that provides, for querying, historical tag information. This is the main interface for any system that wishes to provide tag history. It does not, however, define functions for storing history. If a single system wishes to both store and provide history, it should also implement the DataSink interface and register it with the HistoryManager. The DataSink should accept the HistoryFlavor.SQLTAG type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HISTORY_LOG_BASE_NAME

Method Summary

Modifier and Type	Method and Description
BrowseResults	browse(QualifiedPath root, BrowseFilter filter)
java.util.List<TagPath>	browseTags() Deprecated.
HistoryQueryExecutor	createQuery(java.util.List<ColumnQueryDefinition> paths, QueryController controller)
java.util.List<Aggregate>	getAvailableAggregates() Returns a list of aggregate functions that can be used with the server.
java.lang.String	getName()
ProfileStatus	getStatus()
TimelineSet	queryDensity(java.util.List<QualifiedPath> paths, java.util.Date start, java.util.Date end, java.lang.String queryId)
void	shutdown()
void	startup()

Field Detail

HISTORY_LOG_BASE_NAME

static final java.lang.String HISTORY_LOG_BASE_NAME

See Also:

Constant Field Values

Method Detail

startup

void startup()

shutdown

void shutdown()

getName

java.lang.String getName()

getAvailableAggregates

java.util.List<Aggregate> getAvailableAggregates()

Returns a list of aggregate functions that can be used with the server. Only expected to be valid if the server is enabled and available. Also, should only return null if the aggregates can not be retrieved for some reason. If the server simply does not support any aggregate functions, an empty list should be returned.

Returns:

getStatus

ProfileStatus getStatus()

createQuery

HistoryQueryExecutor createQuery(java.util.List<ColumnQueryDefinition> paths,
                                 QueryController controller)

browseTags

@Deprecated
java.util.List<TagPath> browseTags()

Deprecated.

browse

BrowseResults browse(QualifiedPath root,
                     BrowseFilter filter)

queryDensity

TimelineSet queryDensity(java.util.List<QualifiedPath> paths,
                         java.util.Date start,
                         java.util.Date end,
                         java.lang.String queryId)
                  throws java.lang.Exception

Throws:

java.lang.Exception