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

Package-level declarations

Types

typealias DynamoDbMapperSpec = PersistenceSpec<Any?>

Defines the specification for reading/writing items from DynamoDbMapper directly (e.g., cross-table operations)

interface Index<T> : IndexSpec<T> , IndexOperations<T> , ItemSource<T>

Represents a secondary index on a table in DynamoDB and an associated item schema. Operations on this index will invoke low-level operations and map items to objects.

IndexSpec

interface IndexSpec<T> : PersistenceSpec<T>

Specifies how items can be read from a secondary index

Item

interface Item : Map<String, AttributeValue>

An immutable representation of a low-level item in a DynamoDB table. Items consist of attributes, each of which have a string name and a value.

ItemSource

interface ItemSource<T> : PersistenceSpec<T> , ItemSourceOperations<T>

Represents a source of DynamoDB items (such as a table or secondary index)

MutableItem

interface MutableItem : MutableMap<String, AttributeValue>

A mutable representation of a low-level item in a DynamoDB table. Items consist of attributes, each of which have a string name and a value.

PersistenceSpec

interface PersistenceSpec<T>

Specifies how items can be read from and written to a specific DynamoDB location (such as a table or a secondary index)

SchemaAttributes

object SchemaAttributes

Defines AttributeKey instances for schema-specific metadata

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.

TableSpec

interface TableSpec<T> : PersistenceSpec<T>

Specifies how items can be read from and written to a table

Functions

buildItem

inline fun buildItem(block: MutableItem.() -> Unit): Item

Builds a new immutable Item by populating a MutableItem using the provided block and returning a read-only copy of it.

itemOf

fun itemOf(): Item

Returns a new immutable Item with no attributes (i.e., an empty item)

fun itemOf(vararg pairs: Pair<String, AttributeValue>): Item

Returns a new immutable Item with the specified attributes, given as name-value pairs

mutableItemOf

fun mutableItemOf(vararg pairs: Pair<String, AttributeValue>): MutableItem

Returns a new immutable Item with the specified attributes, given as name-value pairs

Inherited functions

deleteItem

suspend fun <T, PK : KeyType, SK : KeyType> Table.CompositeKey<T, PK, SK>.deleteItem(item: T): DeleteItemResponse<T>

suspend fun <T, PK : KeyType> Table.PartitionKey<T, PK>.deleteItem(item: T): DeleteItemResponse<T>

getItem

suspend fun <T, PK : KeyType, SK : KeyType> Table.CompositeKey<T, PK, SK>.getItem(item: T): GetItemResponse<T>

suspend fun <T, PK : KeyType> Table.PartitionKey<T, PK>.getItem(item: T): GetItemResponse<T>

putItem

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

toItem

fun MutableItem.toItem(): Item

Convert this MutableItem to an immutable Item. Changes to this instance do not affect the returned instance.

fun Map<String, AttributeValue>.toItem(): Item

Converts this map to an immutable Item

toMutableItem

fun Item.toMutableItem(): MutableItem

Convert this Item into a MutableItem. Changes to the returned instance do not affect this instance.

fun MutableMap<String, AttributeValue>.toMutableItem(): MutableItem

Converts this map to a MutableItem