runtime/app.cash.sqldelight/Query

Query

abstract class Query<out RowType : Any>(mapper: (SqlCursor) -> RowType) : ExecutableQuery<RowType>

A listenable, typed query generated by SQLDelight.

Parameters

RowType

the type that this query can map its result set to.

Constructors

fun <out RowType : Any> Query(mapper: (SqlCursor) -> RowType)

Types

interface Listener

An interface for listening to changes in the result set of a query.

Functions

abstract fun addListener(listener: Query.Listener)

Register a listener to be notified of future changes in the result set.

abstract fun <R> execute(mapper: (SqlCursor) -> R): QueryResult<R>

Execute the underlying statement. The resulting cursor is passed to the given block.

fun executeAsList(): List<RowType>

fun executeAsOne(): RowType

executeAsOneOrNull

fun executeAsOneOrNull(): RowType?

abstract fun removeListener(listener: Query.Listener)

Remove a listener to no longer be notified of future changes in the result set.

Properties

val mapper: (SqlCursor) -> RowType