orm

Documentation

Index

• Variables
• func Mock(path string) (*bbolt.DB, error)
• func Put(db *bbolt.DB, bucket string, key string, obj any) error
• type Pair
  • func Get(db *bbolt.DB, bucket string, key string) (*Pair, error)
  • func GetAll(db *bbolt.DB, bucket string) ([]Pair, error)

Variables

var (
	// ErrBktKeyNotFound means key not found.
	ErrBktKeyNotFound = errors.New("orm: key not found")

	// ErrBktGet means get error.
	ErrBktGet = errors.New("orm: get error")

	// ErrBktPut means put error.
	ErrBktPut = errors.New("orm: put error")

	// ErrBktIter means iteration error.
	ErrBktIter = errors.New("orm: iteration error")
)

BUCKET

var (
	// ErrDbNotLoaded means db not loaded.
	ErrDbNotLoaded = errors.New("db: not loaded")
)

DB

var (
	// ErrMarshal means marshal error.
	ErrMarshal = errors.New("orm: marshal error")
)

JSON

var (
	// ErrTxBktNotFound means bucket not found.
	ErrTxBktNotFound = errors.New("orm: bucket not found")
)

TX

Functions

func Mock

func Mock(path string) (*bbolt.DB, error)

Mock mocks an orm.

func Put

func Put(db *bbolt.DB, bucket string, key string, obj any) error

Put puts a given key's value from given value.

Types

type Pair

type Pair struct {
	Key string
	Val []byte
}

Pair represents a kv record.

func Get

func Get(db *bbolt.DB, bucket string, key string) (*Pair, error)

Get gets a given key's value from given bucket.

func GetAll

func GetAll(db *bbolt.DB, bucket string) ([]Pair, error)

GetAll returns all of a given bucket's keys and objects.