http4k-connect-amazon-dynamodb/org.http4k.connect.amazon.dynamodb.mapper

Package-level declarations

Types

interface CombinedKeyCondition<HashKey : Any, SortKey : Any> : KeyCondition<HashKey, SortKey>

class DynamoDbIndexMapper<Document : Any, HashKey : Any, SortKey : Any>(dynamoDb: DynamoDb, tableName: TableName, schema: DynamoDbTableMapperSchema<Document, HashKey, SortKey>)

DynamoDbPage

data class DynamoDbPage<Document : Any>(val items: List<Document>, val lastEvaluatedKey: Key?)

DynamoDbQueryBuilder

class DynamoDbQueryBuilder<HashKey : Any, SortKey : Any>(schema: DynamoDbTableMapperSchema<*, HashKey, SortKey>)

DynamoDbScanBuilder

class DynamoDbScanBuilder

DynamoDbTableMapper

class DynamoDbTableMapper<Document : Any, HashKey : Any, SortKey : Any>(dynamoDb: DynamoDb, tableName: TableName, primarySchema: DynamoDbTableMapperSchema<Document, HashKey, SortKey>)

DynamoDbTableMapperSchema

sealed interface DynamoDbTableMapperSchema<Document : Any, HashKey, SortKey>

FilterExpression

class FilterExpression(val expression: String, val attributeNames: TokensToNames, val attributeValues: TokensToValues)

FilterExpressionBuilder

class FilterExpressionBuilder

See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Syntax

KeyCondition

interface KeyCondition<HashKey : Any, SortKey : Any>

KeyConditionBuilder

class KeyConditionBuilder<HashKey : Any, SortKey : Any>

See https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.KeyConditionExpressions.html

PartitionKeyCondition

interface PartitionKeyCondition<HashKey : Any, SortKey : Any> : CombinedKeyCondition<HashKey, SortKey>

SortKeyCondition

interface SortKeyCondition<HashKey : Any, SortKey : Any> : KeyCondition<HashKey, SortKey>

Functions

batchDelete

fun <HashKey : Any> DynamoDbTableMapper<*, HashKey, *>.batchDelete(vararg hashKeys: HashKey)

fun <HashKey : Any> DynamoDbTableMapper<*, HashKey, *>.batchDelete(hashKeys: Collection<HashKey>)

count

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbIndexMapper<Document, HashKey, SortKey>.count(ConsistentRead: Boolean? = null, block: DynamoDbQueryBuilder<HashKey, SortKey>.() -> Unit): Int

get

operator fun <Document : Any, HashKey : Any> DynamoDbTableMapper<Document, HashKey, *>.get(vararg keys: HashKey): Sequence<Document>

operator fun <Document : Any, HashKey : Any> DynamoDbTableMapper<Document, HashKey, *>.get(keys: Collection<HashKey>): Sequence<Document>

key

fun <HashKey, SortKey> DynamoDbTableMapperSchema<*, HashKey, SortKey>.key(hashKey: HashKey, sortKey: SortKey?): Key

minusAssign

operator fun <Document : Any> DynamoDbTableMapper<Document, *, *>.minusAssign(document: Document)

operator fun <Document : Any> DynamoDbTableMapper<Document, *, *>.minusAssign(documents: Collection<Document>)

plusAssign

operator fun <Document : Any> DynamoDbTableMapper<Document, *, *>.plusAssign(document: Document)

operator fun <Document : Any> DynamoDbTableMapper<Document, *, *>.plusAssign(documents: Collection<Document>)

query

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbIndexMapper<Document, HashKey, SortKey>.query(ScanIndexForward: Boolean = true, PageSize: Int? = null, ConsistentRead: Boolean? = null, block: DynamoDbQueryBuilder<HashKey, SortKey>.() -> Unit): Sequence<Document>

queryPage

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbIndexMapper<Document, HashKey, SortKey>.queryPage(ScanIndexForward: Boolean = true, Limit: Int? = null, ConsistentRead: Boolean? = null, ExclusiveStartKey: Key? = null, block: DynamoDbQueryBuilder<HashKey, SortKey>.() -> Unit): DynamoDbPage<Document>

scan

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbIndexMapper<Document, HashKey, SortKey>.scan(PageSize: Int? = null, ConsistentRead: Boolean? = null, block: DynamoDbScanBuilder.() -> Unit): Sequence<Document>

scanPage

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbIndexMapper<Document, HashKey, SortKey>.scanPage(ExclusiveStartKey: Key? = null, Limit: Int? = null, ConsistentRead: Boolean? = null, block: DynamoDbScanBuilder.() -> Unit): DynamoDbPage<Document>

tableMapper

inline fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDb.tableMapper(tableName: TableName, primarySchema: DynamoDbTableMapperSchema.Primary<Document, HashKey, SortKey>): DynamoDbTableMapper<Document, HashKey, SortKey>

inline fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDb.tableMapper(tableName: TableName, hashKeyAttribute: Attribute<HashKey>, sortKeyAttribute: Attribute<SortKey>? = null, autoMarshalling: AutoMarshalling = DynamoDbMoshi): DynamoDbTableMapper<Document, HashKey, SortKey>

inline fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDb.tableMapper(tableName: TableName, hashKeyAttribute: Attribute<HashKey>, sortKeyAttribute: Attribute<SortKey>? = null, lens: BiDiLens<Item, Document>): DynamoDbTableMapper<Document, HashKey, SortKey>

update

fun <Document : Any, HashKey : Any, SortKey : Any> DynamoDbTableMapper<Document, HashKey, SortKey>.update(hashKey: HashKey, sortKey: SortKey? = null, updateFn: (Document) -> Document): Document?