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

BaseBatchInsertStatement

abstract class BaseBatchInsertStatement( table: Table, ignore: Boolean, val 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?>>>?

data

val data: ArrayList<MutableMap<Column<*>, Any?>>

insertedCount

var insertedCount: Int

The number of rows affected by the insert operation.

isIgnore

val isIgnore: Boolean

resultedValues

var resultedValues: List<ResultRow>?

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

shouldReturnGeneratedValues

val shouldReturnGeneratedValues: Boolean = true

table

val table: Table

targets

val targets: List<Table>

type

val type: StatementType

values

val values: MutableMap<Column<*>, Any?>

The mapping of columns scheduled for change with their new values.

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.

columnsWithDatabaseDefaults

fun columnsWithDatabaseDefaults(): List<Column<*>>

Returns the list of columns with default values that can not be taken locally. It is the columns defined with defaultExpression(), databaseGenerated()

contains

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

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.

prepareSQL

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

Returns the string representation of an SQL statement.

removeLastBatch

fun removeLastBatch()

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: AbstractQuery<*>)

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

validateLastBatch

open fun validateLastBatch()