foundations

Documentation

Index

• Variables
• func Delete(ctx context.Context, cli WriteClient, items WriteItemFunc, ...) (*dynamodb.DeleteItemOutput, error)
• func EnableErrorWithEmptyList(v bool)
• func Get(ctx context.Context, cli GetClient, getKeys GetKeyFunc, fetch FetchItemFunc, ...) (*dynamodb.GetItemOutput, error)
• func IsNil(record interface{}) bool
• func IsNotFound(err error) bool
• func NotFound(tableName string) *types.ResourceNotFoundException
• func Put(ctx context.Context, cli WriteClient, items WriteItemFunc, ...) (*dynamodb.PutItemOutput, error)
• func Query(ctx context.Context, cli QueryClient, condition QueryConditionFunc, ...) (*dynamodb.QueryOutput, error)
• func Scan(ctx context.Context, cli ScanClient, condition ScanFilterFunc, ...) (*dynamodb.ScanOutput, error)
• func Update(ctx context.Context, cli WriteClient, items WriteItemFunc, ...) (*dynamodb.UpdateItemOutput, error)
• func UpdateBuilder(ctx context.Context, fields ...UpdateField) expression.UpdateBuilder
• type Client
• type ExpressionFunc
• type FetchItemFunc
  • func FetchItem[T any](rec *T) FetchItemFunc
• type FetchItemsFunc
  • func FetchItems[T any](rec *T) FetchItemsFunc
• type GetClient
• type GetItemFunc
• type GetKeyFunc
• type PutItemPreprocessor
• type QueryClient
• type QueryConditionFunc
• type ScanClient
• type ScanFilterFunc
• type UpdateField
  • func UpdateValue(name string, value any) UpdateField
• type WriteClient
• type WriteItemFunc
  • func ConsistentUpdateItem(ctx context.Context, keyFunc GetKeyFunc, fieldName string, count int, ...) WriteItemFunc
  • func DeleteItem(keyFunc GetKeyFunc) WriteItemFunc
  • func PutItem(ctx context.Context, tableName string, rec any, f ...ExpressionFunc) WriteItemFunc
  • func UpdateItem(ctx context.Context, keyFunc GetKeyFunc, fields ...UpdateField) WriteItemFunc

Variables

var ErrNotFound *types.ResourceNotFoundException

Functions

func Delete

func Delete(ctx context.Context, cli WriteClient, items WriteItemFunc, opt ...options.Option) (*dynamodb.DeleteItemOutput, error)

func EnableErrorWithEmptyList

func EnableErrorWithEmptyList(v bool)

EnableErrorWithEmptyList Make the list return an error if it is empty.

func Get

func Get(ctx context.Context, cli GetClient, getKeys GetKeyFunc, fetch FetchItemFunc, opt ...options.Option) (*dynamodb.GetItemOutput, error)

func IsNil

func IsNil(record interface{}) bool

func IsNotFound

func IsNotFound(err error) bool

func NotFound

func NotFound(tableName string) *types.ResourceNotFoundException

func Put

func Put(ctx context.Context, cli WriteClient, items WriteItemFunc, opt ...options.Option) (*dynamodb.PutItemOutput, error)

func Query

func Query(ctx context.Context, cli QueryClient, condition QueryConditionFunc, fetch FetchItemsFunc, opt ...options.Option) (*dynamodb.QueryOutput, error)

func Scan

func Scan(ctx context.Context, cli ScanClient, condition ScanFilterFunc, fetch FetchItemsFunc, opt ...options.Option) (*dynamodb.ScanOutput, error)

func Update

func Update(ctx context.Context, cli WriteClient, items WriteItemFunc, opt ...options.Option) (*dynamodb.UpdateItemOutput, error)

func UpdateBuilder

func UpdateBuilder(ctx context.Context, fields ...UpdateField) expression.UpdateBuilder

Types

type Client

type Client interface {
	GetClient
	ScanClient
	QueryClient
	WriteClient
}

type ExpressionFunc

type ExpressionFunc func() (expr expression.Expression, err error)

type FetchItemFunc

type FetchItemFunc func(tableName string, value map[string]types.AttributeValue) error

func FetchItem

func FetchItem[T any](rec *T) FetchItemFunc

type FetchItemsFunc

type FetchItemsFunc func(tableName string, value []map[string]types.AttributeValue) error

func FetchItems

func FetchItems[T any](rec *T) FetchItemsFunc

type GetClient

type GetClient interface {
	GetItem(ctx context.Context, params *dynamodb.GetItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.GetItemOutput, error)
}

type GetItemFunc

type GetItemFunc WriteItemFunc

type GetKeyFunc

type GetKeyFunc func() (table string, keys map[string]types.AttributeValue, attrs []string, err error)

type PutItemPreprocessor

type PutItemPreprocessor interface {
	BeforePutItem(ctx context.Context) any
}

type QueryClient

type QueryClient interface {
	Query(ctx context.Context, params *dynamodb.QueryInput, optFns ...func(*dynamodb.Options)) (*dynamodb.QueryOutput, error)
}

type QueryConditionFunc

type QueryConditionFunc func() (table, index string, expr expression.Expression, err error)

type ScanClient

type ScanClient interface {
	Scan(ctx context.Context, params *dynamodb.ScanInput, optFns ...func(*dynamodb.Options)) (*dynamodb.ScanOutput, error)
}

type ScanFilterFunc

type ScanFilterFunc func() (table string, expr expression.Expression, err error)

type UpdateField

type UpdateField func(ctx context.Context, builder *expression.UpdateBuilder) expression.UpdateBuilder

func UpdateValue

func UpdateValue(name string, value any) UpdateField

type WriteClient

type WriteClient interface {
	PutItem(ctx context.Context, params *dynamodb.PutItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.PutItemOutput, error)
	UpdateItem(ctx context.Context, params *dynamodb.UpdateItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.UpdateItemOutput, error)
	DeleteItem(ctx context.Context, params *dynamodb.DeleteItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.DeleteItemOutput, error)
}

type WriteItemFunc

type WriteItemFunc func() (table string, item map[string]types.AttributeValue, expr expression.Expression, err error)

func ConsistentUpdateItem

func ConsistentUpdateItem(ctx context.Context, keyFunc GetKeyFunc, fieldName string, count int, fields ...UpdateField) WriteItemFunc

func DeleteItem

func DeleteItem(keyFunc GetKeyFunc) WriteItemFunc

func PutItem

func PutItem(ctx context.Context, tableName string, rec any, f ...ExpressionFunc) WriteItemFunc

func UpdateItem

func UpdateItem(ctx context.Context, keyFunc GetKeyFunc, fields ...UpdateField) WriteItemFunc