datastores

Documentation

Index

• type BoltDB
  • func (store BoltDB) Get(configItem *ConfigItem) (ConfigItem, error)
  • func (store BoltDB) GetAll() ([]ConfigItem, error)
  • func (store BoltDB) GetAllApplications() ([]string, error)
  • func (store BoltDB) GetAllForApplication(application string) ([]ConfigItem, error)
  • func (store BoltDB) InitStore(overwrite bool) error
  • func (store BoltDB) Remove(configItem *ConfigItem) error
  • func (store BoltDB) Set(configItem *ConfigItem) (ConfigItem, error)
• type ConfigItem
• type ConfigResponse
• type ConfigService
  • func GetConfigDatastore() ConfigService

Types

type BoltDB

type BoltDB struct {
	Database string
	User     string
	Password string
}

The BoltDB database information

func (BoltDB) Get

func (store BoltDB) Get(configItem *ConfigItem) (ConfigItem, error)

func (BoltDB) GetAll

func (store BoltDB) GetAll() ([]ConfigItem, error)

func (BoltDB) GetAllApplications

func (store BoltDB) GetAllApplications() ([]string, error)

func (BoltDB) GetAllForApplication

func (store BoltDB) GetAllForApplication(application string) ([]ConfigItem, error)

func (BoltDB) InitStore

func (store BoltDB) InitStore(overwrite bool) error

func (BoltDB) Remove

func (store BoltDB) Remove(configItem *ConfigItem) error

func (BoltDB) Set

func (store BoltDB) Set(configItem *ConfigItem) (ConfigItem, error)

type ConfigItem

type ConfigItem struct {
	Id          int64     `sql:"id" json:"id"`
	Application string    `sql:"application" json:"application"`
	Machine     string    `sql:"machine" json:"machine"`
	Name        string    `sql:"name" json:"name"`
	Value       string    `sql:"value" json:"value"`
	LastUpdated time.Time `sql:"updated" json:"updated"`
}

ConfigItem represents a configuration item

type ConfigResponse

type ConfigResponse struct {
	Status  int         `json:"status"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

type ConfigService

type ConfigService interface {

	//	Initialize the store (create the DDL if necessary)
	InitStore(overwrite bool) error

	//	Create / update a config item
	Set(c *ConfigItem) (ConfigItem, error)

	//	Get a specific config item
	Get(c *ConfigItem) (ConfigItem, error)

	//	Get all config items for the given application
	GetAllForApplication(application string) ([]ConfigItem, error)

	//	Get all config items for all applications (including global)
	GetAll() ([]ConfigItem, error)

	//	Get all applications (including global)
	GetAllApplications() ([]string, error)

	//	Remove a config item
	Remove(c *ConfigItem) error
}

ConfigService encapsulates account (user) based operations This allows us to create a testable service layer. See https://github.com/tonyhb/tonyhb.com/blob/master/posts/Building%20a%20testable%20Golang%20database%20layer.md for more information

func GetConfigDatastore

func GetConfigDatastore() ConfigService

Get the currently configured datastore