dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.items/ItemSchema

ItemSchema

sealed interface ItemSchema<T>

Defines a schema for handling objects of type T, including an ItemConverter for converting between objects and items and a KeySpec for identifying primary keys.

Type Parameters

The type of objects described by this schema

Inheritors

PartitionKey

CompositeKey

Types

CompositeKey

interface CompositeKey<T, PK : KeyType, SK : KeyType> : ItemSchema<T>

Represents a schema with a primary key that is a composite of a partition key and a sort key

PartitionKey

interface PartitionKey<T, PK : KeyType> : ItemSchema<T>

Represents a schema with a primary key consisting of a single partition key

Properties

attributes

abstract val attributes: Attributes

Generic attributes for associating metadata with this schema

converter

abstract val converter: ItemConverter<T>

The ItemConverter used to convert between objects and items

keyAttributeNames

abstract val keyAttributeNames: List<String>

The names of the attributes which form the primary key of this table