dynamo

Documentation

Index

• type Client
  • func (client *Client) ReadFromTable(table string) (*Item, error)
  • func (client *Client) WriteToTable(table, key string, isLow bool) error
• type DB
• type Dynamo
  • func New(tbl, region, key string) (*Dynamo, error)
  • func (dynamo *Dynamo) NewClient() (*Client, error)
• type Item

Types

type Client

type Client struct {
	*dynamodb.DynamoDB
}

Client type is a DynamoDB client

func (*Client) ReadFromTable

func (client *Client) ReadFromTable(table string) (*Item, error)

ReadFromTable executes a Select query on the DynamoDB database returning the output in an Item format

func (*Client) WriteToTable

func (client *Client) WriteToTable(table, key string, isLow bool) error

WriteToTable executes an Update query on the DynamoDB updating the provided key with the isLow bool

type DB

type DB interface {
	NewSession() (*session.Session, error)
	NewClient() Client
	ReadFromTable(string) Item
	WriteToTable(string, string, bool) error
}

DB interface is a collection of most of the dyanmo package functions

type Dynamo

type Dynamo struct {
	TableName string
	Region    string
	Key       string
}

Dynamo contains the DyanamoDB basic information needed to connect to the instance

func New

func New(tbl, region, key string) (*Dynamo, error)

New is the Package constructor that initialises the DynamoDB config

func (*Dynamo) NewClient

func (dynamo *Dynamo) NewClient() (*Client, error)

NewClient creates a DynamoDB client

type Item

type Item struct {
	ID          int  `json:"ID"`
	IsLowMemory bool `json:"isLowMemory"`
	IsLowCPU    bool `json:"isLowCPU"`
}

Item represents the structure of the JSON body coming back from DynamoDB after a Select query is executed