dynamodbx

README

dynamodbx

A Golang driver extension of AWS DynamoDB

Documentation

Index

• Constants
• Variables
• func AddStringToSet(attributes map[string]*dynamodb.AttributeValue, k, v string) ([]string, bool)
• func Time(t time.Time) *dynamodb.AttributeValue
• func ToDynamoDBType(t reflect.Type) (string, error)
• func ToIndexName(key []*dynamodb.KeySchemaElement) string
• func ToTableName(s string) string
• type BaseModel
  • func MustCreateBaseModel(region string, data interface{}) *BaseModel
  • func NewBaseModel(region string, data interface{}) (*BaseModel, error)
  • func (b *BaseModel) FindWhere(key string, value interface{}) (interface{}, error)
  • func (b *BaseModel) FindWhere2(key, orderKey string, value interface{}) (interface{}, error)
  • func (b *BaseModel) Get(id interface{}, secondary ...interface{}) (interface{}, error)
  • func (b *BaseModel) GetIndexes() ([]*dynamodb.GlobalSecondaryIndexDescription, error)
  • func (b *BaseModel) Insert(v interface{}) error
  • func (b *BaseModel) Put(v interface{}) error
  • func (b *BaseModel) Update(key map[string]*dynamodb.AttributeValue, updator string, ...) (int64, error)
  • func (b *BaseModel) UpdateKv(id interface{}, k string, v interface{}) (int64, error)
  • func (b *BaseModel) UpdateWhere(input *dynamodb.UpdateItemInput) (int64, *dynamodb.UpdateItemOutput, error)

Constants

const (
	TAG               = "dynamodbav"
	TAG_INDEX         = "index"
	TAG_SECONDARY     = "secondary"
	TAG_SECONDARY_FOR = "secondaryfor"
)

Variables

var (
	ErrItemNotFound         = errors.New("Item not found")
	ErrConditionalCheckFail = errors.New("ConditionalCheckFailedException: The conditional request failed")
)

Functions

func AddStringToSet

func AddStringToSet(attributes map[string]*dynamodb.AttributeValue, k, v string) ([]string, bool)

func Time

func Time(t time.Time) *dynamodb.AttributeValue

func ToDynamoDBType

func ToDynamoDBType(t reflect.Type) (string, error)

func ToIndexName

func ToIndexName(key []*dynamodb.KeySchemaElement) string

func ToTableName

func ToTableName(s string) string

Types

type BaseModel

type BaseModel struct {
	TableName string
	Type      reflect.Type

	Client *dynamodb.DynamoDB
	// contains filtered or unexported fields
}

func MustCreateBaseModel

func MustCreateBaseModel(region string, data interface{}) *BaseModel

func NewBaseModel

func NewBaseModel(region string, data interface{}) (*BaseModel, error)

func (*BaseModel) FindWhere

func (b *BaseModel) FindWhere(key string, value interface{}) (interface{}, error)

func (*BaseModel) FindWhere2

func (b *BaseModel) FindWhere2(key, orderKey string, value interface{}) (interface{}, error)

func (*BaseModel) Get

func (b *BaseModel) Get(id interface{}, secondary ...interface{}) (interface{}, error)

func (*BaseModel) GetIndexes

func (b *BaseModel) GetIndexes() ([]*dynamodb.GlobalSecondaryIndexDescription, error)

func (*BaseModel) Insert

func (b *BaseModel) Insert(v interface{}) error

func (*BaseModel) Put

func (b *BaseModel) Put(v interface{}) error

func (*BaseModel) Update

func (b *BaseModel) Update(key map[string]*dynamodb.AttributeValue, updator string, args map[string]*dynamodb.AttributeValue) (int64, error)

func (*BaseModel) UpdateKv

func (b *BaseModel) UpdateKv(id interface{}, k string, v interface{}) (int64, error)

func (*BaseModel) UpdateWhere

func (b *BaseModel) UpdateWhere(input *dynamodb.UpdateItemInput) (int64, *dynamodb.UpdateItemOutput, error)