db

Documentation

Overview

Package db exports multiple utilities to work with BoltDB databases.

Index

• type BDB
  • func Open(path string, cols ...string) (*BDB, error)
  • func (bdb *BDB) Get(col string, key string) ([]byte, error)
  • func (bdb *BDB) GetAll(col string) ([][]byte, error)
  • func (bdb *BDB) Remove(col string, key string) error
  • func (bdb *BDB) Set(col string, key string, val []byte) error
• type Bolter

Types

type BDB

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

BDB is a simple wrapper around a BoltDB database.

func Open

func Open(path string, cols ...string) (*BDB, error)

Open tries to get the database on the received path and create the specified collection (bucket in the case of a BoltDB database) if it does not already exist. If all the previous operations have succeeded it returns the database as a *BDB. If something goes wrong while opening the database o while creating the collection it returns a error.

func (*BDB) Get

func (bdb *BDB) Get(col string, key string) ([]byte, error)

Get returns specified element on a collection if it exist. If the received key doesn't exist it returns an error.

func (*BDB) GetAll

func (bdb *BDB) GetAll(col string) ([][]byte, error)

GetAll returns all the elements on the specified collection.

func (*BDB) Remove

func (bdb *BDB) Remove(col string, key string) error

Remove removes the specified element on a collection. It never returns a non-nil error.

func (*BDB) Set

func (bdb *BDB) Set(col string, key string, val []byte) error

Set tries to add to the specified collection (bucket in the case of a BoltDB database) an element. It returns the value of the added element on a []byte if the operation was successful or an error if something went wrong.

type Bolter

type Bolter interface {
	Set(col string, key string, val []byte) error
	Get(col string, key string) ([]byte, error)
	GetAll(col string) ([][]byte, error)
	Remove(col string, key string) error
}

Bolter is the interface that wraps all the basic methods to manage a BoltDB database.