client/io.github.octaviusframework.client.query/InsertQuery

InsertQuery

class InsertQuery @PublishedApi constructor(provider: SessionProvider, table: String) : RunnableQuery<InsertQuery>

An INSERT under construction. value and values declare a column together with its @name placeholder in VALUES, so the two lists cannot drift; valueExpression puts SQL there instead - now(), DEFAULT, a subselect. The values are supplied at the terminal.

val id = db.insertInto("citizens")
    .values(listOf("cognomen", "tribe"))
    .valueExpression("enrolled_at", "now()")
    .onConflict {
        onColumns("cognomen")
        doUpdate("tribe = excluded.tribe")
    }
    .returning("id")
    .fetchFieldStrict<Int>("cognomen" to "Marcus", "tribe" to "Cornelia")

Constructors

InsertQuery

@PublishedApi

internal constructor(provider: SessionProvider, table: String)

Properties

queryParameterConverters

@PublishedApi

internal var queryParameterConverters: MutableList<ParameterConverter<*>>?

queryProvider

@PublishedApi

internal val queryProvider: SessionProvider

Decides which session the terminals run on.

queryResultConverters

@PublishedApi

internal var queryResultConverters: MutableList<ResultConverter<*, *>>?

Functions

asResult

fun asResult(): ResultQuery

This query with terminals that return a DataResult instead of throwing, on the boundary dbResult applies - a fetch*Strict that found no row still throws.

asStep

fun asStep(): StepBuilder

Turns this query into a step of a TransactionPlan instead of running it. The parameters given at the step's terminal may hold TransactionValues pointing at earlier steps.

columns

fun columns(vararg columns: String): InsertQuery

The target columns of an INSERT … SELECT, for fromSelect; the VALUES form declares its own.

copy

fun copy(): InsertQuery

Returns an independent copy, so that variants can be built from a shared base.

copyConvertersFrom

internal fun copyConvertersFrom(other: RunnableQuery<*>)

Carries registered converters into a builder's copy(), alongside whatever clauses it copies.

executeUpdate

fun executeUpdate(params: Map<String, Any?> = emptyMap()): Long

fun executeUpdate(vararg params: Pair<String, Any?>): Long

Runs the statement and returns how many rows it affected.

fetchField

inline fun <T> fetchField(params: Map<String, Any?> = emptyMap()): T

Runs the query and returns the first column of its single row as T. A nullable T gives null for a missing row or a NULL; a non-nullable one throws for either.

inline fun <T> fetchField(vararg params: Pair<String, Any?>): T

Runs the query and returns the first column of its single row as T.

fetchFields

inline fun <T> fetchFields(params: Map<String, Any?> = emptyMap()): List<T>

inline fun <T> fetchFields(vararg params: Pair<String, Any?>): List<T>

Runs the query and returns the first column of every row as T.

fetchFieldStrict

inline fun <T> fetchFieldStrict(params: Map<String, Any?> = emptyMap()): T

inline fun <T> fetchFieldStrict(vararg params: Pair<String, Any?>): T

As fetchField, but the query must return exactly one row rather than at most one.

fetchObject

inline fun <T : Any> fetchObject(params: Map<String, Any?> = emptyMap()): T?

inline fun <T : Any> fetchObject(vararg params: Pair<String, Any?>): T?

Runs the query and maps its single row onto T, or null where none matched.

fetchObjects

inline fun <T : Any> fetchObjects(params: Map<String, Any?> = emptyMap()): List<T>

inline fun <T : Any> fetchObjects(vararg params: Pair<String, Any?>): List<T>

Runs the query and maps every row onto T.

fetchObjectStrict

inline fun <T : Any> fetchObjectStrict(params: Map<String, Any?> = emptyMap()): T

inline fun <T : Any> fetchObjectStrict(vararg params: Pair<String, Any?>): T

Runs the query and maps its single row onto T, throwing where the count was anything but one.

fetchRow

fun fetchRow(params: Map<String, Any?> = emptyMap()): Row?

fun fetchRow(vararg params: Pair<String, Any?>): Row?

Runs the query and returns its single row, or null where none matched.

fetchRows

fun fetchRows(params: Map<String, Any?> = emptyMap()): List<Row>

fun fetchRows(vararg params: Pair<String, Any?>): List<Row>

Runs the query and returns every row.

fetchRowStrict

fun fetchRowStrict(params: Map<String, Any?> = emptyMap()): Row

fun fetchRowStrict(vararg params: Pair<String, Any?>): Row

Runs the query and returns its single row, throwing where the count was anything but one.

forEachField

inline fun <T> forEachField(params: Map<String, Any?> = emptyMap(), fetchSize: Int, noinline block: (T) -> Unit)

Runs the query and hands the first column of each row, as T, to block as forEachRow does.

inline fun <T> forEachField(vararg params: Pair<String, Any?>, fetchSize: Int, noinline block: (T) -> Unit)

Runs the query and hands the first column of each row, as T, to block as it arrives.

forEachObject

inline fun <T : Any> forEachObject(params: Map<String, Any?> = emptyMap(), fetchSize: Int, noinline block: (T) -> Unit)

Runs the query and hands each row, mapped onto T, to block as it arrives, as forEachRow does.

inline fun <T : Any> forEachObject(vararg params: Pair<String, Any?>, fetchSize: Int, noinline block: (T) -> Unit)

Runs the query and hands each row, mapped onto T, to block as it arrives.

forEachRow

fun forEachRow(params: Map<String, Any?> = emptyMap(), fetchSize: Int, block: (Row) -> Unit)

Runs the query and hands each row to block as it arrives, so a result too large to hold is streamed. block runs while the result is still being read, and a query from inside it is refused with CONNECTION_BUSY.

fun forEachRow(vararg params: Pair<String, Any?>, fetchSize: Int, block: (Row) -> Unit)

Runs the query and hands each row to block as it arrives, in batches of fetchSize.

fromSelect

fun fromSelect(query: String): InsertQuery

Inserts the rows query produces instead of a VALUES list. Another builder's toSql fits.

onConflict

fun onConflict(config: OnConflictClause.() -> Unit): InsertQuery

Configures the ON CONFLICT clause.

overriding

fun overriding(value: OverridingValue?): InsertQuery

Adds OVERRIDING SYSTEM VALUE or OVERRIDING USER VALUE, to the VALUES form and to fromSelect alike. null leaves it out.

preparedQuery

@PublishedApi

internal fun OctaviusSessionOperations.preparedQuery(): NamedParameterQuery

The driver query every terminal runs, carrying this query's own converters.

querySql

internal open override fun querySql(): String

Renders the SQL. Called once per terminal call, so a builder may put off assembling it until here.

recursive

fun recursive(): InsertQuery

Marks the WITH clause RECURSIVE.

registerParameterConverter

fun registerParameterConverter(converter: ParameterConverter<*>): InsertQuery

Registers a ParameterConverter for this query alone, on the terms of registerResultConverter.

registerResultConverter

fun registerResultConverter(converter: ResultConverter<*, *>): InsertQuery

Registers a ResultConverter for this query alone, consulted ahead of the session's. A later registration here wins over an earlier one.

returning

fun returning(vararg columns: String): InsertQuery

Adds a RETURNING clause, which turns this into a query the fetch* family can read.

toSql

fun toSql(): String

Renders the SQL this query would send. A query never carries parameters, so its @name placeholders survive embedding it in a WITH, a subquery or a UNION, and are bound by whoever runs the outer statement. Not cached: a builder walks its clauses again on every call.

value

fun value(column: String): InsertQuery

Declares one column, taking its value from the @column parameter.

valueExpression

fun valueExpression(column: String, expression: String): InsertQuery

Declares one column taking a SQL expression rather than a parameter - now(), DEFAULT, a subselect.

values

fun values(columns: List<String>): InsertQuery

Declares columns, each taking its value from the parameter of the same name.

fun values(data: Map<String, Any?>): InsertQuery

Declares columns from data's keys, each taking its value from the parameter of the same name. The map's values are not read, so pass it to the terminal too: insertInto("t").values(row).executeUpdate(row).

valuesExpressions

fun valuesExpressions(expressions: Map<String, String>): InsertQuery

As valueExpression, for several columns at once.

with

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

Adds a common table expression. Call it more than once for more than one.