versionedkv

package module
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 3, 2021 License: MIT Imports: 9 Imported by: 3

README

versionedkv

GoDev Build Status Coverage Status

versionedkv is a set of APIs for key/value pairs which focuses on:

  • Version-based concurrency control
  • Value change notification

Implementations

There are some implementations available:

Abstractions

The key abstraction is the storage interface as below:

type Storage interface {
        // GetValue retrieves the value for the given key.
        //
        // If the value does not exist, a nil version is returned.
        GetValue(ctx context.Context, key string) (value string, version Version, err error)

        // WaitForValue waits for the creation, update, deletion of the value for the given key.
        //
        // a) If the value does not exist and the old-version is not given, it blocks until
        // the value has been created;
        // b) If the value does not exist and the old-version is given, a nil new-version
        // is returned right away.
        // c) If the value exists and the old-version is given and the current version of
        // the value is equal to the old-version, it blocks until the value has been
        // updated to a new version or deleted (a nil new-version is returned);
        // d) Otherwise the value is returned right away.
        WaitForValue(ctx context.Context, key string, oldVersion Version) (value string, newVersion Version, err error)

        // Create creates the value for the given key.
        //
        // a) If the value does not exist, it creates the value as the given value;
        // b) Otherwise a nil version is returned.
        CreateValue(ctx context.Context, key string, value string) (version Version, err error)

        // Update updates the value for the given key.
        //
        // a) If the value exists and the old-version is not given, it updates the value to
        // a new version as the given value;
        // b) If the value exists and the old-version is given and the current version of the
        // value is equal to the old-version, it updates the value to a new version as the
        // given value;
        // c) Otherwise a nil new-version is returned.
        UpdateValue(ctx context.Context, key, value string, oldVersion Version) (newVersion Version, err error)

        // CreateOrUpdateValue performs CreateValue or UpdateValue as an atomic operation.
        //
        // a) If the value does not exist, it creates the value as the given value;
        // b) If the value exists and the old-version is not given, it updates the value to
        // a new version as the given value;
        // c) If the value exists and the old-version is given and the current version of the
        // value is equal to the old-version, it updates the value to a new version as the
        // given value;
        // d) Otherwise a nil new-version is returned.
        CreateOrUpdateValue(ctx context.Context, key, value string, oldVersion Version) (newVersion Version, err error)

        // DeleteValue deletes the value for the given key.
        //
        // a) If the value exists and the version is not given, it deletes the value;
        // b) If the value exists and the version is given and the current version of the
        // value is equal to the version, it deletes the value;
        // c) Otherwise false is returned.
        DeleteValue(ctx context.Context, key string, version Version) (ok bool, err error)
}

// Version represents a specific version of a value in a storage.
type Version interface{}

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrStorageClosed error = errors.New("versionedkv: storage closed")

ErrStorageClosed is returned when operating on a storage that has already been closed.

Functions

func DoTestStorage 

func DoTestStorage(t *testing.T, sf StorageFactory)

DoTestStorage tests storages created by the given storage factory.

func DoTestStorageClose added in v0.2.2 

func DoTestStorageClose(t *testing.T, sf StorageFactory)

DoTestStorageClose tests storages created by the given storage factory.

func DoTestStorageCreateOrUpdateValue added in v0.2.2 

func DoTestStorageCreateOrUpdateValue(t *testing.T, sf StorageFactory)

DoTestStorageCreateOrUpdateValue tests storages created by the given storage factory.

func DoTestStorageCreateValue added in v0.2.2 

func DoTestStorageCreateValue(t *testing.T, sf StorageFactory)

DoTestStorageCreateValue tests storages created by the given storage factory.

func DoTestStorageDeleteValue added in v0.2.2 

func DoTestStorageDeleteValue(t *testing.T, sf StorageFactory)

DoTestStorageDeleteValue tests storages created by the given storage factory.

func DoTestStorageGetValue added in v0.2.2 

func DoTestStorageGetValue(t *testing.T, sf StorageFactory)

DoTestStorageGetValue tests storages created by the given storage factory.

func DoTestStorageRaceCondition added in v0.2.2 

func DoTestStorageRaceCondition(t *testing.T, sf StorageFactory)

DoTestStorageRaceCondition tests storages created by the given storage factory.

func DoTestStorageUpdateValue added in v0.2.2 

func DoTestStorageUpdateValue(t *testing.T, sf StorageFactory)

DoTestStorageUpdateValue tests storages created by the given storage factory.

func DoTestStorageWaitForValue added in v0.2.2 

func DoTestStorageWaitForValue(t *testing.T, sf StorageFactory)

DoTestStorageWaitForValue tests storages created by the given storage factory.

Types

type Storage 

type Storage interface {
	// GetValue retrieves the value for the given key.
	//
	// If the value does not exist, a nil version is returned.
	GetValue(ctx context.Context, key string) (value string, version Version, err error)

	// WaitForValue waits for the creation, update, deletion of the value for the given key.
	//
	// a) If the value does not exist and the old-version is not given, it blocks until
	// the value has been created;
	// b) If the value does not exist and the old-version is given, a nil new-version
	// is returned right away.
	// c) If the value exists and the old-version is given and the current version of
	// the value is equal to the old-version, it blocks until the value has been
	// updated to a new version or deleted (a nil new-version is returned);
	// d) Otherwise the value is returned right away.
	WaitForValue(ctx context.Context, key string, oldVersion Version) (value string, newVersion Version, err error)

	// Create creates the value for the given key.
	//
	// a) If the value does not exist, it creates the value as the given value;
	// b) Otherwise a nil version is returned.
	CreateValue(ctx context.Context, key string, value string) (version Version, err error)

	// Update updates the value for the given key.
	//
	// a) If the value exists and the old-version is not given, it updates the value to
	// a new version as the given value;
	// b) If the value exists and the old-version is given and the current version of the
	// value is equal to the old-version, it updates the value to a new version as the
	// given value;
	// c) Otherwise a nil new-version is returned.
	UpdateValue(ctx context.Context, key, value string, oldVersion Version) (newVersion Version, err error)

	// CreateOrUpdateValue performs CreateValue or UpdateValue as an atomic operation.
	//
	// a) If the value does not exist, it creates the value as the given value;
	// b) If the value exists and the old-version is not given, it updates the value to
	// a new version as the given value;
	// c) If the value exists and the old-version is given and the current version of the
	// value is equal to the old-version, it updates the value to a new version as the
	// given value;
	// d) Otherwise a nil new-version is returned.
	CreateOrUpdateValue(ctx context.Context, key, value string, oldVersion Version) (newVersion Version, err error)

	// DeleteValue deletes the value for the given key.
	//
	// a) If the value exists and the version is not given, it deletes the value;
	// b) If the value exists and the version is given and the current version of the
	// value is equal to the version, it deletes the value;
	// c) Otherwise false is returned.
	DeleteValue(ctx context.Context, key string, version Version) (ok bool, err error)

	// Close releases resources associated.
	Close() (err error)

	// Inspect returns detailed information for testing and debugging purposes.
	Inspect(ctx context.Context) (details StorageDetails, err error)
}

Storage represents a versioned key/value storage.

type StorageDetails 

type StorageDetails struct {
	Values   map[string]ValueDetails
	IsClosed bool
}

StorageDetails represents the detailed information of a storage.

type StorageFactory 

type StorageFactory func() (storage Storage, err error)

StorageFactory is the type of the function creating storages.

type ValueDetails 

type ValueDetails struct {
	V       string
	Version Version
}

ValueDetails represents the detailed information of a value in a storage.

type Version 

type Version interface{}

Version represents a specific version of a value in a storage.

Source Files

View all Source files

Directories

Path Synopsis
Package memorystorage provides the implementation of versionedkv in memory.
 Package memorystorage provides the implementation of versionedkv in memory.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.