dynamodb-mapper/aws.sdk.kotlin.hll.dynamodbmapper.model/Table

Table

interface Table<T> : TableSpec<T> , TableOperations<T> , ItemSource<T>

Represents a table in DynamoDB and an associated item schema. Operations on this table will invoke low-level operations after mapping objects to items and vice versa.

Type Parameters

The type of objects which will be read from and/or written to this table

Inheritors

PartitionKey

CompositeKey

Types

CompositeKey

interface CompositeKey<T, PK : KeyType, SK : KeyType> : Table<T> , TableSpec.CompositeKey<T, PK, SK> , TableOperations.CompositeKey<T, PK, SK> , ItemSource.CompositeKey<T, PK, SK>

Represents a table whose primary key is a composite of a partition key and a sort key

PartitionKey

interface PartitionKey<T, PK : KeyType> : Table<T> , TableSpec.PartitionKey<T, PK> , TableOperations.PartitionKey<T, PK> , ItemSource.PartitionKey<T, PK>

Represents a table whose primary key is a single partition key

Inherited properties

mapper

abstract val mapper: DynamoDbMapper

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

schema

abstract val schema: ItemSchema<T>

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

tableName

abstract val tableName: String

The name of the table

Functions

getIndex

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

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

Inherited functions

putItem

abstract suspend fun putItem(request: PutItemRequest<T>): PutItemResponse<T>

putItem

suspend fun <T> Table<T>.putItem(item: T): PutItemResponse<T>