com.inductiveautomation.gateway.tsdb.api

Interface Syncable

All Known Implementing Classes:

SQLiteHistorian

public interface Syncable

This interface provides sync'ing functions for a historian. "Syncing" means that we can query data in a way that ensures we will get everything, and not get repeat data, in order to send it or store it to a different location.

Method Summary

Modifier and Type	Method and Description
int	getSyncableData(long syncId) Returns the number of data points that could be synchronized from the given point.
long	getSyncIdTimestamp(long syncId) Returns the timestamp of the start of the sync group.
boolean	hasSyncableData(long syncId) Returns whether there is data available to sync based on the provided id.
SyncQueryResults	sync(long syncId) This returns a set of data- it's up to the implementation to decide what makes sense.

Method Detail

hasSyncableData

boolean hasSyncableData(long syncId)

Returns whether there is data available to sync based on the provided id.

getSyncableData

int getSyncableData(long syncId)

Returns the number of data points that could be synchronized from the given point.

getSyncIdTimestamp

long getSyncIdTimestamp(long syncId)

Returns the timestamp of the start of the sync group.

sync

SyncQueryResults sync(long syncId)

This returns a set of data- it's up to the implementation to decide what makes sense. If the caller wants more data, it can just call again.

Parameters:

syncId - if 0, returns next set of available data based on last query. Otherwise, starts at the given time period.