kvlite

README

kvlite

-- import "github.com/cmcoffee/snugforge/kvlite"

Usage

var ErrBadPadlock = errors.New("Invalid padlock provided, unable to open database.")

ErrBadPadlock is returned if kvlite.Open is used with incorrect padlock set on database.

var ErrLocked = errors.New("Database is currently in use by an exisiting instance, please close it and try again.")

func CryptReset

func CryptReset(filename string) (err error)

Resets encryption key on database, removing all encrypted keys in the process.

type Store

type Store interface {
	// Tables provides a list of all tables.
	Tables() (tables []string, err error)
	// Table creats a key/val direct to a specified Table.
	Table(table string) Table
	// SubStore Creates a new bucket with a different namespace, tied to
	Sub(name string) Store
	// SyncStore Creates a new bucket for shared tenants.
	Bucket(name string) Store
	// Drop drops the specified table.
	Drop(table string) (err error)
	// CountKeys provides a total of keys in table.
	CountKeys(table string) (count int, err error)
	// Keys provides a listing of all keys in table.
	Keys(table string) (keys []string, err error)
	// CryptSet encrypts the value within the key/value pair in table.
	CryptSet(table, key string, value interface{}) (err error)
	// Set sets the key/value pair in table.
	Set(table, key string, value interface{}) (err error)
	// Unset deletes the key/value pair in table.
	Unset(table, key string) (err error)
	// Get retrieves value at key in table.
	Get(table, key string, output interface{}) (found bool, err error)
	// Close closes the kvliter.Store.
	Close() (err error)
	// contains filtered or unexported methods
}

Main Store Interface

func MemStore

func MemStore() Store

Creates a new ephemeral memory based kvliter.Store.

func Open

func Open(filename string, padlock ...byte) (Store, error)

Opens BoltDB backed kvlite.Store.

type Table

type Table interface {
	Keys() (keys []string, err error)
	CountKeys() (count int, err error)
	Set(key string, value interface{}) (err error)
	CryptSet(key string, value interface{}) (err error)
	Get(key string, value interface{}) (found bool, err error)
	Unset(key string) (err error)
	Drop() (err error)
}

Table Interface follows the Main Store Interface, but directly to a table.

Documentation

Index

• Variables
• func CryptReset(filename string) (err error)
• type Store
  • func MemStore() Store
  • func Open(filename string, padlock ...byte) (Store, error)
• type Table

Variables

var ErrBadPadlock = errors.New("Invalid padlock provided, unable to open database.")

ErrBadPadlock is returned if kvlite.Open is used with incorrect padlock set on database.

var ErrLocked = errors.New("Database is currently in use by an exisiting instance, please close it and try again.")

Functions

func CryptReset

func CryptReset(filename string) (err error)

Resets encryption key on database, removing all encrypted keys in the process.

Types

type Store

type Store interface {
	// Tables provides a list of all tables.
	Tables() (tables []string, err error)
	// Table creats a key/val direct to a specified Table.
	Table(table string) Table
	// SubStore Creates a new bucket with a different namespace, tied to
	Sub(name string) Store
	// SyncStore Creates a new bucket for shared tenants.
	Bucket(name string) Store
	// Drop drops the specified table.
	Drop(table string) (err error)
	// CountKeys provides a total of keys in table.
	CountKeys(table string) (count int, err error)
	// Keys provides a listing of all keys in table.
	Keys(table string) (keys []string, err error)
	// CryptSet encrypts the value within the key/value pair in table.
	CryptSet(table, key string, value interface{}) (err error)
	// Set sets the key/value pair in table.
	Set(table, key string, value interface{}) (err error)
	// Unset deletes the key/value pair in table.
	Unset(table, key string) (err error)
	// Get retrieves value at key in table.
	Get(table, key string, output interface{}) (found bool, err error)
	// Close closes the kvliter.Store.
	Close() (err error)
	// contains filtered or unexported methods
}

Main Store Interface

func MemStore

func MemStore() Store

Creates a new ephemeral memory based kvliter.Store.

func Open

func Open(filename string, padlock ...byte) (Store, error)

Opens BoltDB backed kvlite.Store.

type Table

type Table interface {
	Keys() (keys []string, err error)
	CountKeys() (count int, err error)
	Set(key string, value interface{}) (err error)
	CryptSet(key string, value interface{}) (err error)
	Get(key string, value interface{}) (found bool, err error)
	Unset(key string) (err error)
	Drop() (err error)
}

Table Interface follows the Main Store Interface, but directly to a table.