exposed-core/org.jetbrains.exposed.sql.statements/ReturningStatement

ReturningStatement

open class ReturningStatement(val table: Table, val returningExpressions: List<Expression<*>>, val mainStatement: Statement<*>) : Statement<ResultSet> , Iterable<ResultRow>

Represents the underlying SQL mainStatement that also returns a result set with data from any modified rows.

Parameters

table

Table to perform the main statement on and return results from.

returningExpressions

Columns or expressions to include in the returned result set.

mainStatement

The statement to append the RETURNING clause to. This may be an insert, update, or delete statement.

Constructors

ReturningStatement

constructor(table: Table, returningExpressions: List<Expression<*>>, mainStatement: Statement<*>)

Properties

isAlwaysBatch

open val isAlwaysBatch: Boolean

Whether the SQL statement is meant to be performed as part of a batch execution.

mainStatement

val mainStatement: Statement<*>

returningExpressions

val returningExpressions: List<Expression<*>>

table

val table: Table

targets

val targets: List<Table>

type

val type: StatementType

Functions

appendTo

fun <T> Iterable<T>.appendTo(builder: QueryBuilder, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", transform: QueryBuilder.(T) -> Unit): QueryBuilder

Appends all the elements separated using separator and using the given prefix and postfix if supplied.

arguments

open override fun arguments(): Iterable<Iterable<Pair<IColumnType<*>, Any?>>>

Returns all mappings of columns and expression types to their values needed to prepare an SQL statement.

execute

fun execute(transaction: Transaction): ResultSet?

Executes the SQL statement directly in the provided transaction and returns the generated result, or null if either no result was retrieved or if the transaction blocked statement execution.

executeInternal

open override fun PreparedStatementApi.executeInternal(transaction: Transaction): ResultSet

Determines the exact way that an SQL statement is executed in a transaction and applies any necessary logic before returning the result generated by the executed statement.

forEach

open fun forEach(p0: Consumer<in ResultRow>)

iterator

open operator override fun iterator(): Iterator<ResultRow>

prepared

open fun prepared(transaction: Transaction, sql: String): PreparedStatementApi

Uses a transaction connection and an sql string representation to return a precompiled SQL statement, stored as an implementation of PreparedStatementApi.

prepareSQL

open override fun prepareSQL(transaction: Transaction, prepared: Boolean): String

Returns the string representation of an SQL statement.

spliterator

open fun spliterator(): Spliterator<ResultRow>