database

package

v0.0.0-...-61cbdb0 Latest Latest Go to latest Published: Nov 27, 2017 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package database handles all communication between software and the database

View Source

const (
	BUCKET_USERS = "users"
	BUCKET_PORTS = "ports"
)

Bucket constants

View Source

const (
	DB_MAIN = "datastore.db"
)

Database constants

View Source

var (
	ErrKeyNotExist = errors.New("key does not exist")
)

Error codes

This section is empty.

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

func Open(filepath string) (*Datastore, error)

Open function will open the database and return a Datastore struct that has a handle within it for various datastore functions.

func (ds *Datastore) Close() error

Close is a function attached to the Datastore struct that will close the current bolt instance

func (ds *Datastore) Delete(bucket string, key []byte) error

Delete is a function attached to the Datastore struct that will delete data from the current bolt instance

func (ds *Datastore) Get(bucket string, key []byte, result interface{}) error

Get is a function attached to the Datastore struct that will get data from the current bolt instance

func (ds *Datastore) Put(bucket string, key []byte, value interface{}) error

Put is a function attached to the Datastore struct that will put data into the current bolt instance