Skip to content

//tempest2/app.cash.tempest2/Queryable

Queryable

interface Queryable<K : Any, I : Any>

Inheritors

InlineView
SecondaryIndex

Functions

Name Summary
query [jvm]
open fun query(keyCondition: KeyCondition<K>): Page<K, I>
open fun query(keyCondition: KeyCondition<K>, initialOffset: Offset<K>?): Page<K, I>
open fun query(keyCondition: KeyCondition<K>, config: QueryConfig): Page<K, I>
open fun query(keyCondition: KeyCondition<K>, config: QueryConfig, initialOffset: Offset<K>?): Page<K, I>
[jvm]
abstract fun query(keyCondition: KeyCondition<K>, asc: Boolean = true, pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null, returnConsumedCapacity: ReturnConsumedCapacity? = null): Page<K, I>
Reads up to the pageSize items or a maximum of 1 MB of data. This limit applies before the filter expression is evaluated.
queryAll [jvm]
open fun queryAll(keyCondition: KeyCondition<K>): Sequence<Page<K, I>>
open fun queryAll(keyCondition: KeyCondition<K>, initialOffset: Offset<K>?): Sequence<Page<K, I>>
open fun queryAll(keyCondition: KeyCondition<K>, config: QueryConfig): Sequence<Page<K, I>>
open fun queryAll(keyCondition: KeyCondition<K>, config: QueryConfig, initialOffset: Offset<K>?): Sequence<Page<K, I>>
[jvm]
abstract fun queryAll(keyCondition: KeyCondition<K>, asc: Boolean = true, pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null): Sequence<Page<K, I>>
Executes a query and returns a sequence of pages that contains all results, regardless of page size. New pages will be fetched as needed when the resulting sequence is enumerated.
queryAllContents [jvm]
open fun queryAllContents(keyCondition: KeyCondition<K>): Sequence<I>
open fun queryAllContents(keyCondition: KeyCondition<K>, initialOffset: Offset<K>?): Sequence<I>
open fun queryAllContents(keyCondition: KeyCondition<K>, config: QueryConfig): Sequence<I>
open fun queryAllContents(keyCondition: KeyCondition<K>, config: QueryConfig, initialOffset: Offset<K>?): Sequence<I>
[jvm]
abstract fun queryAllContents(keyCondition: KeyCondition<K>, asc: Boolean = true, pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null): Sequence<I>
Executes a query and returns a sequence that contains all results, regardless of page size. New pages will be fetched as needed when the resulting sequence is enumerated.