store

type KeyDoesNotExist struct {
	Key string
}

type KeyExists struct {
	// Key that exists
	Key string
	// Message is an optional message to the user
	Message string
}

type Lock struct {
	// Key is the name on which the lock is acquired.
	// This is used by the callers for logging purpose. Hence public
	Key string
	// contains filtered or unexported fields
}

type Params struct {
	// Kv is the bootstrap kvdb instance
	Kv kvdb.Kvdb
	// InternalKvdb indicates if PX is using internal kvdb or not
	InternalKvdb bool
	// SchedulerType indicates the platform pods are running on. e.g Kubernetes
	SchedulerType string
}

type Store interface {
	// Lock locks the cloud drive store for a node to perform operations
	Lock(owner string) (*Lock, error)
	// Unlock unlocks the cloud drive store
	Unlock(storeLock *Lock) error
	// LockWithKey locks the cloud drive store with an arbitrary key
	LockWithKey(owner, key string) (*Lock, error)
	// IsKeyLocked checks if the specified key is currently locked
	IsKeyLocked(key string) (bool, string, error)
	// CreateKey creates the given key with the value
	CreateKey(key string, value []byte) error
	// PutKey updates the given key with the value
	PutKey(key string, value []byte) error
	// GetKey returns the value for the given key
	GetKey(key string) ([]byte, error)
	// DeleteKey deletes the given key
	DeleteKey(key string) error
	// EnumerateWithKeyPrefix enumerates all keys in the store that begin with the given key
	EnumerateWithKeyPrefix(key string) ([]string, error)
}