binmandb

README

binmandb

This package is used by binman for interactions with a bbolt db.

Documentation

Index

• Variables
• func DeleteData(key string, db *bolt.DB) error
• func GetBytes(i interface{}) []byte
• func GetDB(dbPath string, o ...bolt.Options) *bolt.DB
• func GetData(key string, db *bolt.DB) ([]byte, error)
• func ParseKey(key string) [][]byte
• func RunDB(options DbConfig)
• func WriteData(overwrite bool, key string, data []byte, db *bolt.DB) error
• type DBResponse
• type DbConfig
• type DbMsg
  • func (dbMsg *DbMsg) Send(dbChan chan DbMsg) DBResponse

Variables

var (
	// ErrNilReadResponse is returned when a read operation  returns nil
	ErrNilReadResponse = errors.New("Read Operation returned nil")
	// ErrKeyExists is returned when trying to update a data key that already has data
	// This will only be returned if overwrite is set to false(the default)
	ErrKeyExists = errors.New("Refusing to overwrite exisitng data key")
)

Functions

func DeleteData

func DeleteData(key string, db *bolt.DB) error

DeleteData will delete either key/values or Buckets depending on what is sent by user

func GetBytes

func GetBytes(i interface{}) []byte

getBytes is a helper function to convert types to byte arrays as needed

func GetDB

func GetDB(dbPath string, o ...bolt.Options) *bolt.DB

func GetData

func GetData(key string, db *bolt.DB) ([]byte, error)

read from db

func ParseKey

func ParseKey(key string) [][]byte

func RunDB

func RunDB(options DbConfig)

RunDB waits for messages on dbChan and performs the appropriate operations

func WriteData

func WriteData(overwrite bool, key string, data []byte, db *bolt.DB) error

write to db

Types

type DBResponse

type DBResponse struct {
	Err  error
	Data []byte
}

type DbConfig

type DbConfig struct {
	Path      string
	Dwg       *sync.WaitGroup
	DbChan    chan DbMsg
	Overwrite bool
}

DbConfig contains required chan/wg + config options

type DbMsg

type DbMsg struct {
	Key        string // "Keys should be in the format key/subkey/subsubkey"
	Data       []byte
	Operation  string // "read/write/delete"
	ReturnChan chan DBResponse
	ReturnWg   *sync.WaitGroup
}

func (*DbMsg) Send

func (dbMsg *DbMsg) Send(dbChan chan DbMsg) DBResponse