SQLiteHistorian (ignition 7.9.0-beta1 API)

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

All Implemented Interfaces:: Historian

public class SQLiteHistorian
extends java.lang.Object
implements Historian

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

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DRIVER_CLASS`
`static Property<java.lang.String>`	`FILE_PATH`
`static Property<java.lang.Boolean>`	`IN_MEMORY_DB`
`static Property<java.lang.Integer>`	`MAX_BATCH_SIZE`

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.
`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()`
`Status`	`getQueryStatus()` Returns the status of the storage system.
`Status`	`getStorageStatus()` Returns the status of the storage system.
`long`	`getTotalDataCount()` Returns an estimate of the total number of datapoints in the system.
`void`	`initDriver()`
`void`	`initialize(PropertySet properties)`
`QueryResult`	`query(java.util.List<java.lang.String> tags, long startTime, long endTime)` Queries the values for the given paths over the specified span of time.
`void`	`register(java.lang.String tag, 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()`

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

- Field Detail
  - FILE_PATH
```
public static final Property<java.lang.String> FILE_PATH
```
  - IN_MEMORY_DB
```
public static final Property<java.lang.Boolean> IN_MEMORY_DB
```
  - MAX_BATCH_SIZE
```
public static final Property<java.lang.Integer> MAX_BATCH_SIZE
```
  - DRIVER_CLASS
```
public static final java.lang.String DRIVER_CLASS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SQLiteHistorian
```
public SQLiteHistorian()
```
  - SQLiteHistorian
```
public SQLiteHistorian(java.lang.String filePath)
```
- Method Detail
  - getTotalDataCount
```
public long getTotalDataCount()
```
    Description copied from interface: Historian
    
    Returns an estimate of the total number of datapoints in the system.
    
    Specified by:
    
    getTotalDataCount in interface Historian
    
    Returns:
  - 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
    
    Returns:
  - 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
    
    Returns:
  - 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
  - register
```
public void register(java.lang.String tag,
                     PropertySet properties)
```
    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
  - 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
    
    Returns:
    
    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.
    
    Returns:
  - 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)
```
    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
    
    Returns:
  - 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

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

Field Detail

FILE_PATH

IN_MEMORY_DB

MAX_BATCH_SIZE

DRIVER_CLASS

Constructor Detail

SQLiteHistorian

SQLiteHistorian

Method Detail

getTotalDataCount

getQueryStatus

getStorageStatus

getConnection

initDriver

initialize

shutdown

register

createStorageSession

browse

delete

query

executeMaintenance

runUpdateQuery

runPrepUpdateQuery

runScalarQuery

runPrepScalarQuery