database

package

v0.2.0 Latest Latest Go to latest Published: Feb 21, 2022 License: MIT Imports: 3 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

Repository

github.com/ric-v/divulge-keyvalue-db-ui

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type BoltDB
type BuntDB
type DB
- func NewDB(fileName string, dbtype string) (DB, error)
type DBType
type KeyValuePair

Constants ¶

View Source

const (
	// BOLT_DB - BoltDB
	BOLT_DB = "boltdb"
	// BUNT_DB - BuntDB
	BUNT_DB = "buntdb"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BoltDB ¶

type BoltDB struct {
	*bolt.DB
	// contains filtered or unexported fields
}

BoltDB - BoltDB struct

func (*BoltDB) Add ¶

func (db *BoltDB) Add(key string, value string, args ...interface{}) error

Add godoc - Adds a new key/value pair to the database

func (*BoltDB) AddBucket ¶ added in v0.2.0

func (db *BoltDB) AddBucket(bucketName string) error

AddBucket godoc - Adds a new bucket to the database

func (*BoltDB) CloseDB ¶

func (db *BoltDB) CloseDB()

CloseDB godoc - Closes the database

func (*BoltDB) Conn ¶ added in v0.2.0

func (db *BoltDB) Conn() interface{}

Conn godoc - Returns the underlying database connection

func (*BoltDB) Delete ¶

func (db *BoltDB) Delete(key string) error

Delete godoc - Deletes a key/value pair from the database

func (*BoltDB) DeleteBucket ¶ added in v0.2.0

func (db *BoltDB) DeleteBucket(bucketName string) error

DeleteBucket godoc - Deletes a bucket from the database

func (*BoltDB) Get ¶

func (db *BoltDB) Get(key string) (string, error)

Get godoc - Gets a value from the database

func (*BoltDB) GetDefBucket ¶ added in v0.2.0

func (db *BoltDB) GetDefBucket() string

SetBucket godoc - Sets the current bucket

func (*BoltDB) List ¶

func (db *BoltDB) List(args ...interface{}) (data []KeyValuePair, err error)

List godoc - Lists all key/value pairs in the database

func (*BoltDB) ListBuckets ¶ added in v0.2.0

func (db *BoltDB) ListBuckets() (data []string, err error)

ListBuckets godoc - Lists all buckets in the database

func (*BoltDB) SetBucket ¶ added in v0.2.0

func (db *BoltDB) SetBucket(bucketName string)

SetBucket godoc - Sets the current bucket

type BuntDB ¶

type BuntDB struct {
	*buntdb.DB
}

BuntDB - BuntDB struct

func (*BuntDB) Add ¶

func (db *BuntDB) Add(key string, value string, args ...interface{}) error

Add godoc - Adds a new key/value pair to the database

func (*BuntDB) CloseDB ¶

func (db *BuntDB) CloseDB()

CloseDB godoc - Closes the database

func (*BuntDB) Conn ¶ added in v0.2.0

func (db *BuntDB) Conn() interface{}

Conn godoc - Returns the underlying database connection

func (*BuntDB) Delete ¶

func (db *BuntDB) Delete(key string) error

Delete godoc - Deletes a key/value pair from the database

func (*BuntDB) Get ¶

func (db *BuntDB) Get(key string) (string, error)

Get godoc - Gets a value from the database

func (*BuntDB) List ¶

func (db *BuntDB) List(args ...interface{}) (data []KeyValuePair, err error)

List godoc - Lists all keys in the database

type DB ¶

type DB interface {
	Conn() interface{}
	Add(string, string, ...interface{}) error
	CloseDB()
	Get(key string) (string, error) // TODO: add list all keys
	Delete(string) error
	List(args ...interface{}) ([]KeyValuePair, error)
}

DB interface for underlying database packages

func NewDB ¶

func NewDB(fileName string, dbtype string) (DB, error)

NewDB godoc - creates a new DB instance abstracting the underlying database package

type DBType ¶

type DBType string

DBType for identifying underlying database packages

type KeyValuePair ¶

type KeyValuePair struct {
	Key   string
	Value string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL