kvlite

kvlite

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

Usage

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

ErrBadPadlock indicates an invalid padlock was provided.

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

ErrLocked indicates that the database is currently in use by another instance.

func CryptReset

func CryptReset(filename string) (err error)

CryptReset resets the database by deleting all encrypted keys and the KVLite bucket.

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
}

Store provides a list of all tables. Table creats a key/val direct to a specified Table. Sub Creates a new bucket with a different namespace. Bucket Creates a new bucket for shared tenants. Drop drops the specified table. CountKeys provides a total of keys in table. Keys provides a listing of all keys in table. CryptSet encrypts the value within the key/value pair. Set sets the key/value pair in table. Unset deletes the key/value pair in table. Get retrieves value at key in table. Close closes the kvliter.Store. Buckets lists all bucket namespaces.

func MemStore

func MemStore() Store

MemStore returns a new in-memory store.

func Open

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

Open opens or creates a database file and performs necessary setup. It handles reset, decryption, and sets up the encoder.

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 represents an interface for key-value storage. It provides methods for managing keys, values, and the table itself.