# R2dbcPreparedStatementApi

interface R2dbcPreparedStatementApi : PreparedStatementApi

Base class representing a precompiled SQL io.r2dbc.spi.Statement from the R2DBC SPI.

#### Inheritors

R2dbcPreparedStatementImpl

## Functions

addBatch
Link copied to clipboard
abstract suspend fun addBatch()

Adds parameters to the statement's batch of SQL commands.

executeBatch
Link copied to clipboard
abstract suspend fun executeBatch(): List<Int>

Executes batched SQL statements stored as an io.r2dbc.spi.Statement.

executeMultiple
Link copied to clipboard
abstract suspend fun executeMultiple(): List<StatementResult>

Executes multiple SQL statements stored in a single io.r2dbc.spi.Statement.

executeQuery
Link copied to clipboard
abstract suspend fun executeQuery(): R2dbcResult

Executes an SQL query stored in an io.r2dbc.spi.Statement.

executeUpdate
Link copied to clipboard
abstract suspend fun executeUpdate()

Executes an SQL statement stored in an io.r2dbc.spi.Statement.

fillParameters
Link copied to clipboard
open fun fillParameters(args: Iterable<Pair<IColumnType<*>, Any?>>): Int
getResultRow
Link copied to clipboard
abstract suspend fun getResultRow(): R2dbcResult?

The R2dbcResult generated by the executed statement, or `null` if none was retrieved.

set
Link copied to clipboard
abstract fun set(index: Int, value: Any, columnType: IColumnType<*>)
setArray
Link copied to clipboard
abstract fun setArray(index: Int, type: ArrayColumnType<*, *>, array: Array<*>)
setFetchSize
Link copied to clipboard
abstract suspend fun setFetchSize(value: Int?)

Set the number of result set rows that should be fetched when generated by an executed statement.

setInputStream
Link copied to clipboard
abstract fun setInputStream(index: Int, inputStream: InputStream, setAsBlobObject: Boolean)
setNull
Link copied to clipboard
abstract fun setNull(index: Int, columnType: IColumnType<*>)
setTimeout
Link copied to clipboard
abstract suspend fun setTimeout(value: Int?)

Set the number of seconds the R2DBC driver will wait for a statement to execute.