database-api/com.peco2282.devcore.database

Package-level declarations

Types

CrudRepository

abstract class CrudRepository<ID : Comparable<ID>, E : Entity<ID>>(provider: DatabaseProvider) : Repository<ID, E>

Abstract repository that provides full CRUD operations on top of Repository.

DatabaseBuilder

abstract class DatabaseBuilder

Abstract builder class for constructing a DatabaseProvider.

DatabaseConfig

data class DatabaseConfig(val driver: String, val url: String, val user: String = "", val password: String = "")

Data class representing the configuration for a database connection.

DatabaseDsl

@DslMarker

annotation class DatabaseDsl

Marker annotation for Database DSL.

DatabaseProvider

interface DatabaseProvider : AutoCloseable

Interface for abstracting database access.

Migration

interface Migration

Represents a single schema migration step.

MigrationRunner

class MigrationRunner(provider: DatabaseProvider, migrations: List<Migration>)

Applies pending migrations against the given provider.

PageResult

data class PageResult<T>(val items: List<T>, val total: Long, val offset: Long, val limit: Int)

A slice of query results with pagination metadata.

Repository

interface Repository<ID : Comparable<ID>, E : Entity<ID>>

Interface for DAO-based repositories.

Functions

and

infix fun () -> Op<Boolean>.and(other: () -> Op<Boolean>): () -> Op<Boolean>

Combines two Exposed where-clause predicates with AND.

dbQuery

fun <T> dbQuery(database: Database? = null, statement: Transaction.() -> T): T

Executes a transaction synchronously.

dbQuerySuspend

suspend fun <T> dbQuerySuspend(database: Database? = null, statement: suspend Transaction.() -> T): T

Executes a transaction asynchronously using Kotlin coroutines.

forEachTable

fun DatabaseProvider.forEachTable(statement: Transaction.(Table) -> Unit)

Executes a statement for each table registered in the provider.

migration

fun migration(version: Int, description: String = "Migration v", block: Transaction.() -> Unit): Migration

Creates a Migration inline via a DSL block.

infix fun () -> Op<Boolean>.or(other: () -> Op<Boolean>): () -> Op<Boolean>

Combines two Exposed where-clause predicates with OR.

plus

infix operator fun () -> Op<Boolean>.plus(other: () -> Op<Boolean>): () -> Op<Boolean>

query

fun <T : Table, R> T.query(provider: DatabaseProvider, statement: Transaction.(T) -> R): R

Extension function for Table to execute a query within its context.

querySuspend

suspend fun <T : Table, R> T.querySuspend(provider: DatabaseProvider, statement: Transaction.(T) -> R): R

Extension function for Table to execute an asynchronous query within its context.

selectPage

fun <T : Table, R> T.selectPage(provider: DatabaseProvider, offset: Long = 0, limit: Int = 20, where: () -> Op<Boolean>? = null, orderBy: List<Pair<Expression<*>, SortOrder>> = emptyList(), mapper: ResultRow.(T) -> R): PageResult<R>

Executes a paginated SELECT against this table inside a provider transaction.