core/org.octavius.database.builder/DatabaseUpdateQueryBuilder

DatabaseUpdateQueryBuilder

internal class DatabaseUpdateQueryBuilder(jdbcTemplate: JdbcTemplate, kotlinToPostgresConverter: KotlinToPostgresConverter, rowMappers: RowMappers, table: String) : AbstractQueryBuilder<UpdateQueryBuilder> , UpdateQueryBuilder

Internal implementation of UpdateQueryBuilder for building SQL UPDATE statements.

Constructors

DatabaseUpdateQueryBuilder

constructor(jdbcTemplate: JdbcTemplate, kotlinToPostgresConverter: KotlinToPostgresConverter, rowMappers: RowMappers, table: String)

Properties

canReturnResultsByDefault

protected open override val canReturnResultsByDefault: Boolean = false

val jdbcTemplate: JdbcTemplate

kotlinToPostgresConverter

val kotlinToPostgresConverter: KotlinToPostgresConverter

protected var recursiveWith: Boolean

returningClause

protected var returningClause: String?

val rowMappers: RowMappers

protected val table: String?

protected val withClauses: MutableList<Pair<String, String>>

Functions

open override fun asStep(): StepBuilderMethods

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.

open override fun asStream(fetchSize: Int): StreamingTerminalMethods

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

buildReturningClause

protected fun buildReturningClause(): String

Builds the SQL fragment for the RETURNING clause.

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.

open override fun copy(): DatabaseUpdateQueryBuilder

copyBaseStateFrom

protected fun copyBaseStateFrom(source: AbstractQueryBuilder<UpdateQueryBuilder>)

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

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.

open override fun from(tables: String): UpdateQueryBuilder

fun recursive(): UpdateQueryBuilder

Marks the WITH clause as recursive.

fun returning(vararg columns: String): UpdateQueryBuilder

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

open override fun setExpression(column: String, value: String): UpdateQueryBuilder

open override fun setExpressions(values: Map<String, String>): UpdateQueryBuilder

open override fun setValue(column: String): UpdateQueryBuilder

open override fun setValues(values: List<String>): UpdateQueryBuilder

open override fun setValues(values: Map<String, Any?>): UpdateQueryBuilder

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.

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.

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.

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?>>.

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.

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

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

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.

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

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

fun toSql(): String

Returns the generated SQL string without executing the query.

open override fun toString(): String

open override fun where(condition: String): UpdateQueryBuilder

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

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