com.zeoflow.depot.vo.ForeignKey.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

/**
 * Keeps information about a foreign key.
 */
data class ForeignKey(
    val parentTable: String,
    val parentColumns: List,
    val childFields: List,
    val onDelete: ForeignKeyAction,
    val onUpdate: ForeignKeyAction,
    val deferred: Boolean
) : HasSchemaIdentity {
    override fun getIdKey(): String {
        return parentTable +
            "-${parentColumns.joinToString(",")}" +
            "-${childFields.joinToString(",") {it.columnName}}" +
            "-${onDelete.sqlName}" +
            "-${onUpdate.sqlName}" +
            "-$deferred"
    }

    fun databaseDefinition(): String {
        return "FOREIGN KEY(${joinEscaped(childFields.map { it.columnName })})" +
            " REFERENCES `$parentTable`(${joinEscaped(parentColumns)})" +
            " ON UPDATE ${onUpdate.sqlName}" +
            " ON DELETE ${onDelete.sqlName}" +
            " ${deferredDeclaration()}"
    }

    private fun deferredDeclaration(): String {
        return if (deferred) {
            "DEFERRABLE INITIALLY DEFERRED"
        } else {
            ""
        }
    }

    private fun joinEscaped(values: Iterable) = values.joinToString(", ") { "`$it`" }

    fun toBundle(): com.zeoflow.depot.migration.bundle.ForeignKeyBundle =
        com.zeoflow.depot.migration.bundle.ForeignKeyBundle(
            parentTable, onDelete.sqlName, onUpdate.sqlName,
            childFields.map { it.columnName },
            parentColumns
        )
}