dynamo

Documentation

Overview

Package dynamo implements various design patterns for dynamodb and looks to simplify the aws api for aws-sdk-go-v2

Index

• Constants
• type APIBehavior
• type Client
  • func NewClient(api APIBehavior, tbl Table) (*Client, error)
  • func (c *Client) Item(ctx context.Context, key Keyable) (map[string]types.AttributeValue, error)
  • func (c *Client) NewGetItemIn(k Keyable) *dynamodb.GetItemInput
  • func (c *Client) NewPutInput(item map[string]types.AttributeValue, cond ...string) *dynamodb.PutItemInput
  • func (c *Client) Put(ctx context.Context, item map[string]types.AttributeValue) error
  • func (c *Client) TableName() string
  • func (c *Client) Write(ctx context.Context, row Writable) error
• type FormatterError
• type Key
  • func (k *Key) ConditionExpression() *string
  • func (k *Key) ExpressionAttrNames() map[string]string
  • func (k *Key) FormatForError() string
  • func (k *Key) Full() map[string]types.AttributeValue
• type Keyable
• type Table
  • func NewTable(name, hash, sort string, idx map[string]string) (Table, error)
  • func (t Table) HashKey() string
  • func (t Table) Name() string
  • func (t Table) SortKey() string
• type Writable

Constants

const (
	HashKeyName   = "pk"
	SortKeyName   = "sk"
	DomainKeyName = "dk"
)

Types

type APIBehavior

type APIBehavior interface {
	GetItem(context.Context, *dynamodb.GetItemInput, ...func(*dynamodb.Options)) (*dynamodb.GetItemOutput, error)
	BatchGetItem(context.Context, *dynamodb.BatchGetItemInput, ...func(*dynamodb.Options)) (*dynamodb.BatchGetItemOutput, error)
	BatchWriteItem(context.Context, *dynamodb.BatchWriteItemInput, ...func(*dynamodb.Options)) (*dynamodb.BatchWriteItemOutput, error)
	DeleteItem(context.Context, *dynamodb.DeleteItemInput, ...func(*dynamodb.Options)) (*dynamodb.DeleteItemOutput, error)
	PutItem(context.Context, *dynamodb.PutItemInput, ...func(*dynamodb.Options)) (*dynamodb.PutItemOutput, error)
	Query(context.Context, *dynamodb.QueryInput, ...func(*dynamodb.Options)) (*dynamodb.QueryOutput, error)
	Scan(context.Context, *dynamodb.ScanInput, ...func(*dynamodb.Options)) (*dynamodb.ScanOutput, error)
	TransactGetItems(context.Context, *dynamodb.TransactGetItemsInput, ...func(*dynamodb.Options)) (*dynamodb.TransactGetItemsOutput, error)
	TransactWriteItems(context.Context, *dynamodb.TransactWriteItemsInput, ...func(*dynamodb.Options)) (*dynamodb.TransactWriteItemsOutput, error)
	UpdateItem(context.Context, *dynamodb.UpdateItemInput, ...func(*dynamodb.Options)) (*dynamodb.UpdateItemOutput, error)
	UpdateTimeToLive(context.Context, *dynamodb.UpdateTimeToLiveInput, ...func(*dynamodb.Options)) (*dynamodb.UpdateTimeToLiveOutput, error)
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(api APIBehavior, tbl Table) (*Client, error)

func (*Client) Item

func (c *Client) Item(ctx context.Context, key Keyable) (map[string]types.AttributeValue, error)

func (*Client) NewGetItemIn

func (c *Client) NewGetItemIn(k Keyable) *dynamodb.GetItemInput

func (*Client) NewPutInput

func (c *Client) NewPutInput(item map[string]types.AttributeValue, cond ...string) *dynamodb.PutItemInput

func (*Client) Put

func (c *Client) Put(ctx context.Context, item map[string]types.AttributeValue) error

func (*Client) TableName

func (c *Client) TableName() string

func (*Client) Write

func (c *Client) Write(ctx context.Context, row Writable) error

type FormatterError

type FormatterError interface {
	FormatForError() string
}

type Key

type Key struct {
	Hash          string `dynamodbav:"pk"`
	Sort          string `dynamodbav:"sk"`
	Domain        string `dynamodbav:"dk"`
	ExprNames     map[string]string
	ConditionExpr *string
}

func (*Key) ConditionExpression

func (k *Key) ConditionExpression() *string

func (*Key) ExpressionAttrNames

func (k *Key) ExpressionAttrNames() map[string]string

func (*Key) FormatForError

func (k *Key) FormatForError() string

func (*Key) Full

func (k *Key) Full() map[string]types.AttributeValue

type Keyable

type Keyable interface {
	Full() map[string]types.AttributeValue
	ConditionExpr() *string
	ExprAttrNames() map[string]string
	FormatterError
}

type Table

type Table struct {
	// contains filtered or unexported fields
}

func NewTable

func NewTable(name, hash, sort string, idx map[string]string) (Table, error)

func (Table) HashKey

func (t Table) HashKey() string

func (Table) Name

func (t Table) Name() string

func (Table) SortKey

func (t Table) SortKey() string

type Writable

type Writable interface {
	ToItem() (map[string]types.AttributeValue, error)
	ToDBKey() map[string]types.AttributeValue
	ConditionExpr() *string
	ExprAttrNames() map[string]string
	FormatterError
}