# BatchUpdateStatement

open class BatchUpdateStatement(val table: IdTable<*>) : UpdateStatement

Represents the SQL statement that batch updates rows of a table.

#### Parameters

table

Identity table to update values from.

## Constructors

BatchUpdateStatement
Link copied to clipboard
constructor(table: IdTable<*>)

## Properties

data
Link copied to clipboard
val data: ArrayList<Pair<EntityID<*>, Map<Column<*>, Any?>>>

The mappings of columns to update with their updated values for each entity in the batch.

firstDataSet
Link copied to clipboard
open override val firstDataSet: List<Pair<Column<*>, Any?>>

The initial list of columns to update with their updated values.

isAlwaysBatch
Link copied to clipboard
open val isAlwaysBatch: Boolean

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

limit
Link copied to clipboard
val limit: Int?
table
Link copied to clipboard
val table: IdTable<*>
targets
Link copied to clipboard
val targets: List<Table>
targetsSet
Link copied to clipboard
val targetsSet: ColumnSet
type
Link copied to clipboard
val type: StatementType
where
Link copied to clipboard
val where: Op<Boolean>? = null

## Functions

addBatch
Link copied to clipboard
fun addBatch(id: EntityID<*>)

Adds the specified entity id to the current list of update statements, using the mapping of columns to update provided for this `BatchUpdateStatement`.

arguments
Link copied to clipboard
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.

contains
Link copied to clipboard
open operator fun contains(column: Column<*>): Boolean
execute
Link copied to clipboard
fun execute(transaction: Transaction): Int?

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
Link copied to clipboard
open override fun PreparedStatementApi.executeInternal(transaction: Transaction): Int

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.

prepared
Link copied to clipboard
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
Link copied to clipboard
open override fun prepareSQL(transaction: Transaction, prepared: Boolean): String

Returns the string representation of an SQL statement.

set
Link copied to clipboard
open operator fun <S> set(column: Column<S>, value: S)
open operator fun <T, S : T?, E : Expression<S>> set(column: Column<T>, value: E)
open operator fun <S> set(column: Column<S>, value: Query)
@JvmName(name = "setWithEntityIdExpression")
operator fun <S, ID : EntityID<S>, E : Expression<S>> set(column: Column<ID>, value: E)
@JvmName(name = "setWithNullableEntityIdValue")
operator fun <S : Any> set(column: Column<EntityID<S>?>, value: S?)
@JvmName(name = "setWithEntityIdValue")
operator fun <S : Any> set(column: Column<EntityID<S>>, value: S)
open operator fun <S> set(column: CompositeColumn<S>, value: S)
update
Link copied to clipboard
open override fun <T, S : T?> update(column: Column<T>, value: Expression<S>): Nothing

Updates the mapping of the specified column with the specified value if column has not been previously set up for a change and if value is of a valid type.

open fun <T, S : T?> update(column: Column<T>, value: SqlExpressionBuilder.() -> Expression<S>)

Updates the mapping of the specified column with the value of the provided expression.