SQLiteHistorian (ignition 7.9.5 API)

java.lang.Object
- com.inductiveautomation.gateway.tsdb.historians.SQLiteHistorian

All Implemented Interfaces:: Historian, Syncable

public class SQLiteHistorian
extends java.lang.Object
implements Historian, Syncable

Created by colby.clegg on 3/18/2016.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SQLiteHistorian.DBLockClosable`
`protected class`	`SQLiteHistorian.Query`
`protected class`	`SQLiteHistorian.SQLiteStorageSession`
`protected static class`	`SQLiteHistorian.Tables`
`protected static class`	`SQLiteHistorian.Tag`

Field Summary
- Fields inherited from interface com.inductiveautomation.gateway.tsdb.api.Historian
  QUALITY_NOT_FOUND

Constructor Summary

Constructors
Constructor and Description

SQLiteHistorian()

SQLiteHistorian(java.lang.String filePath)

Constructors
Constructor and Description
`SQLiteHistorian()`
`SQLiteHistorian(java.lang.String filePath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`browse(java.util.Optional<java.lang.String> filter)` Returns a list of paths with data stored, optionally matching a filter.
`StorageSession`	`createStorageSession()` Used to store values to the historian.
`protected SQLiteHistorian.Tag`	`createTag(java.lang.String tagPath)`
`void`	`delete(java.util.List<java.lang.String> paths)` Deletes the tags and all data for the specified paths.
`void`	`executeMaintenance()`
`protected java.sql.Connection`	`getConnection()`
`<T> T`	`getProperty(Property<T> prop)` Returns the configured or status property requested, or the default value if no further info is available.
`Status`	`getQueryStatus()` Returns the status of the storage system.
`Status`	`getStorageStatus()` Returns the status of the storage system.
`protected int`	`getStorageSyncId(java.lang.String tagPath, long timestamp)`
`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.
`protected long`	`getTotalDataCount()`
`boolean`	`hasSyncableData(long syncId)` Returns whether there is data available to sync based on the provided id.
`void`	`initDriver()`
`void`	`initialize(PropertySet properties)`
`protected void`	`initializeSync()`
`protected SQLiteHistorian.DBLockClosable`	`lockDB()`
`protected void`	`newSyncId()`
`protected boolean`	`propertiesDiffer(PropertySet a, PropertySet b)`
`QueryResult`	`query(java.util.List<java.lang.String> tags, long startTime, long endTime, boolean includeBounding)` Queries the values for the given paths over the specified span of time.
`void`	`register(java.lang.String tagPath, PropertySet properties)` Provides information about a path.
`protected static java.lang.Object`	`runPrepScalarQuery(java.sql.Connection c, java.lang.String query, java.lang.Object... args)`
`protected static int`	`runPrepUpdateQuery(java.sql.Connection c, java.lang.String query, java.lang.Object... args)`
`protected static java.lang.Object`	`runScalarQuery(java.sql.Connection c, java.lang.String query)`
`protected static int`	`runUpdateQuery(java.sql.Connection c, java.lang.String query)`
`void`	`shutdown()`
`SyncQueryResults`	`sync(long syncId)` This returns a set of data- it's up to the implementation to decide what makes sense.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SQLiteHistorian
```
public SQLiteHistorian()
```
  - SQLiteHistorian
```
public SQLiteHistorian(java.lang.String filePath)
```
- Method Detail
  - getProperty
```
public <T> T getProperty(Property<T> prop)
```
    Description copied from interface: Historian
    
    Returns the configured or status property requested, or the default value if no further info is available. Most of these properties are defined in HistorianProperties.
    
    Specified by:
    
    getProperty in interface Historian
    
    Returns:
  - lockDB
```
protected SQLiteHistorian.DBLockClosable lockDB()
```
  - getTotalDataCount
```
protected long getTotalDataCount()
```
  - getQueryStatus
```
public Status getQueryStatus()
```
    Description copied from interface: Historian
    
    Returns the status of the storage system. If the system does not support querying, NotAvailable will be returned.
    
    Specified by:
    
    getQueryStatus in interface Historian
  - getStorageStatus
```
public Status getStorageStatus()
```
    Description copied from interface: Historian
    
    Returns the status of the storage system. If the system does not support storage, NotAvailable will be returned. If this is the case, calls to createStorageSession will fail.
    
    Specified by:
    
    getStorageStatus in interface Historian
  - getConnection
```
protected java.sql.Connection getConnection()
                                     throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - initDriver
```
public void initDriver()
                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - initialize
```
public void initialize(PropertySet properties)
                throws java.lang.Exception
```
    Specified by:
    
    initialize in interface Historian
    
    Throws:
    
    java.lang.Exception
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface Historian
  - propertiesDiffer
```
protected boolean propertiesDiffer(PropertySet a,
                                   PropertySet b)
```
  - register
```
public void register(java.lang.String tagPath,
                     PropertySet properties)
              throws java.lang.Exception
```
    Description copied from interface: Historian
    
    Provides information about a path. May be called before or after values have been stored, will replace any previous information stored for a path. The property values are usually defined in HistorianProperties.
    
    Specified by:
    
    register in interface Historian
    
    Throws:
    
    java.lang.Exception
  - createTag
```
protected SQLiteHistorian.Tag createTag(java.lang.String tagPath)
                                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - createStorageSession
```
public StorageSession createStorageSession()
                                    throws java.lang.Exception
```
    Description copied from interface: Historian
    
    Used to store values to the historian. Should be used for the immediate set of values and then closed. It should not be held open for longer than necessary.
    It implements AutoClosable, and should often be used in a try-with-resources block, such as:
    try(StorageSession s = historian.createStorageSession()){ s.store... }
    Important: Not every historian will support storage, some are read-only. This can be checked by calling getStorageStatus() and checking the return for "NotSupported".
    
    Specified by:
    
    createStorageSession in interface Historian
    
    Throws:
    
    java.lang.Exception
  - browse
```
public java.util.List<java.lang.String> browse(java.util.Optional<java.lang.String> filter)
```
    Description copied from interface: Historian
    
    Returns a list of paths with data stored, optionally matching a filter.
    
    Specified by:
    
    browse in interface Historian
    
    Parameters:
    
    filter - a wildcard ("Tag*") based string that will be used to filter tags. If empty, all paths will be returned.
  - delete
```
public void delete(java.util.List<java.lang.String> paths)
```
    Description copied from interface: Historian
    
    Deletes the tags and all data for the specified paths. Paths may be wildcards using "*". Only expected to work if the historian supports storage, as indicated by getStorageStatus().
    
    Specified by:
    
    delete in interface Historian
  - query
```
public QueryResult query(java.util.List<java.lang.String> tags,
                         long startTime,
                         long endTime,
                         boolean includeBounding)
```
    Description copied from interface: Historian
    Queries the values for the given paths over the specified span of time. The implementation will conform to the following rules:
    1. If endTime is less than start time, results MAY be provided latest first. If that is not possible, the parameters will be swapped and values returned as normal.
    2. The result will have a unique PathInfo item for EACH of the paths passed in. If a path is specified multiple times, it will be returned multiple times.
    3. If a path is not valid, the query result will return ONE DataPoint for the query start time with a quality of 404 (NOT FOUND)
    4. The timestamps for a given path will be ascending, though between paths they may not be.
    Specified by:
    
    query in interface Historian
    
    includeBounding - if true, the closest value previous to the start time will be returned, as well as the closest value following the end time.
  - executeMaintenance
```
public void executeMaintenance()
```
  - runUpdateQuery
```
protected static int runUpdateQuery(java.sql.Connection c,
                                    java.lang.String query)
                             throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - runPrepUpdateQuery
```
protected static int runPrepUpdateQuery(java.sql.Connection c,
                                        java.lang.String query,
                                        java.lang.Object... args)
                                 throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - runScalarQuery
```
protected static java.lang.Object runScalarQuery(java.sql.Connection c,
                                                 java.lang.String query)
                                          throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - runPrepScalarQuery
```
protected static java.lang.Object runPrepScalarQuery(java.sql.Connection c,
                                                     java.lang.String query,
                                                     java.lang.Object... args)
                                              throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - initializeSync
```
protected void initializeSync()
                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - hasSyncableData
```
public boolean hasSyncableData(long syncId)
```
    Description copied from interface: Syncable
    
    Returns whether there is data available to sync based on the provided id.
    
    Specified by:
    
    hasSyncableData in interface Syncable
  - sync
```
public SyncQueryResults sync(long syncId)
```
    Description copied from interface: Syncable
    
    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.
    
    Specified by:
    
    sync in interface Syncable
    
    Parameters:
    
    syncId - if 0, returns next set of available data based on last query. Otherwise, starts at the given time period.
  - newSyncId
```
protected void newSyncId()
```
  - getStorageSyncId
```
protected int getStorageSyncId(java.lang.String tagPath,
                               long timestamp)
```
  - getSyncableData
```
public int getSyncableData(long syncId)
```
    Description copied from interface: Syncable
    
    Returns the number of data points that could be synchronized from the given point.
    
    Specified by:
    
    getSyncableData in interface Syncable
  - getSyncIdTimestamp
```
public long getSyncIdTimestamp(long syncId)
```
    Description copied from interface: Syncable
    
    Returns the timestamp of the start of the sync group.
    
    Specified by:
    
    getSyncIdTimestamp in interface Syncable

Class SQLiteHistorian

Nested Class Summary

Field Summary

Fields inherited from interface com.inductiveautomation.gateway.tsdb.api.Historian

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SQLiteHistorian

SQLiteHistorian

Method Detail

getProperty

lockDB

getTotalDataCount

getQueryStatus

getStorageStatus

getConnection

initDriver

initialize

shutdown

propertiesDiffer

register

createTag

createStorageSession

browse

delete

query

executeMaintenance

runUpdateQuery

runPrepUpdateQuery

runScalarQuery

runPrepScalarQuery

initializeSync

hasSyncableData

sync

newSyncId

getStorageSyncId

getSyncableData

getSyncIdTimestamp