KSLCore/ksl.utilities.io.dbutil/KSLDatabase/Companion

Companion

object Companion

Properties

dbDir

val dbDir: Path

dbScriptsDir

val dbScriptsDir: Path

TableNames

val TableNames: List<String>

ViewNames

val ViewNames: List<String>

Functions

connectKSLDatabase

fun connectKSLDatabase(clearDataOption: Boolean = false, dBProperties: Properties): KSLDatabase

Creates a reference to a KSLDatabase. This method assumes that the data source has an existing properly configured KSL schema. If it does not, an exception occurs. If it has one the data from previous simulation runs will be deleted if the clear data option is true. The deletion occurs immediately if configured as true.

connectPostgresKSLDatabase

fun connectPostgresKSLDatabase(clearDataOption: Boolean = false, dbName: String, dbServerName: String = "localhost", user: String = "postgres", pWord: String = ""): KSLDatabase

Creates a reference to a KSLDatabase. This method assumes that the data source has an existing properly configured KSL schema. If it does not, an exception occurs. If it has one the data from previous simulations remains. If the clear data option is set to true then the data WILL be deleted immediately.

createEmbeddedDerbyKSLDatabase

fun createEmbeddedDerbyKSLDatabase(dbName: String, dbDirectory: Path = dbDir): Database

This method creates the database on disk and configures it to hold KSL simulation data.

createKSLDatabase

fun createKSLDatabase(dbName: String, dbDirectory: Path = dbDir): KSLDatabase

This method creates the database on disk and configures it to hold KSL simulation data.

createPostgreSQLKSLDatabase

fun createPostgreSQLKSLDatabase(dbName: String, dbServerName: String = "localhost", user: String = "postgres", pWord: String = ""): Database

Creates a new KSLDatabase

createSQLiteKSLDatabase

fun createSQLiteKSLDatabase(dbName: String, dbDirectory: Path = dbDir): Database

This method creates the database on disk and configures it to hold KSL simulation data.

executeKSLDbCreationScriptOnDatabase

fun executeKSLDbCreationScriptOnDatabase(db: Database)

Executes the KSL database creation script on the database if the database does not already have a KSL_DB schema. If the database already contains a KSL_DB schema then the creation script is not executed. This method assumes that the underlying data source supports schemas. For example, SQLite does not support schemas.