goety

Documentation

Index

• type DynamoClient
• type Emitter
• type QueryFuncOpts
  • func WithAttrs(attrs []string) QueryFuncOpts
  • func WithFilterExpression(condition string) QueryFuncOpts
  • func WithFilterNameAttrs(attrName string) QueryFuncOpts
  • func WithFilterNameValues(attrValues string) QueryFuncOpts
  • func WithLimit(limit int32) QueryFuncOpts
• type QueryOpts
  • func WithQueryOptions(opts []QueryFuncOpts) *QueryOpts
• type Service
  • func New(client DynamoClient, logger *slog.Logger, emitter emitter.MessagePublisher, ...) Service
  • func (s Service) Dump(ctx context.Context, tableName string, path string, opts ...QueryFuncOpts) error
  • func (s Service) Purge(ctx context.Context, tableName string, keys TableKeys) error
  • func (s Service) Seed(ctx context.Context, tableName string, filePath string) error
• type TableKeys
• type WriteFile
  • func (w *WriteFile) ReadFile(name string) ([]byte, error)
  • func (w *WriteFile) WriteFile(name string, data []byte, perm fs.FileMode) error

Types

type DynamoClient

type DynamoClient interface {
	Put(ctx context.Context, input *dynamodb.PutItemInput) (*dynamodb.PutItemOutput, error)
	Scan(ctx context.Context, input *dynamodb.ScanInput) (*dynamodb.ScanOutput, error)
	BatchDeleteItems(ctx context.Context, tableName string, keys []map[string]types.AttributeValue) (*dynamodb.BatchWriteItemOutput, error)
}

type Emitter

type Emitter interface {
	Publish(msg string)
}

type QueryFuncOpts

type QueryFuncOpts = func(*QueryOpts) *QueryOpts

func WithAttrs

func WithAttrs(attrs []string) QueryFuncOpts

WithAttrs - provide a list of dynamodb attributes the query will return

func WithFilterExpression

func WithFilterExpression(condition string) QueryFuncOpts

WithFilterExpression - provide a filter condition for the query

func WithFilterNameAttrs

func WithFilterNameAttrs(attrName string) QueryFuncOpts

WithFilterNameAttrs - provide a list of attribute names to filter on

func WithFilterNameValues

func WithFilterNameValues(attrValues string) QueryFuncOpts

WithFilterNameValues - provide a list of attribute values to filter on

func WithLimit

func WithLimit(limit int32) QueryFuncOpts

WithLimit - provide a limit to the query

type QueryOpts

type QueryOpts struct {
	Limit                *int32
	FilterExpression     *string
	ProjectedExpressions *string
	FilterNameAttributes map[string]string
	FilterNameValues     map[string]types.AttributeValue
}

func WithQueryOptions

func WithQueryOptions(opts []QueryFuncOpts) *QueryOpts

type Service

type Service struct {
	// contains filtered or unexported fields
}

func New

func New(client DynamoClient, logger *slog.Logger, emitter emitter.MessagePublisher, dryRun bool) Service

func (Service) Dump

func (s Service) Dump(ctx context.Context, tableName string, path string, opts ...QueryFuncOpts) error

Dump all items from the given table. Optionally specify a list of attributes to extract.

Example:

Dump(ctx, "my-table", "path/to/file.json", []string{"attr1", "attr2"})

func (Service) Purge

func (s Service) Purge(ctx context.Context, tableName string, keys TableKeys) error

Purge all items from the given table

Example:

Purge(ctx, "my-table", TableKeys{ PartitionKey: "pk", SortKey: "sk" })

func (Service) Seed

func (s Service) Seed(ctx context.Context, tableName string, filePath string) error

Seed a table with items from a json file

Example:

Seed(ctx, "my-table", "path/to/file.json")

type TableKeys

type TableKeys struct {
	PartitionKey string
	SortKey      string
}

type WriteFile

type WriteFile struct {
}

func (*WriteFile) ReadFile

func (w *WriteFile) ReadFile(name string) ([]byte, error)

func (*WriteFile) WriteFile

func (w *WriteFile) WriteFile(name string, data []byte, perm fs.FileMode) error

WriteFile saves data to a file.