dynamodb

Documentation

Index

• func New() *dynamodb.DynamoDB
• type API
  • func (a *API) GetItem(ctx aws.Context, table string, attributes map[string]interface{}) (resp *dynamodb.GetItemOutput, err error)
  • func (a *API) IsEnabled() bool
  • func (a *API) PutItem(ctx aws.Context, table string, item map[string]*dynamodb.AttributeValue) (resp *dynamodb.PutItemOutput, err error)
  • func (a *API) Query(ctx aws.Context, table, partitionKey, sortKey, keyConditionExpression string, ...) (resp *dynamodb.QueryOutput, err error)
  • func (a *API) Setup()

Functions

func New

func New() *dynamodb.DynamoDB

New returns a configured DynamoDB client.

Types

type API

type API struct {
	Client dynamodbiface.DynamoDBAPI
}

API wraps the DynamoDB API interface.

func (*API) GetItem

func (a *API) GetItem(ctx aws.Context, table string, attributes map[string]interface{}) (resp *dynamodb.GetItemOutput, err error)

GetItem is a convenience wrapper for getting items into a DynamoDB table.

func (*API) IsEnabled

func (a *API) IsEnabled() bool

IsEnabled returns true if the client is enabled and ready for use.

func (*API) PutItem

func (a *API) PutItem(ctx aws.Context, table string, item map[string]*dynamodb.AttributeValue) (resp *dynamodb.PutItemOutput, err error)

PutItem is a convenience wrapper for putting items into a DynamoDB table.

func (*API) Query

func (a *API) Query(ctx aws.Context, table, partitionKey, sortKey, keyConditionExpression string, limit int64, scanIndexForward bool) (resp *dynamodb.QueryOutput, err error)

Query is a convenience wrapper for querying a DynamoDB table. The paritition and sort keys are always referenced in the key condition expression as ":pk" and ":sk". Refer to the DynamoDB documentation for the Query operation's request syntax and key condition expression patterns:

- https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html#API_Query_RequestSyntax

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

func (*API) Setup

func (a *API) Setup()

Setup creates a new DynamoDB client.