dynamodb

Documentation

Index

• Constants
• type Driver
  • func (d *Driver) Open(ctx context.Context, kvParams kvparams.Config) (kv.Store, error)
• type DynKVItem
• type EntriesIterator
  • func (e *EntriesIterator) Close()
  • func (e *EntriesIterator) Entry() *kv.Entry
  • func (e *EntriesIterator) Err() error
  • func (e *EntriesIterator) Next() bool
  • func (e *EntriesIterator) SeekGE(key []byte)
• type NopRateLimiter
  • func (r *NopRateLimiter) AddTokens(uint) error
  • func (r *NopRateLimiter) GetToken(_ context.Context, _ uint) (releaseToken func() error, err error)
• type Store
  • func (s *Store) Check()
  • func (s *Store) Close()
  • func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error
  • func (s *Store) DropTable() error
  • func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)
  • func (s *Store) Scan(ctx context.Context, partitionKey []byte, options kv.ScanOptions) (kv.EntriesIterator, error)
  • func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error
  • func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, ...) error
  • func (s *Store) StartPeriodicCheck()
  • func (s *Store) StopPeriodicCheck()

Constants

const (
	DriverName = "dynamodb"

	PartitionKey = "PartitionKey"
	ItemKey      = "ItemKey"
	ItemValue    = "ItemValue"
)

Types

type Driver

type Driver struct{}

func (*Driver) Open

func (d *Driver) Open(ctx context.Context, kvParams kvparams.Config) (kv.Store, error)

Open - opens and returns a KV store over DynamoDB. This function creates the DB session and sets up the KV table.

type DynKVItem

type DynKVItem struct {
	PartitionKey []byte
	ItemKey      []byte
	ItemValue    []byte
}

type EntriesIterator

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

func (*EntriesIterator) Close

func (e *EntriesIterator) Close()

func (*EntriesIterator) Entry

func (e *EntriesIterator) Entry() *kv.Entry

func (*EntriesIterator) Err

func (e *EntriesIterator) Err() error

func (*EntriesIterator) Next

func (e *EntriesIterator) Next() bool

func (*EntriesIterator) SeekGE

func (e *EntriesIterator) SeekGE(key []byte)

type NopRateLimiter

type NopRateLimiter struct{}

func (*NopRateLimiter) AddTokens

func (r *NopRateLimiter) AddTokens(uint) error

func (*NopRateLimiter) GetToken

func (r *NopRateLimiter) GetToken(_ context.Context, _ uint) (releaseToken func() error, err error)

type Store

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

func (*Store) Check

func (s *Store) Check()

func (*Store) Close

func (s *Store) Close()

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error

func (*Store) DropTable

func (s *Store) DropTable() error

DropTable used internally for testing purposes

func (*Store) Get

func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)

func (*Store) Scan

func (s *Store) Scan(ctx context.Context, partitionKey []byte, options kv.ScanOptions) (kv.EntriesIterator, error)

func (*Store) Set

func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error

func (*Store) SetIf

func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, valuePredicate kv.Predicate) error

func (*Store) StartPeriodicCheck

func (s *Store) StartPeriodicCheck()

StartPeriodicCheck performs one check and continues every 'interval' in the background

func (*Store) StopPeriodicCheck

func (s *Store) StopPeriodicCheck()