boltorm

package

v0.0.0-...-bb197c8 Latest Latest Go to latest Published: Jul 24, 2023 License: AGPL-3.0 Imports: 8 Imported by: 1

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/CCJ16/registration

Documentation ¶

Index ¶

Variables
type DB
- func NewBoltDB(db *bolt.DB) DB
- func NewMemoryDB() DB
type Tx

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrGeneric          = errors.NewClass("Generic Error")
	ErrKeyAlreadyExists = ErrGeneric.NewClass("Key already exists")
	ErrKeyDoesNotExist  = ErrGeneric.NewClass("Key does not exist")
	ErrTxNotWritable    = ErrGeneric.NewClass("Transaction not writable")
)

Functions ¶

This section is empty.

Types ¶

type DB ¶

type DB interface {
	Update(fn func(tx Tx) error) error
	View(fn func(tx Tx) error) error
}

func NewBoltDB ¶

func NewBoltDB(db *bolt.DB) DB

func NewMemoryDB ¶

func NewMemoryDB() DB

type Tx ¶

type Tx interface {
	CreateBucketIfNotExists(name []byte) error
	Insert(bucket, key []byte, data interface{}) error
	Update(bucket, key []byte, data interface{}) error
	AddIndex(indexBucket, index, key []byte) error
	NextSequenceForBucket(bucket []byte) (uint64, error)

	Get(bucket, key []byte, data interface{}) error
	GetAll(bucket []byte, dataType interface{}) (interface{}, error)
	GetByIndex(indexBucket, dataBucket, index []byte, data interface{}) error
	GetAllByIndex(indexBucket, bucket []byte, dataType interface{}) (interface{}, error)

	RemoveKeyFromIndex(indexBucket, key []byte) error
}

Source Files ¶

View all Source files

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