bbolt

Documentation

Overview

Package db implements simple method of treatment to bbolt db.

Index

• type Bucket
  • func (bucket *Bucket) Count() uint
  • func (bucket *Bucket) DB() DB
  • func (bucket *Bucket) Delete(keyI any) error
  • func (bucket *Bucket) DeleteAll() error
  • func (bucket *Bucket) Get(keyI any) (Model, error)
  • func (bucket *Bucket) Manager() ManagerI
  • func (bucket *Bucket) Model() Model
  • func (bucket *Bucket) Name() string
  • func (bucket *Bucket) Save(model Model) error
  • func (bucket *Bucket) SetManager(newManager ManagerI)
• type DataBase
  • func Open(path string) (*DataBase, error)
  • func (db *DataBase) BoltDB() *bolt.DB
  • func (db *DataBase) Close() error
  • func (db *DataBase) ExistsTable(name string) bool
  • func (db *DataBase) Table(_ string, model Model) (Table, error)
  • func (db *DataBase) TableFromCache(name string) Table

Types

type Bucket

type Bucket struct {
	Objects ManagerI
	// contains filtered or unexported fields
}

Bucket implements interface simple access to read/write in bbolt db.

func (*Bucket) Count

func (bucket *Bucket) Count() uint

func (*Bucket) DB

func (bucket *Bucket) DB() DB

DB returns pointer to DB.

func (*Bucket) Delete

func (bucket *Bucket) Delete(keyI any) error

Delete implements Deleting value of key in bucket.

func (*Bucket) DeleteAll

func (bucket *Bucket) DeleteAll() error

DeleteAll implements Deleting all values in bucket.

func (*Bucket) Get

func (bucket *Bucket) Get(keyI any) (Model, error)

Get implements getting value of key in bucket.

func (*Bucket) Manager

func (bucket *Bucket) Manager() ManagerI

func (*Bucket) Model

func (bucket *Bucket) Model() Model

Model returns string, name of Bucket.

func (*Bucket) Name

func (bucket *Bucket) Name() string

Name returns string, name of Bucket.

func (*Bucket) Save

func (bucket *Bucket) Save(model Model) error

func (*Bucket) SetManager

func (bucket *Bucket) SetManager(newManager ManagerI)

type DataBase

type DataBase struct {
	// contains filtered or unexported fields
}

DataBase implements interface access to bbolt db.

func Open

func Open(path string) (*DataBase, error)

Open return pointer to DataBase, If DataBase does not exist then error.

func (*DataBase) BoltDB

func (db *DataBase) BoltDB() *bolt.DB

func (*DataBase) Close

func (db *DataBase) Close() error

Close implements access to close DataBase.

func (*DataBase) ExistsTable

func (db *DataBase) ExistsTable(name string) bool

ExistsBucket returns true if bucket exists.

func (*DataBase) Table

func (db *DataBase) Table(_ string, model Model) (Table, error)

Table returns pointer to Bucket in db, Returns error if name is too long. name is not required

func (*DataBase) TableFromCache

func (db *DataBase) TableFromCache(name string) Table