com.github.andrewoma.kwery.mapper.Dao.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015 Andrew O'Malley
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.andrewoma.kwery.mapper


interface Dao {
    val defaultColumns: Set>
    val defaultIdStrategy: IdStrategy

    fun findById(id: ID, columns: Set> = defaultColumns): T?

    /**
     * Selects the row using `SELECT ... FOR UPDATE` acquiring a pessimistic lock.
     * In general, using optimistic locking via versioning is preferred and it is
     * safe from deadlocks and allows safe updates to extend to external updates such as via a UI.
     * However, pessimistic locks are occasionally required to ensure integrity when performing
     * find followed by an update, e.g. updating an account balance.
     * If acquiring multiple rows for update via this method, try to order the acquisition of locks
     * by entity and ids within entity to avoid deadlocks.
     */
    fun findByIdForUpdate(id: ID, columns: Set> = defaultColumns): T?

    fun findByIds(ids: Collection, columns: Set> = defaultColumns): Map

    fun findAll(columns: Set> = defaultColumns): List

    fun findByExample(example: T, exampleColumns: Set>, columns: Set> = defaultColumns): List

    fun update(oldValue: T, newValue: T, deltaOnly: Boolean = false): T

    fun delete(id: ID): Int

    fun unsafeUpdate(newValue: T): T

    fun insert(value: T, idStrategy: IdStrategy = defaultIdStrategy): T

    fun batchInsert(values: List, idStrategy: IdStrategy = defaultIdStrategy): List

    fun unsafeBatchUpdate(values: List): List

    fun batchUpdate(values: List>): List

    fun allocateIds(count: Int): List
}