dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.model/Table/CompositeKey

CompositeKey

interface CompositeKey<T, PK : KeyType, SK : KeyType> : Table<T> , TableSpec.CompositeKey<T, PK, SK> , TableOperations.CompositeKey<T, PK, SK> , ItemSource.CompositeKey<T, PK, SK>

Represents a table whose primary key is a composite of a partition key and a sort key

Type Parameters

T

The type of objects which will be read from and/or written to this table

PK

The type of the partition key property, either KeyType or one of its specific derivations

SK

The type of the sort key property, either KeyType or one of its specific derivations

Inherited properties

abstract val mapper: DynamoDbMapper

The DynamoDbMapper which holds the underlying DynamoDB service client used to invoke operations

abstract val schema: ItemSchema.CompositeKey<T, PK, SK>

The ItemSchema which describes how to map objects to items and vice versa

abstract val tableName: String

The name of the table

Inherited functions

abstract suspend fun deleteItem(request: DeleteItemRequest.CompositeKey<PK, SK>): DeleteItemResponse<T>

suspend fun <T, PK : KeyType, SK : KeyType> Table.CompositeKey<T, PK, SK>.deleteItem(item: T): DeleteItemResponse<T>

abstract fun <T, PK : KeyType, SK : KeyType> getIndex(name: String, schema: ItemSchema.CompositeKey<T, PK, SK>): Index.CompositeKey<T, PK, SK>

abstract fun <T, PK : KeyType> getIndex(name: String, schema: ItemSchema.PartitionKey<T, PK>): Index.PartitionKey<T, PK>

Get an Index reference for performing secondary index operations

abstract suspend fun getItem(request: GetItemRequest.CompositeKey<PK, SK>): GetItemResponse<T>

suspend fun <T, PK : KeyType, SK : KeyType> Table.CompositeKey<T, PK, SK>.getItem(item: T): GetItemResponse<T>

abstract suspend fun putItem(request: PutItemRequest<T>): PutItemResponse<T>

suspend fun <T> Table<T>.putItem(item: T): PutItemResponse<T>

abstract suspend fun query(request: QueryRequest.CompositeKey<PK, SK>): QueryResponse.CompositeKey<T, PK, SK>

abstract suspend fun scan(request: ScanRequest.CompositeKey<PK, SK>): ScanResponse.CompositeKey<T, PK, SK>

abstract suspend fun updateItem(request: UpdateItemRequest.CompositeKey<PK, SK>): UpdateItemResponse<T>