# PreparedStatementApi

interface PreparedStatementApi

Represents a precompiled SQL statement.

## Functions

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

Sets the value for each column or expression in args into the appropriate statement parameter and returns the number of parameters filled.

set
Link copied to clipboard
abstract fun set(index: Int, value: Any, columnType: IColumnType<*>)

Sets the statement parameter at the index position to the provided non-null value, with a type determined by its associated columnType.

setArray
Link copied to clipboard
abstract fun setArray(index: Int, type: ArrayColumnType<*, *>, array: Array<*>)

Sets the statement parameter at the index position to the provided array, with a type determined by its associated array column type.

setInputStream
Link copied to clipboard
abstract fun setInputStream(index: Int, inputStream: InputStream, setAsBlobObject: Boolean)

Sets the statement parameter at the index position to the provided inputStream, either directly as a BLOB if `setAsBlobObject` is `true` or as determined by the driver.

setNull
Link copied to clipboard
abstract fun setNull(index: Int, columnType: IColumnType<*>)

Sets the statement parameter at the index position to SQL NULL, if allowed wih the specified columnType.