dynamodb

Documentation

Index

• Variables
• func ConvertAVValue(data map[string]types.AttributeValue) (map[string]AVer, error)
• func ConvertAVValues(data []map[string]types.AttributeValue) ([]map[string]AVer, error)
• func FlattenAttrList(data []map[string]types.AttributeValue) ([]map[string]any, error)
• func FlattenAttrValue(data map[string]types.AttributeValue) (map[string]any, error)
• func JSONStringify(v any) string
• func ScanIterator(ctx context.Context, scanner Scanner) func(input *ddb.ScanInput) (*ddb.ScanOutput, error, bool)
• type AVBool
  • func (b AVBool) IsAV() bool
• type AVByte
  • func (b AVByte) IsAV() bool
• type AVByteSet
  • func (bs AVByteSet) IsAV() bool
• type AVList
  • func (l AVList) IsAV() bool
• type AVMap
  • func (m AVMap) IsAV() bool
• type AVNull
  • func (n AVNull) IsAV() bool
• type AVNumber
  • func (n AVNumber) IsAV() bool
• type AVNumberSet
  • func (ns AVNumberSet) IsAV() bool
• type AVString
  • func (s AVString) IsAV() bool
• type AVStringSet
  • func (ss AVStringSet) IsAV() bool
• type AVer
• type Client
  • func NewClient(ctx context.Context, region string, endpoint string) (*Client, error)
  • func NewWith(ctx context.Context, configOpts func(*config.LoadOptions) error, ...) (*Client, error)
  • func (c *Client) BatchDeleteItems(ctx context.Context, tableName string, keys []map[string]types.AttributeValue) (*ddb.BatchWriteItemOutput, error)
  • func (c *Client) Put(ctx context.Context, input *ddb.PutItemInput) (*ddb.PutItemOutput, error)
  • func (c *Client) Scan(ctx context.Context, input *ddb.ScanInput) (*ddb.ScanOutput, error)
• type Scanner

Variables

var (
	ErrNoItems = errors.New("no items found")
)

Functions

func ConvertAVValue

func ConvertAVValue(data map[string]types.AttributeValue) (map[string]AVer, error)

func ConvertAVValues

func ConvertAVValues(data []map[string]types.AttributeValue) ([]map[string]AVer, error)

func FlattenAttrList

func FlattenAttrList(data []map[string]types.AttributeValue) ([]map[string]any, error)

FlattenAttrList - flattens the given attribute value list.

func FlattenAttrValue

func FlattenAttrValue(data map[string]types.AttributeValue) (map[string]any, error)

FlattenAttrValue - flattens the given attribute value map. Removes the "Value" attribute from the AttributeValueMember struct and returns the value as a map[string]any.

func JSONStringify

func JSONStringify(v any) string

JSONStringify - returns a json string representation of the given value

func ScanIterator

func ScanIterator(ctx context.Context, scanner Scanner) func(input *ddb.ScanInput) (*ddb.ScanOutput, error, bool)

ScanIterator - Creates an iterator function for a DynamoDB scan function. The iterator function will return the next page of results on each call, until there are no more results. If the iterator is done, the output will be nil and, the last return value will be true.

Example:

next := dynamodb.ScanIterator(ctx, scanner)

input := &ddb.ScanInput{
    TableName: aws.String("my-table"),
}

output, err, done := next(input)

Types

type AVBool

type AVBool struct {
	BOOL bool
}

func (AVBool) IsAV

func (b AVBool) IsAV() bool

type AVByte

type AVByte struct {
	B []byte
}

func (AVByte) IsAV

func (b AVByte) IsAV() bool

type AVByteSet

type AVByteSet struct {
	BS [][]byte
}

func (AVByteSet) IsAV

func (bs AVByteSet) IsAV() bool

type AVList

type AVList struct {
	L []any
}

func (AVList) IsAV

func (l AVList) IsAV() bool

type AVMap

type AVMap struct {
	M map[string]any
}

func (AVMap) IsAV

func (m AVMap) IsAV() bool

type AVNull

type AVNull struct {
	NULL bool
}

func (AVNull) IsAV

func (n AVNull) IsAV() bool

type AVNumber

type AVNumber struct {
	N string
}

func (AVNumber) IsAV

func (n AVNumber) IsAV() bool

type AVNumberSet

type AVNumberSet struct {
	NS []string
}

func (AVNumberSet) IsAV

func (ns AVNumberSet) IsAV() bool

type AVString

type AVString struct {
	S string
}

func (AVString) IsAV

func (s AVString) IsAV() bool

type AVStringSet

type AVStringSet struct {
	SS []string
}

func (AVStringSet) IsAV

func (ss AVStringSet) IsAV() bool

type AVer

type AVer interface {
	IsAV() bool
}

type Client

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

Client - dynamodb client to query the table (get,put,query,scan)

func NewClient

func NewClient(ctx context.Context, region string, endpoint string) (*Client, error)

NewClient - creates a new opinionated dynamodb client

func NewWith

func NewWith(ctx context.Context, configOpts func(*config.LoadOptions) error, dbOpts ...func(*ddb.Options)) (*Client, error)

NewWith - creates a new dynamodb client with exposed functional options. Use this client if you wish to have flexibility with some of the more advanced options.

func (*Client) BatchDeleteItems

func (c *Client) BatchDeleteItems(ctx context.Context, tableName string, keys []map[string]types.AttributeValue) (*ddb.BatchWriteItemOutput, error)

BatchDeleteItems - deletes items in a batch Note, max size is 25 items within a batch

func (*Client) Put

func (c *Client) Put(ctx context.Context, input *ddb.PutItemInput) (*ddb.PutItemOutput, error)

Put - puts an item into a dynamodb table

func (*Client) Scan

func (c *Client) Scan(ctx context.Context, input *ddb.ScanInput) (*ddb.ScanOutput, error)

Scan - scans a dynamodb table

type Scanner

type Scanner interface {
	Scan(ctx context.Context, input *ddb.ScanInput) (*ddb.ScanOutput, error)
}