kv

Documentation

Index

• Constants
• type Config
• type Plugin
  • func (p *Plugin) Available()
  • func (p *Plugin) Collects() []interface{}
  • func (p *Plugin) GetAllStorageDrivers(name endure.Named, storage StorageDriver)
  • func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) RPC() interface{}
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop() error
• type Provider
• type Storage
• type StorageDriver

Constants

const PluginName string = "kv"

Types

type Config

type Config struct {
	Data map[string]interface{} `mapstructure:"kv"`
}

Config represents general storage configuration with keys as the user defined kv-names and values as the drivers

type Plugin

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

Plugin for the unified storage

func (*Plugin) Available

func (p *Plugin) Available()

Available interface implementation

func (*Plugin) Collects

func (p *Plugin) Collects() []interface{}

Collects will get all plugins which implement Storage interface

func (*Plugin) GetAllStorageDrivers

func (p *Plugin) GetAllStorageDrivers(name endure.Named, storage StorageDriver)

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, log logger.Logger) error

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) RPC

func (p *Plugin) RPC() interface{}

RPC returns associated rpc service.

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

func (*Plugin) Stop

func (p *Plugin) Stop() error

type Provider

type Provider interface {
	// Provide provides Storage based on the config key
	KVProvide(key string) (Storage, error)
}

Provider provides storage based on the config

type Storage

type Storage interface {
	// Has checks if value exists.
	Has(keys ...string) (map[string]bool, error)

	// Get loads value content into a byte slice.
	Get(key string) ([]byte, error)

	// MGet loads content of multiple values
	// Returns the map with existing keys and associated values
	MGet(keys ...string) (map[string][]byte, error)

	// Set used to upload item to KV with TTL
	// 0 value in TTL means no TTL
	Set(items ...*kvv1.Item) error

	// MExpire sets the TTL for multiply keys
	MExpire(items ...*kvv1.Item) error

	// TTL return the rest time to live for provided keys
	// Not supported for the memcached and boltdb
	TTL(keys ...string) (map[string]string, error)

	// Delete one or multiple keys.
	Delete(keys ...string) error
}

Storage represents single abstract storage.

type StorageDriver

type StorageDriver interface {
	Provider
}

StorageDriver interface provide storage