KSLCore/ksl.utilities.io.dbutil/Database

Database

open class Database @JvmOverloads constructor(val dataSource: DataSource, var label: String, var defaultSchemaName: String? = null) : DatabaseIfc(source)

Inheritors

DerbyDb

SQLiteDb

Constructors

Database

@JvmOverloads

constructor(dataSource: DataSource, label: String, defaultSchemaName: String? = null)

Types

Companion

object Companion

Properties

dataSource

override val dataSource: DataSource

the DataSource backing the database

dbURL

override val dbURL: String?

The URL used to establish the connection to the database.

defaultSchemaName

override var defaultSchemaName: String?

Sets the name of the default schema

label

override var label: String

identifying string representing the database. This has no relation to the name of the database on disk or in the dbms. The sole purpose is for labeling of output

longLastingConnection

override val longLastingConnection: Connection

A connection that is meant to be used many times before manual closing. Many functions rely on this connection as their default connection. Do not close this connection unless you are really finished with the database. Since, this property is final it cannot be restored after closing.

outputDirectory

override var outputDirectory: OutputDirectory

Functions

open override fun close()

Releases the resources this database holds so its backing files can be deleted or replaced. Idempotent. After close the database is unusable: metadata and query operations route through longLastingConnection, which is now closed.

getConnection

override fun getConnection(): Connection

It is best to use this function within a try-with-resource construct This method calls the DataSource for a connection from the underlying DataSource. You are responsible for closing the connection.

toString

open override fun toString(): String