com.zepben.evolve.database.sqlite.common.TableVersion.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation

SDK for interaction with the evolve platform

There is a newer version: 0.24.0rc1

/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.database.sqlite.common

import com.zepben.evolve.database.sqlite.cim.tables.Column
import com.zepben.evolve.database.sqlite.cim.tables.Column.Nullable.NOT_NULL
import com.zepben.evolve.database.sqlite.cim.tables.SqliteTable
import com.zepben.evolve.database.sqlite.extensions.executeConfiguredQuery
import java.sql.Connection
import java.sql.SQLException

/**
 * Code representation of the `version` table.
 *
 * @property supportedVersion The supported schema version.
 *
 * @property VERSION Column definition.
 */
@Suppress("PropertyName")
class TableVersion(val supportedVersion: Int) : SqliteTable() {

    val VERSION: Column = Column(++columnIndex, "version", "TEXT", NOT_NULL)

    override val name: String = "version"

    /**
     * Helper function to read the version from the database.
     */
    @Throws(SQLException::class)
    fun getVersion(connection: Connection): Int? =
        connection.prepareStatement(selectSql).use { statement ->
            runCatching {
                statement.executeConfiguredQuery().use { results ->
                    results.next()
                    results.getInt(VERSION.queryIndex)
                }
            }.getOrNull()
        }

}