Package-level declarations
Types
Link copied to clipboard
interface DeleteQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<DeleteQueryBuilder>
Defines the public API for building SQL DELETE queries.
Link copied to clipboard
interface InsertQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<InsertQueryBuilder>
Defines the public API for building SQL INSERT queries.
Link copied to clipboard
interface IterativeTerminalMethods
Link copied to clipboard
Controls the waiting behavior when acquiring row-level locks in a SELECT query.
Link copied to clipboard
interface OnConflictClauseBuilder
Configurator for the ON CONFLICT clause in an INSERT query.
Link copied to clipboard
Link copied to clipboard
data class QueryOptions(val typeHandlers: List<TypeHandler<*>> = emptyList(), val compositeAsMapTypes: Set<QualifiedName> = emptySet(), val customCompositeMappers: Map<QualifiedName, PgCompositeMapper<*>> = emptyMap(), val returnAllCompositesAsMaps: Boolean = false, val json: Json? = null)
Configuration options for a single database query.
Link copied to clipboard
interface QueryOptionsBuilder
Builder for QueryOptions, providing a DSL for configuration.
Link copied to clipboard
interface RawQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<RawQueryBuilder>
Defines the public API for passing a complete raw SQL query.
Link copied to clipboard
Defines the public API for building SQL SELECT queries.
Link copied to clipboard
interface StepBuilderMethods
Interface for StepBuilder - contains the same terminal methods as TerminalReturningMethods and TerminalModificationMethods, but returns TransactionStep instead of executing queries.
Link copied to clipboard
interface TerminalModificationMethods
Interface containing terminal modification method
Link copied to clipboard
interface TerminalReturningMethods
Interface containing terminal methods that return data
Link copied to clipboard
interface UpdateQueryBuilder : TerminalReturningMethods, TerminalModificationMethods, QueryBuilder<UpdateQueryBuilder>
Defines the public API for building SQL UPDATE queries.
Functions
Link copied to clipboard
Link copied to clipboard
fun IterativeTerminalMethods.forEachRow(vararg params: Pair<String, Any?>, action: (row: Map<String, Any?>) -> Unit): DataResult<Unit>
Link copied to clipboard
inline fun <T : Any> IterativeTerminalMethods.forEachRowOf(params: Map<String, Any?> = emptyMap(), noinline action: (obj: T) -> Unit): DataResult<Unit>
inline fun <T : Any> IterativeTerminalMethods.forEachRowOf(vararg params: Pair<String, Any?>, noinline action: (obj: T) -> Unit): DataResult<Unit>
fun <T : Any> IterativeTerminalMethods.forEachRowOf(mapper: DataMapper<T>, vararg params: Pair<String, Any?>, action: (obj: T) -> Unit): DataResult<Unit>
Link copied to clipboard
inline fun <T> StepBuilderMethods.toColumn(params: Map<String, Any?> = emptyMap()): TransactionStep<List<T>>
inline fun <T> StepBuilderMethods.toColumn(vararg params: Pair<String, Any?>): TransactionStep<List<T>>
inline fun <T> TerminalReturningMethods.toColumn(params: Map<String, Any?> = emptyMap()): DataResult<List<T>>
inline fun <T> TerminalReturningMethods.toColumn(vararg params: Pair<String, Any?>): DataResult<List<T>>
Link copied to clipboard
inline fun <T> StepBuilderMethods.toField(params: Map<String, Any?> = emptyMap()): TransactionStep<T>
inline fun <T> TerminalReturningMethods.toField(params: Map<String, Any?> = emptyMap()): DataResult<T>
Link copied to clipboard
inline fun <T> StepBuilderMethods.toFieldStrict(params: Map<String, Any?> = emptyMap()): TransactionStep<T>
inline fun <T> StepBuilderMethods.toFieldStrict(vararg params: Pair<String, Any?>): TransactionStep<T>
inline fun <T> TerminalReturningMethods.toFieldStrict(params: Map<String, Any?> = emptyMap()): DataResult<T>
inline fun <T> TerminalReturningMethods.toFieldStrict(vararg params: Pair<String, Any?>): DataResult<T>
Link copied to clipboard
inline fun <T : Any> StepBuilderMethods.toListOf(params: Map<String, Any?> = emptyMap()): TransactionStep<List<T>>
inline fun <T : Any> StepBuilderMethods.toListOf(vararg params: Pair<String, Any?>): TransactionStep<List<T>>
inline fun <T : Any> TerminalReturningMethods.toListOf(params: Map<String, Any?> = emptyMap()): DataResult<List<T>>
inline fun <T : Any> TerminalReturningMethods.toListOf(vararg params: Pair<String, Any?>): DataResult<List<T>>
fun <T : Any> StepBuilderMethods.toListOf(vararg params: Pair<String, Any?>, mapper: DataMapper<T>): TransactionStep<List<T>>
fun <T : Any> TerminalReturningMethods.toListOf(vararg params: Pair<String, Any?>, mapper: DataMapper<T>): DataResult<List<T>>
Link copied to clipboard
fun StepBuilderMethods.toSingle(vararg params: Pair<String, Any?>): TransactionStep<Map<String, Any?>?>
fun TerminalReturningMethods.toSingle(vararg params: Pair<String, Any?>): DataResult<Map<String, Any?>?>
Link copied to clipboard
inline fun <T> StepBuilderMethods.toSingleOf(params: Map<String, Any?> = emptyMap()): TransactionStep<T>
inline fun <T> TerminalReturningMethods.toSingleOf(params: Map<String, Any?> = emptyMap()): DataResult<T>
inline fun <T> TerminalReturningMethods.toSingleOf(vararg params: Pair<String, Any?>): DataResult<T>
inline fun <T> StepBuilderMethods.toSingleOf(params: Map<String, Any?> = emptyMap(), mapper: DataMapper<T & Any>): TransactionStep<T>
inline fun <T> StepBuilderMethods.toSingleOf(vararg params: Pair<String, Any?>, mapper: DataMapper<T & Any>): TransactionStep<T>
inline fun <T> TerminalReturningMethods.toSingleOf(params: Map<String, Any?> = emptyMap(), mapper: DataMapper<T & Any>): DataResult<T>
inline fun <T> TerminalReturningMethods.toSingleOf(vararg params: Pair<String, Any?>, mapper: DataMapper<T & Any>): DataResult<T>
Link copied to clipboard
fun StepBuilderMethods.toSingleStrict(vararg params: Pair<String, Any?>): TransactionStep<Map<String, Any?>>
fun TerminalReturningMethods.toSingleStrict(vararg params: Pair<String, Any?>): DataResult<Map<String, Any?>>