Key Value Store abstraction library.
The kvdb library abstracts the caller from the specific key-value database implementation. The main goal of the kvdb library is to provide simple APIs to deal with only keys and values, and abstract away the intricate details of a specific key value stores. It also provides support for complex APIs like Snapshot, Watch and Lock which are built using the basic APIs.
Etcd v2Etcd v3ConsulIn-memory store(local to the node)Bolt DB(local to the node)Zookeeper
The kvdb library is easy to use and requires you to create a new instance of the Kvdb object
package main
import (
"github.com/portworx/kvdb"
"github.com/portworx/kvdb/etcd/v3"
"github.com/libopenstorage/openstorage/pkg/dbg"
)
func getKvdb(
kvdbName string, // Use one of the kv store implementation names
basePath string, // The path under which all the keys will be created by this kv instance
discoveryEndpoints []string, // A list of kv store endpoints
options map[string]string, // Options that need to be passed to the kv store
panicHandler kvdb.FatalErrorCB, // A callback function to execute when the library needs to panic
) (kvdb.Kvdb, error) {
kv, err := kvdb.New(
kvdbName,
basePath,
discoveryEndpoints,
options,
panicHandler,
)
return kv, err
}
type A struct {
a1 string
a2 int
}
func main() {
// An example kvdb using etcd v3 as a key value store
kv, err := getKvdb(
v3.Name,
"root/",
[]{"127.0.0.1:2379"},
nil,
dbg.Panicf,
)
if err != nil {
fmt.Println("Failed to create a kvdb instance: ", err)
return
}
// Put a key value pair foo=bar
a := &A{"bar", 1}
_, err = kv.Put("foo", &a, 0)
if err != nil {
fmt.Println("Failed to put a key in kvdb: ", err)
return
}
// Get a key
value := A{}
_, err = kv.GetVal("foo", &value)
if err != nil {
fmt.Println("Failed to get a key from kvdb: ", err)
return
}
}
We are always looking for contributions from the open source community. Send out a PR and we will review it.
kvdb library is licensed under the Apache License 2.0