//tempest2/app.cash.tempest2/SecondaryIndex

SecondaryIndex

[jvm]\ interface SecondaryIndex<K : Any, I : Any> : Scannable<K, I> , Queryable<K, I>

Types

Name	Summary
Factory	[jvm] interface Factory

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.
scan	[jvm] open fun scan(): Page<K, I> open fun scan(initialOffset: Offset<K>?): Page<K, I> open fun scan(config: ScanConfig): Page<K, I> open fun scan(config: ScanConfig, initialOffset: Offset<K>?): Page<K, I> [jvm] abstract fun scan(pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null, workerId: WorkerId? = null): Page<K, I> Scans up to the pageSize items or a maximum of 1 MB of data. This limit applies before the filter expression is evaluated.
scanAll	[jvm] open fun scanAll(): Sequence<Page<K, I>> open fun scanAll(initialOffset: Offset<K>?): Sequence<Page<K, I>> [jvm] open fun scanAll(config: ScanConfig): Sequence<Page<K, I>> open fun scanAll(config: ScanConfig, initialOffset: Offset<K>?): Sequence<Page<K, I>> abstract fun scanAll(pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null): Sequence<Page<K, I>> Executes a scan 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.
scanAllContents	[jvm] open fun scanAllContents(): Sequence<I> open fun scanAllContents(initialOffset: Offset<K>?): Sequence<I> [jvm] open fun scanAllContents(config: ScanConfig): Sequence<I> open fun scanAllContents(config: ScanConfig, initialOffset: Offset<K>?): Sequence<I> abstract fun scanAllContents(pageSize: Int = 100, consistentRead: Boolean = false, filterExpression: Expression? = null, initialOffset: Offset<K>? = null): Sequence<I> Executes a scan 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.