database

Documentation

Index

• func Svc(opts config.Options) *dynamodb.DynamoDB
• type DynamoDB
  • func (db DynamoDB) ConfigState(opts config.Options) (string, error)
  • func (db DynamoDB) CreateConfig(opts config.Options, settings map[string]interface{}) (interface{}, error)
  • func (db DynamoDB) Delete(opts config.Options) (config.Item, error)
  • func (db DynamoDB) DeleteConfig(opts config.Options) (interface{}, error)
  • func (db DynamoDB) Get(opts config.Options) (config.Item, error)
  • func (db DynamoDB) Name(opts config.Options) string
  • func (db DynamoDB) Options(opts config.Options) map[string]interface{}
  • func (db DynamoDB) Update(opts config.Options) (config.Item, error)
  • func (db DynamoDB) UpdateConfig(opts config.Options, settings map[string]interface{}) (interface{}, error)
  • func (db DynamoDB) UpdateConfigVersion(opts config.Options) error

Functions

func Svc

func Svc(opts config.Options) *dynamodb.DynamoDB

Svc configures the DynamoDB service to use

Types

type DynamoDB

type DynamoDB struct {
}

DynamoDB implements the Shipper interface.

func (DynamoDB) ConfigState

func (db DynamoDB) ConfigState(opts config.Options) (string, error)

ConfigState returns the DynamoDB table state

func (DynamoDB) CreateConfig

func (db DynamoDB) CreateConfig(opts config.Options, settings map[string]interface{}) (interface{}, error)

CreateConfig creates a new table for a configuration

func (DynamoDB) Delete

func (db DynamoDB) Delete(opts config.Options) (config.Item, error)

Delete a key in DynamoDB

func (DynamoDB) DeleteConfig

func (db DynamoDB) DeleteConfig(opts config.Options) (interface{}, error)

DeleteConfig deletes a configuration (removing the DynamoDB table and all data within it)

func (DynamoDB) Get

func (db DynamoDB) Get(opts config.Options) (config.Item, error)

Get a key in DynamoDB

func (DynamoDB) Name

func (db DynamoDB) Name(opts config.Options) string

Name simply returns the display name for this shipper. It might return version info too from a database, so the config options are present should it need to connect for that.

func (DynamoDB) Options

func (db DynamoDB) Options(opts config.Options) map[string]interface{}

Options returns misc. settings and options for the datastore. For DynamoDB this is going to be the read and write capacity units, but anything like that would be found here. Up to the discretion of the interface.

func (DynamoDB) Update

func (db DynamoDB) Update(opts config.Options) (config.Item, error)

Update a key in DynamoDB

func (DynamoDB) UpdateConfig

func (db DynamoDB) UpdateConfig(opts config.Options, settings map[string]interface{}) (interface{}, error)

UpdateConfig updates a configuration (DyanmoDB can have its read and write capacity units adjusted as needed) Note: Adjusting the read capacity is fast, adjusting write capacity takes longer.

func (DynamoDB) UpdateConfigVersion

func (db DynamoDB) UpdateConfigVersion(opts config.Options) error

UpdateConfigVersion updates the configuration's global version and modified timestamp (fields unique to the root key "/")