database-api/com.peco2282.devcore.database/DatabaseBuilder

DatabaseBuilder

abstract class DatabaseBuilder

Abstract builder class for constructing a DatabaseProvider.

Constructors

DatabaseBuilder

constructor()

Properties

autoMigrate

var autoMigrate: Boolean

When true, org.jetbrains.exposed.v1.jdbc.SchemaUtils.createMissingTablesAndColumns is used instead of org.jetbrains.exposed.v1.jdbc.SchemaUtils.create, so new columns added to existing tables are applied automatically on start-up.

config

var config: DatabaseConfig?

The database configuration.

Functions

build

abstract fun build(): DatabaseProvider

Builds and returns a DatabaseProvider instance.

config

fun config(config: DatabaseConfig)

Sets the database configuration.

fun config(driver: String, url: String, user: String = "", password: String = "")

Sets the database configuration using individual parameters.

migrate

fun migrate(vararg migration: Migration)

Registers one or more Migration steps. Migrations are applied in ascending Migration.version order after schema initialisation.

fun <T : Table> register(table: T): T

Registers a table to the database.

table

fun table(vararg table: Table)

Registers one or more tables to the database. These tables will be created or updated upon initialization.