PowerSync Core/com.powersync.db/Queries

Queries

interface Queries

Inheritors

PowerSyncDatabase

Types

Companion

object Companion

Functions

execute

abstract suspend fun execute(sql: String, parameters: List<Any?>? = listOf()): Long

Executes a write query (INSERT, UPDATE, DELETE).

get

abstract suspend fun <RowType : Any> get(sql: String, parameters: List<Any?>? = listOf(), mapper: (SqlCursor) -> RowType): RowType

Executes a read-only (SELECT) query and returns a single result.

getAll

abstract suspend fun <RowType : Any> getAll(sql: String, parameters: List<Any?>? = listOf(), mapper: (SqlCursor) -> RowType): List<RowType>

Executes a read-only (SELECT) query and returns all results.

getOptional

abstract suspend fun <RowType : Any> getOptional(sql: String, parameters: List<Any?>? = listOf(), mapper: (SqlCursor) -> RowType): RowType?

Executes a read-only (SELECT) query and returns a single optional result.

onChange

abstract fun onChange(tables: Set<String>, throttleMs: Long = DEFAULT_THROTTLE.inWholeMilliseconds, triggerImmediately: Boolean = true): Flow<Set<String>>

Returns a Flow that emits whenever the source tables are modified.

readLock

abstract suspend fun <R> readLock(callback: ThrowableLockCallback<R>): R

Takes a read lock without starting a transaction.

readTransaction

abstract suspend fun <R> readTransaction(callback: ThrowableTransactionCallback<R>): R

Opens a read-only transaction.

watch

abstract fun <RowType : Any> watch(sql: String, parameters: List<Any?>? = listOf(), throttleMs: Long = DEFAULT_THROTTLE.inWholeMilliseconds, mapper: (SqlCursor) -> RowType): Flow<List<RowType>>

Executes a read-only (SELECT) query every time the source tables are modified and returns the results as a Flow of lists.

writeLock

abstract suspend fun <R> writeLock(callback: ThrowableLockCallback<R>): R

Takes a global lock without starting a transaction.

writeTransaction

abstract suspend fun <R> writeTransaction(callback: ThrowableTransactionCallback<R>): R

Opens a read-write transaction.