IndexSpec

interface IndexSpec<T> : PersistenceSpec<T>

Specifies how items can be read from a secondary index

Type Parameters

T

The type of objects which will be read from this index

Inheritors

Types

Link copied to clipboard

Specifies how items can be read from a secondary index whose primary key consists of a composite of a partition key and a sort key

Link copied to clipboard

Specifies how items can be read from a secondary index whose primary key consists of a single partition key

Properties

Link copied to clipboard
abstract val indexName: String?

The name of the secondary index

Link copied to clipboard
abstract val tableName: String

The name of the table

Inherited properties

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<T>

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