api/dev.kord.cache.api/Query

Query

interface Query<T : Any>

A lazy query. Functions in this class should be handled as if they are operating on cold Flows.

Types

object Companion

Functions

abstract fun asFlow(): Flow<T>

Executes the query and returns the values as a Flow.

open suspend fun count(): Long

Returns the amount of values that match this query.

abstract suspend fun remove()

Removes all the values that match this query.

open suspend fun single(): T

Returns the only value that matches against this query, or throws an Exception on no or multiple matches.

open suspend fun singleOrNull(): T?

Returns the only value that matches against this query if present, null if no, or throws a Exception.

open suspend fun toCollection(): Collection<T>

Executes the query and returns the values as a Collection.

abstract suspend fun update(mapper: suspend (T) -> T)

Applies the mapper to the values that match against this query. Returning a value with a different DataDescription.indexField value will result in an Exception being thrown.