runtime/io.github.sufarook.kiln.runtime

Package-level declarations

Types

AndroidDatabaseDriverFactory

class AndroidDatabaseDriverFactory(context: Context)

BaseKilnDriver

abstract class BaseKilnDriver : KilnDriver

Column

class Column<T>(val name: String, val toArg: (T) -> SqlArg)

A typed reference to one table column. Instances are generated — do not construct by hand.

ColumnDef

data class ColumnDef(val name: String, val type: String, val nullable: Boolean, val defaultValue: String, val migrateFrom: String = "", val isPrimaryKey: Boolean = false, val autoIncrement: Boolean = false, val isUnique: Boolean = false)

Full description of one expected column, generated by the processor into each repository's createTable() so SchemaMigrator can diff and migrate automatically.

CrudRepository

interface CrudRepository<T, ID>

IosDatabaseDriverFactory

class IosDatabaseDriverFactory

JvmDatabaseDriverFactory

class JvmDatabaseDriverFactory

KilnCursor

interface KilnCursor

KilnDriver

interface KilnDriver : AutoCloseable

KilnListener

fun interface KilnListener

KilnPreparedStatement

interface KilnPreparedStatement

KilnTransaction

interface KilnTransaction

Order

enum Order : Enum<Order>

OrderSpec

data class OrderSpec(val columnName: String, val direction: Order)

Predicate

class Predicate

A composed WHERE fragment plus its bound arguments.

SchemaMigrator

class SchemaMigrator(driver: KilnDriver)

Automatic schema migration — called inside every generated createTable().

SqlArg

sealed interface SqlArg

A bound query argument, tagged with how it must be bound to the statement.

Functions

asc

fun <T> Column<T>.asc(): OrderSpec

between

fun <T> Column<T>.between(low: T, high: T): Predicate

bindArg

fun KilnPreparedStatement.bindArg(index: Int, arg: SqlArg)

buildOrderSuffix

fun buildOrderSuffix(orderBy: List<OrderSpec>, limit: Long?, offset: Long?): String

Builds the ORDER BY / LIMIT / OFFSET suffix appended to WHERE queries. Used by generated code.

desc

fun <T> Column<T>.desc(): OrderSpec

infix fun <T> Column<T>.eq(value: T): Predicate

infix fun <T> Column<T>.gt(value: T): Predicate

gte

infix fun <T> Column<T>.gte(value: T): Predicate

inList

infix fun <T> Column<T>.inList(values: Collection<T>): Predicate

isNotNull

fun Column<*>.isNotNull(): Predicate

isNull

fun Column<*>.isNull(): Predicate

infix fun Column<out String?>.like(pattern: String): Predicate

SQL LIKE — use % and _ wildcards. Works on String and String? columns.

infix fun <T> Column<T>.lt(value: T): Predicate

lte

infix fun <T> Column<T>.lte(value: T): Predicate

neq

infix fun <T> Column<T>.neq(value: T): Predicate

not

fun not(predicate: Predicate): Predicate

notifyOrDefer

suspend fun KilnDriver.notifyOrDefer(tableName: String)

Inside a transaction, records tableName as dirty so its notification is sent once, after the outermost commit — or not at all if the transaction rolls back. Outside a transaction, calls KilnDriver.notifyListeners immediately (preserving the existing per-operation behaviour).

notInList

infix fun <T> Column<T>.notInList(values: Collection<T>): Predicate

observeQuery

fun <T> observeQuery(driver: KilnDriver, tableName: String, context: CoroutineContext, query: () -> T): Flow<T>

Runs query once immediately, then again every time the driver is notified that tableName changed (generated repositories call notifyListeners after each write).

withTransaction

suspend fun KilnDriver.withTransaction(context: CoroutineContext = Dispatchers.Default, block: suspend () -> Unit)

Executes block inside a single SQLite transaction.

withTransactionAwareContext

suspend fun <T> KilnDriver.withTransactionAwareContext(context: CoroutineContext, block: suspend CoroutineScope.() -> T): T

Runs block like withContext(context, block), unless a transaction is open: