com.zeoflow.depot.vo.Index.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of depot-compiler Show documentation

The Depot persistence library provides an abstraction layer over SQLite to allow for more robust database access while using the full power of SQLite.

The newest version!

/*
 * Copyright (C) 2021 ZeoFlow SRL
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.zeoflow.depot.vo

import com.zeoflow.depot.migration.bundle.BundleUtil

/**
 * Represents a processed index.
 */
data class Index(val name: String, val unique: Boolean, override val fields: Fields) :
    HasSchemaIdentity, HasFields {
    companion object {
        // should match the value in TableInfo.Index.DEFAULT_PREFIX
        const val DEFAULT_PREFIX = "index_"
    }

    constructor(name: String, unique: Boolean, fields: List) :
        this(name, unique, Fields(fields))

    override fun getIdKey() = "$unique-$name-${columnNames.joinToString(",")}"

    fun createQuery(tableName: String): String {
        val indexSQL = if (unique) {
            "UNIQUE INDEX"
        } else {
            "INDEX"
        }
        return """
            CREATE $indexSQL IF NOT EXISTS `$name`
            ON `$tableName` (${columnNames.joinToString(", ") { "`$it`" }})
        """.trimIndent().replace("\n", " ")
    }

    fun toBundle(): com.zeoflow.depot.migration.bundle.IndexBundle = com.zeoflow.depot.migration.bundle.IndexBundle(
        name, unique, columnNames,
        createQuery(BundleUtil.TABLE_NAME_PLACEHOLDER)
    )
}