jsonstore

README

jsonstore 🏪

This package is a fork of schollz/jsonstore.

JSONStore is a Go-library for a simple thread-safe in-memory JSON key-store with persistent backend. It's made for those times where you don't need a RDBMS like MySQL, or a NoSQL like MongoDB - basically when you just need a simple keystore. A really simple keystore. JSONStore is used in those times you don't need a distributed keystore like etcd, or a remote keystore Redis or a local keystore like Bolt. Its really for those times where you just need a JSON file.

Usage

First, install the library using:

go get -u -v github.com/shogo82148/jsonstore

Then you can add it to your program. Check out the examples, or see below for basic usage:

ks := new(jsonstore.JSONStore)

// set a key to any object you want
type Human struct {
  Name   string
  Height float64
}
err := ks.Set("human:1", Human{"Dante", 5.4})
if err != nil {
  panic(err)
}

// Saving will automatically gzip if .gz is provided
if err = jsonstore.Save(ks, "humans.json.gz"); err != nil {
  panic(err)
}

// Load any JSON / GZipped JSON
ks2, err := jsonstore.Open("humans.json.gz")
if err != nil {
  panic(err)
}

// get the data back via an interface
var human Human
err = ks2.Get("human:1", &human)
if err != nil {
  panic(err)
}
fmt.Println(human.Name) // Prints 'Dante'

The datastore on disk is then contains:

$ zcat humans.json.gz
{"human:1":{"Name":"Dante","Height":5.4}}

License

MIT

Copyright (c) 2017 Zack Copyright (c) 2017 shogo82148

Documentation

Index

• func Save(ks *JSONStore, filename string) error
• func SaveAndRename(ks *JSONStore, filename string) error
• type JSONStore
  • func Open(filename string) (*JSONStore, error)
  • func (s *JSONStore) Delete(key string)
  • func (s *JSONStore) Get(key string, v interface{}) error
  • func (s *JSONStore) GetAll(matcher func(key string) bool) *JSONStore
  • func (s *JSONStore) Keys() []string
  • func (s *JSONStore) Set(key string, value interface{}) error
  • func (s *JSONStore) Size() int
  • func (s *JSONStore) StartAutoSave(filename string, d time.Duration, count int64)
  • func (s *JSONStore) StopAutoSave()
• type NoSuchKeyError
  • func (err NoSuchKeyError) Error() string

Functions

func Save

func Save(ks *JSONStore, filename string) error

Save writes the jsonstore to disk.

func SaveAndRename

func SaveAndRename(ks *JSONStore, filename string) error

SaveAndRename writes the jsonstore to disk more safely. First, SaveAndRename writes the jsonstore to temporary file, and then rename it to filename. NOTE: os.Rename renames atomic on POSIX systems, but no guarantee on other systems.

Types

type JSONStore

type JSONStore struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

JSONStore is the basic store object.

func Open

func Open(filename string) (*JSONStore, error)

Open will load a jsonstore from a file.

func (*JSONStore) Delete

func (s *JSONStore) Delete(key string)

Delete removes a key from the store.

func (*JSONStore) Get

func (s *JSONStore) Get(key string, v interface{}) error

Get will return the value associated with a key.

func (*JSONStore) GetAll

func (s *JSONStore) GetAll(matcher func(key string) bool) *JSONStore

GetAll is like a filter with a regexp.

func (*JSONStore) Keys

func (s *JSONStore) Keys() []string

Keys returns all the keys currently in map

func (*JSONStore) Set

func (s *JSONStore) Set(key string, value interface{}) error

Set saves a value at the given key.

func (*JSONStore) Size

func (s *JSONStore) Size() int

Size returns the count element in the store.

func (*JSONStore) StartAutoSave

func (s *JSONStore) StartAutoSave(filename string, d time.Duration, count int64)

StartAutoSave starts auto saving.

func (*JSONStore) StopAutoSave

func (s *JSONStore) StopAutoSave()

StopAutoSave stops auto saving.

type NoSuchKeyError

type NoSuchKeyError struct {
	// contains filtered or unexported fields
}

NoSuchKeyError is thrown when calling Get with invalid key

func (NoSuchKeyError) Error

func (err NoSuchKeyError) Error() string