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

BaseBatchInsertStatement

abstract class BaseBatchInsertStatement(table: Table, ignore: Boolean, shouldReturnGeneratedValues: Boolean = true) : InsertStatement<List<ResultRow>>

Base class representing the SQL statement that batch inserts new rows into a table.

Parameters

shouldReturnGeneratedValues

Specifies whether newly generated values (for example, auto-incremented IDs) should be returned. See Batch Insert for more details.

Inheritors

BatchInsertStatement

BatchReplaceStatement

BatchUpsertStatement

Constructors

BaseBatchInsertStatement

constructor(table: Table, ignore: Boolean, shouldReturnGeneratedValues: Boolean = true)

Properties

arguments

open override var arguments: List<List<Pair<Column<*>, Any?>>>?

insertedCount

var insertedCount: Int

The number of rows affected by the insert operation.

isAlwaysBatch

open override val isAlwaysBatch: Boolean = true

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

isIgnore

val isIgnore: Boolean

resultedValues

var resultedValues: List<ResultRow>?

The ResultRows generated by processing the database result set retrieved after executing the statement.

table

val table: Table

targets

val targets: List<Table>

type

val type: StatementType

Functions

addBatch

fun addBatch()

Adds the most recent batch to the current list of insert statements.

arguments

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

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

contains

open operator fun contains(column: Column<*>): Boolean

execute

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

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.

get

infix operator fun <T> get(column: Column<T>): T

infix operator fun <T> get(column: CompositeColumn<T>): T

getOrNull

fun <T> getOrNull(column: Column<T>): T?

Returns the value of a given column from the first stored ResultRow, or null if either no results were retrieved from the database or if the column cannot be found in the row.

prepared

open override 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.

set

open operator override 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

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.

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

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.