Skip to content

//tempest2/app.cash.tempest2/LogicalDb

LogicalDb

[jvm]\ interface LogicalDb : LogicalTable.Factory

A collection of tables that implement the DynamoDB best practice of putting multiple item types into the same storage table. This makes it possible to perform aggregate operations and transactions on those item types.

Types

Name Summary
Companion [jvm]
object Companion

Functions

Name Summary
batchLoad [jvm]
open fun batchLoad(keys: Iterable<Any>): ItemSet
open fun batchLoad(vararg keys: Any, consistentReads: Boolean = false): ItemSet
open fun batchLoad(keys: Iterable<Any>, consistentReads: Boolean): ItemSet
open fun batchLoad(vararg keys: Any, consistentReads: Boolean = false, maxPageSize: Int = MAX_BATCH_READ, returnConsumedCapacity: ReturnConsumedCapacity = ReturnConsumedCapacity.NONE): ItemSet
open fun batchLoad(keys: Iterable<Any>, consistentReads: Boolean = false, maxPageSize: Int = MAX_BATCH_READ, returnConsumedCapacity: ReturnConsumedCapacity = ReturnConsumedCapacity.NONE): ItemSet
[jvm]
abstract fun batchLoad(keys: KeySet, consistentReads: Boolean = false, maxPageSize: Int = MAX_BATCH_READ, returnConsumedCapacity: ReturnConsumedCapacity = ReturnConsumedCapacity.NONE): ItemSet
Retrieves multiple items from multiple tables using their primary keys.
batchWrite [jvm]
open fun batchWrite(writeSet: BatchWriteSet): BatchWriteResult
[jvm]
@CheckReturnValue
abstract fun batchWrite(writeSet: BatchWriteSet, maxPageSize: Int = MAX_BATCH_WRITE): BatchWriteResult
Saves and deletes the objects given using one or more calls to the DynamoDbClient.batchWriteItem API. Callers should always check the returned BatchWriteResult because this method returns normally even if some writes were not performed.
logicalTable [jvm]
abstract fun <T : LogicalTable<RI>, RI : Any> logicalTable(tableName: String, tableType: KClass<T>): T
transactionLoad [jvm]
abstract fun transactionLoad(keys: KeySet): ItemSet
Transactionally loads objects specified by transactionLoadRequest by calling DynamoDbClient.transactGetItems API.
[jvm]
open fun transactionLoad(vararg keys: Any): ItemSet
open fun transactionLoad(keys: Iterable<Any>): ItemSet
transactionWrite [jvm]
abstract fun transactionWrite(writeSet: TransactionWriteSet)
Transactionally writes objects specified by transactionWriteRequest by calling DynamoDbClient.transactWriteItems API.