Package com.inductiveautomation.ignition.gateway.localdb.sqlite

Class SQLiteDBManager

java.lang.Object

com.inductiveautomation.ignition.gateway.localdb.sqlite.SQLiteDBManager

All Implemented Interfaces:

DBManager

public class SQLiteDBManager
extends Object
implements DBManager

Created by colby.clegg on 11/12/2015.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	autoBackupCount	Number of auto-backups to keep, if autoBackupsEnabled is true
protected int	autoBackupDelay	Delay, in minutes, between checking if an auto-backup is necessary.
protected File	autoBackupDir
protected boolean	autoBackupsEnabled	Whether or not to use any autobackups.
protected CountingDataSource	datasource	When this manager is connected, this will be a non-null reference to a javax.sql.DataSource that can be used to get connections to the database
protected File	dbDir	The home directory that the database lives in
protected String	dbName	The name of the database
protected int	defragDelay	Delay, in minutes, between defragmentation.
static final String	DRIVER_CLASS
protected int	faultCount	Number of faulted copies to keep
protected LoggerEx	log
protected boolean	newDatabase	Flag that will be set true when this manager was started up with no database and created an initial one on connect()

Constructor Summary

Constructors

Constructor	Description
SQLiteDBManager(ExecutionManager executionManager, Supplier<ContextState> gatewayState, File dbDir, String dbName)
SQLiteDBManager(ExecutionManager executionManager, Supplier<ContextState> gatewayState, File dbDir, String dbName, org.sqlite.SQLiteConfig sqliteConfig)

Method Summary

Modifier and Type	Method	Description
File	backupDatabase(File targetFolder, String baseFilename)	Creates a single-file backup of the internal db in the specified folder.
static SQLiteDBManager	create(GatewayContext context, File dbDir, String filename)
static SQLiteDBManager	create(GatewayContext context, File dbDir, String filename, org.sqlite.SQLiteConfig sqliteConfig)
Table	createTable()
protected String	createUrl()
protected boolean	dbFilesExist()
protected String	desc()
int	getAutoBackupCount()
int	getAutoBackupDelay()
File	getAutoBackupDir()
long	getDatabaseSize()	Calculates the harddrive footprint of the files that make up this sqlite instance.
DataSource	getDataSource()
SDriver	getDriver()	Returns the driver for the DBManager.
int	getFaultCount()
InternalDBFlavor	getFlavor()
void	initDriver()
boolean	isAutoBackupsEnabled()
boolean	isNewDatabase()
boolean	isRunning()
protected void	onConnected(DataSource datasource)	Called after we have been successfully connected to a sqlite database.
protected void	onCreateInitial(Statement stmt)	Called on creation of a new database, after the password has been set.
protected void	onShutdown()
void	restoreFromDBBackup(File dbFile)	Deletes the database files and restores the provided db file
void	setAutoBackupCount(int autoBackupCount)
void	setAutoBackupDelay(int autoBackupDelay)
void	setAutoBackupDir(File autoBackupDir)
void	setAutoBackupsEnabled(boolean autoBackupsEnabled)
void	setDefragDelay(int defragDelayMin)
void	setFaultCount(int faultCount)
void	shutdown()
void	shutdown(boolean compact)
void	startup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DRIVER_CLASS

public static final String DRIVER_CLASS

See Also:

• Constant Field Values

dbDir

protected File dbDir

The home directory that the database lives in

autoBackupDir

protected File autoBackupDir

dbName

protected String dbName

The name of the database

faultCount

protected int faultCount

Number of faulted copies to keep

autoBackupCount

protected int autoBackupCount

Number of auto-backups to keep, if autoBackupsEnabled is true

autoBackupDelay

protected int autoBackupDelay

Delay, in minutes, between checking if an auto-backup is necessary.

defragDelay

protected int defragDelay

Delay, in minutes, between defragmentation. If 0, defrag checkpoints will not be executed. *

autoBackupsEnabled

protected boolean autoBackupsEnabled

Whether or not to use any autobackups. Note that setting this to false doesn net prevent the creation of autobackups - for that you'd set autoBackupCount to zero.

datasource

protected CountingDataSource datasource

When this manager is connected, this will be a non-null reference to a javax.sql.DataSource that can be used to get connections to the database

newDatabase

protected boolean newDatabase

Flag that will be set true when this manager was started up with no database and created an initial one on connect()

log

protected LoggerEx log

Constructor Details

SQLiteDBManager

public SQLiteDBManager(ExecutionManager executionManager,
 Supplier<ContextState> gatewayState,
 File dbDir,
 String dbName)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

SQLiteDBManager

public SQLiteDBManager(ExecutionManager executionManager,
 Supplier<ContextState> gatewayState,
 File dbDir,
 String dbName,
 org.sqlite.SQLiteConfig sqliteConfig)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

initDriver

public void initDriver()
                throws DBStartupException

Throws:

DBStartupException

createUrl

protected String createUrl()

startup

public void startup()
             throws DBStartupException

Specified by:

startup in interface DBManager

Throws:

DBStartupException

getDataSource

public DataSource getDataSource()

Specified by:

getDataSource in interface DBManager

dbFilesExist

protected boolean dbFilesExist()

onCreateInitial

protected void onCreateInitial(Statement stmt)
                        throws SQLException

Called on creation of a new database, after the password has been set.

Throws:

SQLException

onConnected

protected void onConnected(DataSource datasource)
                    throws SQLException

Called after we have been successfully connected to a sqlite database.

Throws:

SQLException

onShutdown

protected void onShutdown()

desc

protected String desc()

restoreFromDBBackup

public void restoreFromDBBackup(File dbFile)
                         throws IOException

Deletes the database files and restores the provided db file

Specified by:

restoreFromDBBackup in interface DBManager

Throws:

IOException

backupDatabase

public File backupDatabase(File targetFolder,
 String baseFilename)
                    throws IOException

Description copied from interface: DBManager

Creates a single-file backup of the internal db in the specified folder. The full path to the backup is returned. The filename should start with the base, but should then be identifiable by the specific db system.

Specified by:

backupDatabase in interface DBManager

Throws:

IOException

isRunning

public boolean isRunning()

Specified by:

isRunning in interface DBManager

isNewDatabase

public boolean isNewDatabase()

Specified by:

isNewDatabase in interface DBManager

shutdown

public void shutdown()

getDatabaseSize

public long getDatabaseSize()

Calculates the harddrive footprint of the files that make up this sqlite instance.

Specified by:

getDatabaseSize in interface DBManager

shutdown

public void shutdown(boolean compact)

Specified by:

shutdown in interface DBManager

getAutoBackupDir

public File getAutoBackupDir()

setAutoBackupDir

public void setAutoBackupDir(File autoBackupDir)

getFaultCount

public int getFaultCount()

setFaultCount

public void setFaultCount(int faultCount)

Specified by:

setFaultCount in interface DBManager

getAutoBackupCount

public int getAutoBackupCount()

setAutoBackupCount

public void setAutoBackupCount(int autoBackupCount)

Specified by:

setAutoBackupCount in interface DBManager

isAutoBackupsEnabled

public boolean isAutoBackupsEnabled()

setAutoBackupsEnabled

public void setAutoBackupsEnabled(boolean autoBackupsEnabled)

Specified by:

setAutoBackupsEnabled in interface DBManager

getAutoBackupDelay

public int getAutoBackupDelay()

setAutoBackupDelay

public void setAutoBackupDelay(int autoBackupDelay)

Specified by:

setAutoBackupDelay in interface DBManager

setDefragDelay

public void setDefragDelay(int defragDelayMin)

Specified by:

setDefragDelay in interface DBManager

getFlavor

public InternalDBFlavor getFlavor()

Specified by:

getFlavor in interface DBManager

getDriver

public SDriver getDriver()

Description copied from interface: DBManager

Returns the driver for the DBManager. Important: the driver holds a session, so a new instance should be created each time.

Specified by:

getDriver in interface DBManager

createTable

public Table createTable()

Specified by:

createTable in interface DBManager

create

public static SQLiteDBManager create(GatewayContext context,
 File dbDir,
 String filename)
                              throws IllegalArgumentException

Throws:

IllegalArgumentException

create

public static SQLiteDBManager create(GatewayContext context,
 File dbDir,
 String filename,
 org.sqlite.SQLiteConfig sqliteConfig)
                              throws IllegalArgumentException

Throws:

IllegalArgumentException