go-store's Introduction

go-store

A storage interface used to do key value data storage. Gives you the freedom to swap out storage implementations without any hassel. Also allows DI and mocking.

Interface

The store intereface defines the following methods

DeleteKey(key string) error
GetString(key string) (string, error)
GetInt64(key string) (int64, error)
Set(key string, value interface{}) error
SetHash(key string, hash string, value interface{}) error
DeleteHash(key string, hash string) error
GetHashString(key string, hash string) (string, error)
GetAllHashValues(key string) ([]string, error)
GetAllHashKeys(key string) ([]string, error)
SetExpiry(key string, seconds int) error
Increment(key string) error
Decrement(key string) error
SetAdd(key string, value interface{}) error
GetSetStringMembers(key string) ([]string, error)
SetRemove(key string, value interface{}) error
SetIsMember(key string, value interface{}) (bool, error)
PushItemToList(key string, value interface{}, atEnd bool) error
PopItemFromList(key string, dataType int, atEnd bool) (interface{}, error)
ItemsFromList(key string, dataType int, start, end int) (interface{}, error)
RemoveItemFromList(key string, count int, value interface{}) error
LengthOfList(key string) (int, error)
ClearDataStore()

Usage

Use the interface declaration in your code where you want to use the data store. You can intialize the store with anything that implements that store. Current implementation only supports Redis but can be easily implemented for any other key/value based data storage such as Bolt DB.

Recommend Projects