api/org.octavius.data.builder

Package-level declarations

Types

Interface for builder executing queries asynchronously in the provided CoroutineScope. Terminal methods accept callbacks and return Job for lifecycle control.

DeleteQueryBuilder

interface DeleteQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<DeleteQueryBuilder>

Defines the public API for building SQL DELETE queries.

InsertQueryBuilder

interface InsertQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<InsertQueryBuilder>

Defines the public API for building SQL INSERT queries.

LockWaitMode

enum LockWaitMode : Enum<LockWaitMode>

Controls the waiting behavior when acquiring row-level locks in a SELECT query.

OnConflictClauseBuilder

interface OnConflictClauseBuilder

Configurator for the ON CONFLICT clause in an INSERT query.

QueryBuilder

interface QueryBuilder<T : QueryBuilder<T>>

RawQueryBuilder

interface RawQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<RawQueryBuilder>

Defines the public API for passing a complete raw query.

SelectQueryBuilder

interface SelectQueryBuilder : TerminalReturningMethods, QueryBuilder<SelectQueryBuilder>

Defines the public API for building SQL SELECT queries.

StepBuilderMethods

interface StepBuilderMethods

Interface for StepBuilder - contains the same terminal methods as TerminalReturningMethods and TerminalModificationMethods, but returns TransactionStep instead of executing queries.

StreamingTerminalMethods

interface StreamingTerminalMethods

TerminalModificationMethods

interface TerminalModificationMethods

Interface containing terminal modification method

TerminalReturningMethods

interface TerminalReturningMethods

Interface containing terminal methods that return data

UpdateQueryBuilder

interface UpdateQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<UpdateQueryBuilder>

Defines the public API for building SQL UPDATE queries.

Functions

execute

fun StepBuilderMethods.execute(vararg params: Pair<String, Any?>): TransactionStep<Int>

fun TerminalModificationMethods.execute(vararg params: Pair<String, Any?>): DataResult<Int>

forEachRow

fun StreamingTerminalMethods.forEachRow(vararg params: Pair<String, Any?>, action: (row: Map<String, Any?>) -> Unit): DataResult<Unit>

forEachRowOf

inline fun <T : Any> StreamingTerminalMethods.forEachRowOf(vararg params: Pair<String, Any?>, noinline action: (obj: T) -> Unit): DataResult<Unit>

inline fun <T : Any> StreamingTerminalMethods.forEachRowOf(params: Map<String, Any?> = emptyMap(), noinline action: (obj: T) -> Unit): DataResult<Unit>

toColumn

inline fun <T> StepBuilderMethods.toColumn(vararg params: Pair<String, Any?>): TransactionStep<List<T>>

inline fun <T> StepBuilderMethods.toColumn(params: Map<String, Any?> = emptyMap()): TransactionStep<List<T>>

inline fun <T> TerminalReturningMethods.toColumn(vararg params: Pair<String, Any?>): DataResult<List<T>>

inline fun <T> TerminalReturningMethods.toColumn(params: Map<String, Any?> = emptyMap()): DataResult<List<T>>

inline fun <T> AsyncTerminalMethods.toColumn(vararg params: Pair<String, Any?>, noinline onResult: (DataResult<List<T>>) -> Unit): Job

inline fun <T> AsyncTerminalMethods.toColumn(params: Map<String, Any?> = emptyMap(), noinline onResult: (DataResult<List<T>>) -> Unit): Job

toField

inline fun <T> StepBuilderMethods.toField(vararg params: Pair<String, Any?>): TransactionStep<T>

inline fun <T> StepBuilderMethods.toField(params: Map<String, Any?> = emptyMap()): TransactionStep<T>

inline fun <T> TerminalReturningMethods.toField(vararg params: Pair<String, Any?>): DataResult<T>

inline fun <T> TerminalReturningMethods.toField(params: Map<String, Any?> = emptyMap()): DataResult<T>

inline fun <T> AsyncTerminalMethods.toField(vararg params: Pair<String, Any?>, noinline onResult: (DataResult<T>) -> Unit): Job

inline fun <T> AsyncTerminalMethods.toField(params: Map<String, Any?> = emptyMap(), noinline onResult: (DataResult<T>) -> Unit): Job

toFieldStrict

inline fun <T> StepBuilderMethods.toFieldStrict(vararg params: Pair<String, Any?>): TransactionStep<T>

inline fun <T> StepBuilderMethods.toFieldStrict(params: Map<String, Any?> = emptyMap()): TransactionStep<T>

inline fun <T> TerminalReturningMethods.toFieldStrict(vararg params: Pair<String, Any?>): DataResult<T>

inline fun <T> TerminalReturningMethods.toFieldStrict(params: Map<String, Any?> = emptyMap()): DataResult<T>

inline fun <T> AsyncTerminalMethods.toFieldStrict(vararg params: Pair<String, Any?>, noinline onResult: (DataResult<T>) -> Unit): Job

inline fun <T> AsyncTerminalMethods.toFieldStrict(params: Map<String, Any?> = emptyMap(), noinline onResult: (DataResult<T>) -> Unit): Job

toList

fun StepBuilderMethods.toList(vararg params: Pair<String, Any?>): TransactionStep<List<Map<String, Any?>>>

fun TerminalReturningMethods.toList(vararg params: Pair<String, Any?>): DataResult<List<Map<String, Any?>>>

fun AsyncTerminalMethods.toList(vararg params: Pair<String, Any?>, onResult: (DataResult<List<Map<String, Any?>>>) -> Unit): Job

toListOf

inline fun <T : Any> StepBuilderMethods.toListOf(vararg params: Pair<String, Any?>): TransactionStep<List<T>>

inline fun <T : Any> TerminalReturningMethods.toListOf(vararg params: Pair<String, Any?>): DataResult<List<T>>

inline fun <T : Any> AsyncTerminalMethods.toListOf(vararg params: Pair<String, Any?>, noinline onResult: (DataResult<List<T>>) -> Unit): Job

inline fun <T : Any> AsyncTerminalMethods.toListOf(params: Map<String, Any?> = emptyMap(), noinline onResult: (DataResult<List<T>>) -> Unit): Job

inline fun <T : Any> StepBuilderMethods.toListOf(params: Map<String, Any?> = emptyMap()): TransactionStep<List<T>>

Convenient inline extension functions for StepBuilderMethods

inline fun <T : Any> TerminalReturningMethods.toListOf(params: Map<String, Any?> = emptyMap()): DataResult<List<T>>

Convenient inline extension function for toListOf. Uses reified to automatically infer the target type.

toSingle

fun StepBuilderMethods.toSingle(vararg params: Pair<String, Any?>): TransactionStep<Map<String, Any?>?>

fun TerminalReturningMethods.toSingle(vararg params: Pair<String, Any?>): DataResult<Map<String, Any?>?>

fun AsyncTerminalMethods.toSingle(vararg params: Pair<String, Any?>, onResult: (DataResult<Map<String, Any?>?>) -> Unit): Job

toSingleOf

inline fun <T> StepBuilderMethods.toSingleOf(vararg params: Pair<String, Any?>): TransactionStep<T>

inline fun <T> StepBuilderMethods.toSingleOf(params: Map<String, Any?> = emptyMap()): TransactionStep<T>

inline fun <T> TerminalReturningMethods.toSingleOf(vararg params: Pair<String, Any?>): DataResult<T>

inline fun <T> AsyncTerminalMethods.toSingleOf(vararg params: Pair<String, Any?>, noinline onResult: (DataResult<T>) -> Unit): Job

inline fun <T> AsyncTerminalMethods.toSingleOf(params: Map<String, Any?> = emptyMap(), noinline onResult: (DataResult<T>) -> Unit): Job

inline fun <T> TerminalReturningMethods.toSingleOf(params: Map<String, Any?> = emptyMap()): DataResult<T>

Convenient inline extension function for toSingleOf. Uses reified to automatically infer the target type.

toSingleStrict

fun StepBuilderMethods.toSingleStrict(vararg params: Pair<String, Any?>): TransactionStep<Map<String, Any?>>

fun TerminalReturningMethods.toSingleStrict(vararg params: Pair<String, Any?>): DataResult<Map<String, Any?>>

fun AsyncTerminalMethods.toSingleStrict(vararg params: Pair<String, Any?>, onResult: (DataResult<Map<String, Any?>>) -> Unit): Job