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

PartitionKey

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

Represents a table whose primary key is a single partition 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

Inherited properties

abstract val mapper: DynamoDbMapper

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

abstract val schema: ItemSchema.PartitionKey<T, PK>

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.PartitionKey<PK>): DeleteItemResponse<T>

suspend fun <T, PK : KeyType> Table.PartitionKey<T, PK>.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.PartitionKey<PK>): GetItemResponse<T>

suspend fun <T, PK : KeyType> Table.PartitionKey<T, PK>.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.PartitionKey<PK>): QueryResponse.PartitionKey<T, PK>

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

abstract suspend fun updateItem(request: UpdateItemRequest.PartitionKey<PK>): UpdateItemResponse<T>