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

CompositeKey

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

Represents a secondary index 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 this index

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

Link copied to clipboard
abstract val indexName: String?

The name of the secondary index

Link copied to clipboard
abstract val mapper: DynamoDbMapper

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

Link copied to clipboard
abstract val schema: ItemSchema.CompositeKey<T, PK, SK>

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

Link copied to clipboard
abstract val tableName: String

The name of the table

Inherited functions

Link copied to clipboard
abstract suspend fun query(request: QueryRequest.CompositeKey<PK, SK>): QueryResponse.CompositeKey<T, PK, SK>
Link copied to clipboard
abstract suspend fun scan(request: ScanRequest.CompositeKey<PK, SK>): ScanResponse.CompositeKey<T, PK, SK>
Generated by Dokka
© 2026, Amazon Web Services, Inc. or its affiliates. All rights reserved.