SqlSchema

interface SqlSchema

API for creating and migrating a SQL database.

Functions

Link copied to clipboard
abstract fun create(driver: SqlDriver): QueryResult<Unit>

Use driver to create the schema from scratch. Assumes no existing database state.

Link copied to clipboard
abstract fun migrate(driver: SqlDriver, oldVersion: Int, newVersion: Int, vararg callbacks: AfterVersion): QueryResult<Unit>

Use driver to migrate from schema oldVersion to newVersion. Each of the callbacks are executed during the migration whenever the upgrade to the version specified by AfterVersion.afterVersion has been completed.

Properties

Link copied to clipboard
abstract val version: Int

The version of this schema.