README
¶
byteStore
An abstraction library to enable simple Get, Put and other operations on top of the fantastic BoltDB key value store. Import the library and get a new ByteStore with the byteStore.New() function to get started.
byteStore.New(dbFileName string) (ByteStore, error)
The user can simply use the ByteStore object's methods and not worry about database complexities. All methods are thread safe, backed by BoltDB's transactional nature, so use indiscriminately throughout your Goroutines!
(ByteStore) Get(bucket string, key string) []byte
(ByteStore) GetBucket(bucket string) []KeyValue
(ByteStore) GetBucketValues(bucket string) [][]byte
(ByteStore) Put(bucket string, key string, value []byte) error
(ByteStore) Delete(bucket string, key string) error
(ByteStore) DeleteBucket(bucket string) error
(ByteStore) Close() error
The ByteStore type also exposes the underlying BoltDB driver publicly (ByteStore.BoltDB), meaning that if you want to do any more complex transactions not offered by the ByteStore methods, you can use boltDB directly. I hope you enjoy the library, pull and feature requests are welcome.
Documentation
¶
Index ¶
- type ByteStore
- func (bs ByteStore) Close() error
- func (bs ByteStore) Delete(bucket string, key string) error
- func (bs ByteStore) DeleteBucket(bucket string) error
- func (bs ByteStore) Get(bucket string, key string) []byte
- func (bs ByteStore) GetBucket(bucket string) []KeyValue
- func (bs ByteStore) GetBucketValues(bucket string) [][]byte
- func (bs ByteStore) Put(bucket string, key string, value []byte) error
- type KeyValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ByteStore ¶
ByteStore is the struct which contains the pulicly exposed *bolt.DB driver and attached byteStore methods
func New ¶
New returns an initialised byteStore with the dbFileName initialised at the dbFileName target location
func (ByteStore) DeleteBucket ¶
DeleteBucket deletes a whole bucket
func (ByteStore) Get ¶
Get retrieves the value using the bucket and key provided, an empty byte will be returned if no value is present.
func (ByteStore) GetBucket ¶
GetBucket retrieves all keys and values in a bucket, an empty KeyValue slice will be returned if no values are present.
func (ByteStore) GetBucketValues ¶
GetBucketValues retrieves all values in a bucket, an empty slice of bytes will be returned if no values are present.
Source Files