getIndex

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

Parameters

name

The name of the index

schema

The ItemSchema which describes the index, its keys, and how items are converted

Type Parameters

T

The type of objects which will be read from to this index

PK

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


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

Get an Index reference for performing secondary index operations

Parameters

name

The name of the index

schema

The ItemSchema which describes the index, its keys, and how items are converted

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