kvstore

Documentation

Index

• Variables
• func AtomicModify(s KVStore, key string, ...) error
• func AtomicModifyWithOptions(s KVStore, key string, ...) error
• func Ensure(s KVStore, key string, newValue []byte) ([]byte, error)
• func LoadJSON(s KVStore, key string, v interface{}) (returnErr error)
• func StoreJSON(s KVStore, key string, v interface{}) (returnErr error)
• type KVStore
  • func NewEncryptedKeyStore(s KVStore, encryptionKey []byte) KVStore
  • func NewHashedKeyStore(s KVStore, prefix string) KVStore
  • func NewPluginStore(api plugin.API) KVStore
  • func NewPluginStoreWithExpiry(api plugin.API, ttl time.Duration) KVStore
• type OneTimeStore
  • func NewOneTimePluginStore(api plugin.API, ttl time.Duration) OneTimeStore
  • func NewOneTimeStore(kv KVStore) OneTimeStore

Variables

var ErrNotFound = errors.New("not found")

Functions

func AtomicModify

func AtomicModify(s KVStore, key string, modify func(initialValue []byte, storeErr error) ([]byte, error)) error

func AtomicModifyWithOptions

func AtomicModifyWithOptions(s KVStore, key string, modify func(initialValue []byte, storeErr error) ([]byte, *model.PluginKVSetOptions, error)) error

func Ensure

func Ensure(s KVStore, key string, newValue []byte) ([]byte, error)

func LoadJSON

func LoadJSON(s KVStore, key string, v interface{}) (returnErr error)

func StoreJSON

func StoreJSON(s KVStore, key string, v interface{}) (returnErr error)

Types

type KVStore

type KVStore interface {
	Load(key string) ([]byte, error)
	Store(key string, data []byte) error
	StoreTTL(key string, data []byte, ttlSeconds int64) error
	StoreWithOptions(key string, value []byte, opts model.PluginKVSetOptions) (bool, error)
	Delete(key string) error
}

func NewEncryptedKeyStore

func NewEncryptedKeyStore(s KVStore, encryptionKey []byte) KVStore

func NewHashedKeyStore

func NewHashedKeyStore(s KVStore, prefix string) KVStore

func NewPluginStore

func NewPluginStore(api plugin.API) KVStore

func NewPluginStoreWithExpiry

func NewPluginStoreWithExpiry(api plugin.API, ttl time.Duration) KVStore

type OneTimeStore

type OneTimeStore KVStore

OneTimeStore is a KV store that deletes each record after the first load,

func NewOneTimePluginStore

func NewOneTimePluginStore(api plugin.API, ttl time.Duration) OneTimeStore

func NewOneTimeStore

func NewOneTimeStore(kv KVStore) OneTimeStore