dbutil

Documentation

Index

• func Get(db *bolt.DB, name string, record Record) error
• func GetBucketName(r Record) []byte
• func List[R Record](db *bolt.DB, record R) ([]R, error)
• func ListNames(db *bolt.DB, bucketName []byte) ([]string, error)
• func Put(b *bolt.Bucket, record Record) error
• func Remove(db *bolt.DB, bucketName []byte, names ...string) error
• func SetContext(t testing.TB, bucketName []byte) *bolt.DB
• func XorName(name []byte) []byte
• type Record

Functions

func Get

func Get(db *bolt.DB, name string, record Record) error

Get retrieves a record from the database, decrypts it and loads it into record.

func GetBucketName

func GetBucketName(r Record) []byte

GetBucketName returns the bucket name depending on the type of the record passed.

func List

func List[R Record](db *bolt.DB, record R) ([]R, error)

List returns a list of decrypted records from the database.

func ListNames

func ListNames(db *bolt.DB, bucketName []byte) ([]string, error)

ListNames returns a list with all the records names.

func Put

func Put(b *bolt.Bucket, record Record) error

Put encrypts and saves a record into the database.

func Remove

func Remove(db *bolt.DB, bucketName []byte, names ...string) error

Remove removes records from the database.

func SetContext

func SetContext(t testing.TB, bucketName []byte) *bolt.DB

SetContext creates a bucket and its context to test the database operations.

func XorName

func XorName(name []byte) []byte

XorName does the bitwise xor operation between a name and the authentication key.

Types

type Record

type Record interface {
	GetName() string
	proto.Message
}

Record is an interface that all kure objects implement.