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

PartitionKey

interface PartitionKey<T, PK : KeyType> : Index<T> , IndexSpec.PartitionKey<T, PK> , IndexOperations.PartitionKey<T, PK> , ItemSource.PartitionKey<T, PK>

Represents a secondary index whose primary key is a single partition key

Type Parameters

T

The type of objects which will be read from this index

PK

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

Inherited properties

abstract val indexName: String?

The name of the secondary index

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 query(request: QueryRequest.PartitionKey<PK>): QueryResponse.PartitionKey<T, PK>

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