database

Documentation

Index

• Variables
• func CreateDB(dir string, buckets ...[]byte) (*bolt.DB, error)
• func CreateDirs(dirs ...string)
• func DeleteKeyFromBucket(dir string, key int, bucketName []byte) error
• func OpenDB(dir string) (*bolt.DB, error)
• func Retrieve(dir string, bucketName []byte, key int) ([]byte, error)
• func RetrieveAllKeys(dir string, bucketName []byte) ([][]byte, error)
• func RetrieveAllKeysLim(dir string, bucketName []byte) (int, error)
• func Save(dir string, bucketName []byte, x interface{}, key int) error

Variables

var ErrBucketMissing = errors.New("bucket doesn't exist")

ErrBucketMissing is an error handler for a missing bucket

var ErrElementNotFound = errors.New("element not found")

ErrElementNotFound is an error handler for a missing element

Functions

func CreateDB

func CreateDB(dir string, buckets ...[]byte) (*bolt.DB, error)

CreateDB creates a new database

func CreateDirs

func CreateDirs(dirs ...string)

CreateDirs creates (db) directories if they don't exist

func DeleteKeyFromBucket

func DeleteKeyFromBucket(dir string, key int, bucketName []byte) error

DeleteKeyFromBucket deletes a given key from a bucket

func OpenDB

func OpenDB(dir string) (*bolt.DB, error)

OpenDB opens the database

func Retrieve

func Retrieve(dir string, bucketName []byte, key int) ([]byte, error)

Retrieve retrieves a byteString from the database

func RetrieveAllKeys

func RetrieveAllKeys(dir string, bucketName []byte) ([][]byte, error)

RetrieveAllKeys retrieves all key value pairs from the database

func RetrieveAllKeysLim

func RetrieveAllKeysLim(dir string, bucketName []byte) (int, error)

RetrieveAllKeysLim gets the total number of keys in a bucket

func Save

func Save(dir string, bucketName []byte, x interface{}, key int) error

Save inserts an interface with an integer key