Add GetClient method to all implementations

this will allow users to amend few settings after c-tor

Fixes philippgille#184

Signed-off-by: Boris Glimcher <[email protected]>

Author: glimchb

badgerdb/badgerdb.go

@@ -13,6 +13,11 @@ type Store struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *badger.DB {
+	return s.db
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

bbolt/bbolt.go

@@ -14,6 +14,11 @@ type Store struct {
 	codec      encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *bolt.DB {
+	return s.db
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

bigcache/bigcache.go

@@ -16,6 +16,11 @@ type Store struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *bigcache.BigCache {
+	return s.s
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

consul/consul.go

@@ -14,6 +14,11 @@ type Client struct {
 	codec  encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *api.KV {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

datastore/datastore.go

@@ -31,6 +31,11 @@ type Client struct {
 	codec   encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *datastore.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

docs.go

@@ -2,7 +2,7 @@
 Package gokv contains a simple key-value store abstraction in the form of a Go interface.
 Implementations of the gokv.Store interface can be found in the sub-packages.
 
-Usage
+# Usage
 
 Example code for using Redis:
 

dynamodb/dynamodb.go

@@ -28,6 +28,11 @@ type Client struct {
 	codec     encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *awsdynamodb.DynamoDB {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

etcd/etcd.go

@@ -21,6 +21,11 @@ type Client struct {
 	codec   encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *clientv3.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

freecache/freecache.go

@@ -15,6 +15,11 @@ type Store struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *freecache.Cache {
+	return s.s
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

gomap/gomap.go

@@ -14,6 +14,11 @@ type Store struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() map[string][]byte {
+	return s.m
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

hazelcast/hazelcast.go

@@ -19,6 +19,11 @@ type Client struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *hazelcast.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

ignite/ignite.go

@@ -18,6 +18,11 @@ type Client struct {
 	codec     encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *ignite.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

leveldb/leveldb.go

@@ -15,6 +15,11 @@ type Store struct {
 	codec     encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *leveldb.DB {
+	return s.db
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

memcached/memcached.go

@@ -17,6 +17,11 @@ type Client struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *memcache.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // The key must not be longer than 250 bytes (this is a restriction of Memcached).
 // Values are automatically marshalled to JSON or gob (depending on the configuration).

mongodb/mongodb.go

@@ -55,6 +55,11 @@ type Client struct {
 	cancel context.CancelFunc
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *mongo.Collection {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

mysql/mysql.go

@@ -24,6 +24,11 @@ type Client struct {
 	c *sql.Client
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *sql.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The length of the key must not exceed 255 characters.

redis/redis.go

@@ -19,6 +19,11 @@ type Client struct {
 	codec   encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *redis.Client {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

s3/s3.go

@@ -22,6 +22,11 @@ type Client struct {
 	codec      encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *awss3.S3 {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

sql/sql.go

@@ -16,6 +16,11 @@ type Client struct {
 	Codec      encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *sql.DB {
+	return c.C
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

syncmap/syncmap.go

@@ -13,6 +13,11 @@ type Store struct {
 	codec encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (s Store) GetStore() *sync.Map {
+	return s.m
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

tablestorage/tablestorage.go

@@ -30,6 +30,11 @@ type Client struct {
 	codec                encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *storage.Table {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

tablestore/tablestore.go

@@ -20,6 +20,11 @@ type Client struct {
 	codec     encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *tablestore.TableStoreClient {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.

zookeeper/zookeeper.go

@@ -18,6 +18,11 @@ type Client struct {
 	codec      encoding.Codec
 }
 
+// Gets underlying store to allow user manipulate object directly.
+func (c Client) GetStore() *zk.Conn {
+	return c.c
+}
+
 // Set stores the given value for the given key.
 // Values are automatically marshalled to JSON or gob (depending on the configuration).
 // The key must not be "" and the value must not be nil.