kv

type Deleter ¶

type Deleter interface {
	KeyValue
	Delete(key string) error
}

Deleter defines an extension interface for KeyValue implementations that defines the Delete operation on the Database.

This interface is used in the "del" command.

type Driver ¶

type Driver interface {
	New() KeyValue
}

Driver defines an interface for initializing new KeyValue implementation. The databases will have corresponding Driver implementations.

To use a Driver with this package, it must first be registered through the Register function.

type DriverFunc ¶

type DriverFunc func() KeyValue

DriverFunc defines a function type that implements the Driver interface.

func (df DriverFunc) New() KeyValue

type Event ¶

type Event struct {
	Key   string
	Value []byte
}

Event defines the struct used for Watcher to receive Events from the Driver.

type Initializer ¶

type Initializer interface {
	Init() error
}

Initializer defines the interface that a KeyValue implementation can implement if explicit initialization is required.

This method will be called after the configuration is marshalled into the implementation struct.

type Iterator ¶

type Iterator interface {
	io.Closer
	Next() (string, []byte, bool)
}

Iterator defines the interface for iterating over the key-values of the Database.

type KeyValue ¶

type KeyValue interface {
	Get(key string) ([]byte, error)
	Set(key string, value []byte) error
}

KeyValue is the most basic interface that each Database MUST implement.

func Open(s config.Section) (KeyValue, io.Closer, error)

type Lister ¶

type Lister interface {
	KeyValue
	List(prefix string) (Iterator, error)
}

Lister defines an extension inteface for KeyValue implementations that can list the keys in the Database.

type Searcher ¶

type Searcher interface {
	KeyValue
	Search(term string) (Iterator, error)
}

Searcher defines an extension inteface for KeyValue implementations that can search for keys in the Database.

type Watcher ¶

type Watcher interface {
	KeyValue
	Watch(ctx context.Context, key string) <-chan Event
}

Watcher defines an extension interface for KeyValue implementations that can watch for changes in Keys.

This interface is used in the "watch" command.