runtime/app.cash.sqldelight.db/SqlSchema

SqlSchema

interface SqlSchema
Content copied to clipboard

API for creating and migrating a SQL database.

Functions

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

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): QueryResult<Unit>
Content copied to clipboard

Use driver to migrate from schema oldVersion to newVersion.

Properties

Link copied to clipboard
abstract val version: Int
Content copied to clipboard

The version of this schema.

Extensions

Link copied to clipboard
fun SqlSchema.migrateWithCallbacks(driver: SqlDriver, oldVersion: Int, newVersion: Int, vararg callbacks: AfterVersion)
Content copied to clipboard

Run SqlSchema.migrate normally but execute callbacks during the migration whenever it finished upgrading to a version specified by AfterVersion.afterVersion.