Converts this builder to a StepBuilder, which enables lazy execution within a transaction. Returns a wrapper with terminal methods that create TransactionStep instead of executing the query.

asStream

open override fun asStream(fetchSize: Int): StreamingTerminalMethods

async

open override fun async(scope: CoroutineScope, ioDispatcher: CoroutineDispatcher): AsyncTerminalMethods

buildReturningClause

protected fun buildReturningClause(): String

Builds the SQL fragment for the RETURNING clause.

buildSql

open override fun buildSql(): String

Builds the final SQL query based on the builder's state. Must be implemented by each concrete builder class.

buildWithClause

protected fun buildWithClause(): String

Creates a formatted SQL fragment for the WITH clause based on added queries. Each CTE is on a new line for readability.

columns

open override fun columns(vararg columns: String): InsertQueryBuilder

copy

open override fun copy(): DatabaseInsertQueryBuilder

Creates and returns a deep copy of this builder. Enables safe creation of query variants without modifying the original.

copyBaseStateFrom

protected fun copyBaseStateFrom(source: AbstractQueryBuilder<InsertQueryBuilder>)

Copies state from another builder of the same type. Used by copy() methods in derived classes.

execute

fun execute(params: Map<String, Any?>): DataResult<Int>

Executes a modifying query (without RETURNING) and returns the number of affected rows. Throws an exception if a RETURNING clause was used - in that case, use toList(), toSingle(), etc. methods instead.

protected fun <R> execute(sql: String, params: Map<String, Any?>, action: (positionalSql: String, positionalParams: List<Any?>) -> DataResult<R>): DataResult<R>

Generic function for executing queries, wrapping logic in error handling, type conversion, and logging.

fromSelect

open override fun fromSelect(query: String): InsertQueryBuilder

onConflict

open override fun onConflict(config: OnConflictClauseBuilder.() -> Unit): InsertQueryBuilder

Configures the ON CONFLICT clause in a fluent and safe manner. Example: .onConflict { onColumns("email") doUpdate("last_login = NOW()") }

recursive

fun recursive(): InsertQueryBuilder

Marks the WITH clause as recursive.

returning

fun returning(vararg columns: String): InsertQueryBuilder

Adds a RETURNING clause to the modifying query (INSERT, UPDATE, DELETE).

toColumn

fun <T> toColumn(targetType: KType, params: Map<String, Any?>): DataResult<List<T>>

Executes the query and returns a list of values from the first column of all rows.

toField

fun <T> toField(targetType: KType, params: Map<String, Any?>): DataResult<T>

Executes the query and returns the value from the first column of the first row.

toFieldStrict

fun <T> toFieldStrict(targetType: KType, params: Map<String, Any?>): DataResult<T>

Executes the query and returns the value from the first column of the first row. Always fails on empty result.

toList

fun toList(params: Map<String, Any?>): DataResult<List<Map<String, Any?>>>

Executes the query and returns a list of rows as List<Map<String, Any?>>.

toListOf

fun <T> toListOf(kType: KType, params: Map<String, Any?>): DataResult<List<T>>

Executes the query and maps results to a list of objects of the given type.

toSingle

fun toSingle(params: Map<String, Any?>): DataResult<Map<String, Any?>?>

Executes the query and returns a single row as Map<String, Any?>?.

toSingleOf

fun <T> toSingleOf(kType: KType, params: Map<String, Any?>): DataResult<T>

Executes the query and maps the result to a single object of the given type.

toSingleStrict

fun toSingleStrict(params: Map<String, Any?>): DataResult<Map<String, Any?>>

Executes the query and returns the first row. Always fails on empty result.

toSql

fun toSql(): String

Returns the generated SQL string without executing the query.

toString

open override fun toString(): String

value

open override fun value(column: String): InsertQueryBuilder

valueExpression

open override fun valueExpression(column: String, expression: String): InsertQueryBuilder

values

open override fun values(values: List<String>): InsertQueryBuilder

open override fun values(data: Map<String, Any?>): InsertQueryBuilder

valuesExpressions

open override fun valuesExpressions(expressions: Map<String, String>): InsertQueryBuilder

with

fun with(name: String, query: String): InsertQueryBuilder

Adds a query to the WITH clause (Common Table Expression).