RowApi

interface RowApi

Base representation for accessing data rows by column index or name.

Provides methods to retrieve objects from a row using a one-based column index or a column name, with optional type conversion for strongly-typed results.

Functions

Link copied to clipboard
fun RowApi.asColumnMetadata(prefetchedColumnTypes: Map<String, String> = emptyMap()): ColumnMetadata

Extracts result data about a specific column as ColumnMetadata.

Link copied to clipboard
abstract fun getObject(index: Int): Any?

Retrieves an object from the current data row at the specified index position.

abstract fun getObject(name: String): Any?

Retrieves an object from the current data row with the specified column name.

abstract fun <T> getObject(index: Int, type: Class<T>): T?

Retrieves an object from the current data row at the specified index position, and converts the stored SQL type to the requested type, if the conversion is supported.

abstract fun <T> getObject(name: String, type: Class<T>): T?

Retrieves an object from the current data row with the specified column name, and converts the stored SQL type to the requested type, if the conversion is supported.

open fun <T> getObject(index: Int, type: Class<T>?, columnType: IColumnType<*>): T?

Retrieves an object from the current data row at the specified index position, and converts the stored SQL type to the requested type, if the conversion is supported, using an additional column type hint.

open fun <T> getObject(name: String, type: Class<T>, columnType: IColumnType<*>): T?

Retrieves an object from the current data row with the specified column name, and converts the stored SQL type to the requested type, if the conversion is supported, using an additional column type hint.