database

package

v0.3.0 Latest Latest Go to latest Published: Dec 21, 2023 License: MIT Imports: 5 Imported by: 0

Details

Package database is for a local storage layer for the application

This section is empty.

View Source

var ErrDatabaseNotConnected = errors.New("database is not connected")

ErrDatabaseNotConnected is returned when the database is not connected

This section is empty.

type DB struct {
	Connected bool
	// contains filtered or unexported fields
}

DB is the database struct

func Connect(folder, database string) (db *DB, err error)

Connect will make a new database connection and new folder/file(s) if needed

func (db *DB) Disconnect() error

Disconnect will close the db connection

func (db *DB) Flush() error

Flush will empty the entire database

func (db *DB) GarbageCollection() (err error)

GarbageCollection will clean up some garbage in the database (reduces space, etc.)

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

Get will retrieve a value from a key (if found)

func (db *DB) Set(key, value string, ttl time.Duration) error

Set will store a new key/value pair (expiration optional)