ddbhelper

README

ddbhelper

This project is a helper library for working with DynamoDB in Go. It is not a full-fledged ORM, but rather a set of utilities to make working with DynamoDB easier. It is intended to be used in conjunction with the AWS SDK for Go v2.

Installation

go get github.com/kpes/ddbhelper

Usage

See example/main.go for a full example.

Contributing

TBD

License

Apache License 2.0

Documentation

Index

• type EntityHandler
  • func (s EntityHandler[T]) Delete(ctx context.Context, t T) error
  • func (s EntityHandler[T]) Get(ctx context.Context, t T) (*T, error)
  • func (s EntityHandler[T]) Insert(ctx context.Context, t T) error
  • func (s EntityHandler[T]) Update(ctx context.Context, t T, attributes map[string]interface{}) error
• type Index
• type Record
• type TableDefinition

Types

type EntityHandler

type EntityHandler[T Record] struct {
	TableDef  TableDefinition
	DdbClient ddbClient
}

func (EntityHandler[T]) Delete

func (s EntityHandler[T]) Delete(ctx context.Context, t T) error

func (EntityHandler[T]) Get

func (s EntityHandler[T]) Get(ctx context.Context, t T) (*T, error)

func (EntityHandler[T]) Insert

func (s EntityHandler[T]) Insert(ctx context.Context, t T) error

func (EntityHandler[T]) Update

func (s EntityHandler[T]) Update(ctx context.Context, t T, attributes map[string]interface{}) error

type Index

type Index struct {
	PartitionKeyAttribute string
	SortKeyAttribute      string
}

type Record

type Record interface {
	PartitionKey() string
	SortKey() string
}

type TableDefinition

type TableDefinition struct {
	TableName        string
	TableIndex       Index
	SecondaryIndexes map[string]Index
}