app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteSchema.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sqlite-driver Show documentation

JVM SQLite driver for SQLDelight

The newest version!

package app.cash.sqldelight.driver.jdbc.sqlite

import app.cash.sqldelight.TransacterImpl
import app.cash.sqldelight.db.AfterVersion
import app.cash.sqldelight.db.QueryResult
import app.cash.sqldelight.db.SqlCursor
import app.cash.sqldelight.db.SqlSchema
import java.util.Properties

/**
 * Constructs [JdbcSqliteDriver] and creates or migrates [schema] from current PRAGMA `user_version`.
 * After that updates PRAGMA `user_version` to migrated [schema] version.
 * Each of the [callbacks] are executed during the migration whenever the upgrade to the version specified by
 * [AfterVersion.afterVersion] has been completed.
 *
 * @see JdbcSqliteDriver
 * @see SqlSchema.create
 * @see SqlSchema.migrate
 */
fun JdbcSqliteDriver(
  url: String,
  properties: Properties = Properties(),
  schema: SqlSchema>,
  migrateEmptySchema: Boolean = false,
  vararg callbacks: AfterVersion,
): JdbcSqliteDriver {
  val driver = JdbcSqliteDriver(url, properties)
  val transacter = object : TransacterImpl(driver) {}

  transacter.transaction {
    val version = driver.getVersion()

    if (version == 0L && !migrateEmptySchema) {
      schema.create(driver).value
      driver.setVersion(schema.version)
    } else if (version < schema.version) {
      schema.migrate(driver, version, schema.version, *callbacks).value
      driver.setVersion(schema.version)
    }
  }

  return driver
}

private fun JdbcSqliteDriver.getVersion(): Long {
  val mapper = { cursor: SqlCursor ->
    QueryResult.Value(if (cursor.next().value) cursor.getLong(0) else null)
  }
  return executeQuery(null, "PRAGMA user_version", mapper, 0, null).value ?: 0L
}

private fun JdbcSqliteDriver.setVersion(version: Long) {
  execute(null, "PRAGMA user_version = $version", 0, null).value
}