appsettings

README

AppSettings

A hierarchical key value store for persisting simple runtime options in Go applications.

Example

s := appsettings.NewAppSettings("settings.json")

t := s.GetTree("user-settings")

//set
t.SetString("pizza", "pie")
t.SetInt("how-many-pugs", 349)

//read
if v, err := t.GetInt("how-many-pugs"); err == nil {
	log.Println(v)
}

if v, err = t.GetString("pizza"); err == nil {
	log.Println(v)
}

s.Persist()

Installation

go get -u -v github.com/donatj/appsettings

Migration from v0.0.1

The JSON format for the early Alpha changed. To migrate your existing data compatibly to the more modern format, you can use jq and execute the following command, first replacing {your-file} with the path to your actual database file.

jq '.Tree |= with_entries(.value = {Leaves: .value} ) | . + {Branches: .Tree} | del(.Tree)' < {your-file} > tmp && mv tmp {your-fie}

Documentation

Documentation can be found a godoc:

https://godoc.org/github.com/donatj/appsettings

Documentation

Overview

Package appsettings provides simple key/value store functionality

Index

• Variables
• type AppSettings
  • func NewAppSettings(dbFilename string) (*AppSettings, error)
  • func (a AppSettings) Delete(key string)
  • func (a AppSettings) DeleteTree(key string)
  • func (a AppSettings) GetInt(key string) (int, error)
  • func (a AppSettings) GetInt64(key string) (int64, error)
  • func (a AppSettings) GetLeaves() map[string]string
  • func (a AppSettings) GetString(key string) (string, error)
  • func (a AppSettings) GetTree(key string) DataTree
  • func (a AppSettings) GetTrees() map[string]*tree
  • func (a *AppSettings) Persist() error
  • func (a AppSettings) SetInt(key string, val int)
  • func (a AppSettings) SetInt64(key string, val int64)
  • func (a AppSettings) SetString(key string, val string)
• type DataTree

Variables

var ErrUndefinedKey = errors.New("undefined key")

ErrUndefinedKey is returned when the key requested from get is undefined.

Types

type AppSettings

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

AppSettings is the root most DataTree

func NewAppSettings

func NewAppSettings(dbFilename string) (*AppSettings, error)

NewAppSettings gets a new AppSettings struct

func (AppSettings) Delete

func (a AppSettings) Delete(key string)

func (AppSettings) DeleteTree

func (a AppSettings) DeleteTree(key string)

func (AppSettings) GetInt

func (a AppSettings) GetInt(key string) (int, error)

func (AppSettings) GetInt64

func (a AppSettings) GetInt64(key string) (int64, error)

func (AppSettings) GetLeaves

func (a AppSettings) GetLeaves() map[string]string

func (AppSettings) GetString

func (a AppSettings) GetString(key string) (string, error)

func (AppSettings) GetTree

func (a AppSettings) GetTree(key string) DataTree

GetTree fetches a tree for app setting storage

func (AppSettings) GetTrees

func (a AppSettings) GetTrees() map[string]*tree

func (*AppSettings) Persist

func (a *AppSettings) Persist() error

Persist causes the current state of the app settings to be persisted.

func (AppSettings) SetInt

func (a AppSettings) SetInt(key string, val int)

func (AppSettings) SetInt64

func (a AppSettings) SetInt64(key string, val int64)

func (AppSettings) SetString

func (a AppSettings) SetString(key string, val string)

type DataTree

type DataTree interface {
	GetString(key string) (string, error)
	SetString(key string, val string)
	GetInt(key string) (int, error)
	SetInt(key string, val int)
	GetInt64(key string) (int64, error)
	SetInt64(key string, val int64)
	Delete(key string)
	DeleteTree(key string)
	GetTree(key string) DataTree

	GetTrees() map[string]*tree
	GetLeaves() map[string]string
}

DataTree is the host of key and branches of values