//tempest2/app.cash.tempest2/InlineView
InlineView¶
[jvm]\ interface InlineView<K : Any, I : Any> : View<K, I> , Scannable<K, I> , Queryable<K, I>
Types¶
Name | Summary |
---|---|
Factory | [jvm] interface Factory |
Functions¶
Name | Summary |
---|---|
delete | [jvm] open fun delete(item: I): I? [jvm] abstract fun delete(item: I, deleteExpression: Expression? = null): I? Deletes item from its DynamoDB table using deleteExpression. Any options specified in the deleteExpression parameter will be overlaid on any constraints due to versioned attributes. |
deleteKey | [jvm] open fun deleteKey(key: K): I? [jvm] abstract fun deleteKey(key: K, deleteExpression: Expression? = null): I? Deletes the item identified by key from its DynamoDB table using deleteExpression. Any options specified in the deleteExpression parameter will be overlaid on any constraints due to versioned attributes. |
load | [jvm] open fun load(key: K): I? abstract fun load(key: K, consistentReads: Boolean = false, returnConsumedCapacity: ReturnConsumedCapacity = ReturnConsumedCapacity.TOTAL): Pair<I?, ConsumedCapacity?> [jvm] abstract fun load(key: K, consistentReads: Boolean = false): I? Returns an item whose keys match those of the prototype key object given, or null if no such item exists. |
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. |
save | [jvm] open fun save(item: I) [jvm] abstract fun save(item: I, saveExpression: Expression? = null) Saves an item in DynamoDB. This method uses DynamoDbClient.putItem to clear and replace all attributes, including unmodeled ones, on save. Partial update, i.e. DynamoDbClient.updateItem, is not supported yet. |
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. |