boltutil

README

boltutil

Boltutil implements some utility tools for bolt database.

Documentation

Index

• Variables
• type Coder
• type Condition
  • func NewCondition() *Condition
  • func (c *Condition) FailIfExist(v ...bool) *Condition
  • func (c *Condition) FailIfNotExist(v ...bool) *Condition
  • func (c *Condition) IgnoreIfExist(v ...bool) *Condition
  • func (c *Condition) IgnoreIfNotExist(v ...bool) *Condition
• type DB
  • func Open(path string, options ...Option) (*DB, error)
  • func Wrap(db *bbolt.DB) *DB
  • func (d *DB) Close() error
  • func (d *DB) Count(obj Storable, filters ...*Filter) (int, error)
  • func (d *DB) Delete(obj Storable, conditions ...*Condition) error
  • func (d *DB) DeleteAllBucket() error
  • func (d *DB) DeleteBucket(hasBuckets ...HasBucket) error
  • func (d *DB) Exist(obj Storable) (bool, error)
  • func (d *DB) First(obj Storable, filters ...*Filter) error
  • func (d *DB) Get(obj Storable, conditions ...*Condition) error
  • func (d *DB) MDelete(objs ...Storable) error
  • func (d *DB) MGet(objs ...Storable) error
  • func (d *DB) MPut(objs ...Storable) error
  • func (d *DB) Put(obj Storable, conditions ...*Condition) error
  • func (d *DB) Scan(result any, filters ...*Filter) error
  • func (d *DB) Unwrap() *bbolt.DB
• type Filter
  • func NewFilter() *Filter
  • func (c *Filter) AddCondition(f func(k, v []byte) (skip bool, stop bool)) *Filter
  • func (c *Filter) AddStorableCondition(f func(obj Storable) (skip bool, stop bool)) *Filter
  • func (c *Filter) SetPrefix(prefix []byte) *Filter
  • func (c *Filter) SetRange(min, max []byte) *Filter
• type GobCoder
  • func (c GobCoder) Decode(reader io.Reader, v any) error
  • func (c GobCoder) Encode(writer io.Writer, v any) error
• type HasBeforePut
• type HasBucket
• type HasCoder
• type JsonCoder
  • func (c JsonCoder) Decode(reader io.Reader, v any) error
  • func (c JsonCoder) Encode(writer io.Writer, v any) error
• type Option
  • func WithDefaultCoder(defaultCoder Coder) Option
  • func WithFileMode(fileMode os.FileMode) Option
  • func WithFreelistType(freelistType bbolt.FreelistType) Option
  • func WithInitialMmapSize(initialMmapSize int) Option
  • func WithMmapFlags(mmapFlags int) Option
  • func WithNoFreelistSync(noFreelistSync bool) Option
  • func WithNoGrowSync(noGrowSync bool) Option
  • func WithNoSync(noSync bool) Option
  • func WithOpenFile(openFile func(string, int, os.FileMode) (*os.File, error)) Option
  • func WithPageSize(pageSize int) Option
  • func WithReadOnly(readOnly bool) Option
  • func WithTimeout(timeout time.Duration) Option
• type Storable
• type XmlCoder
  • func (c XmlCoder) Decode(reader io.Reader, v any) error
  • func (c XmlCoder) Encode(writer io.Writer, v any) error

Variables

var (
	ErrNotExist     = errors.New("not exist")
	ErrAlreadyExist = errors.New("already exist")
)

Types

type Coder

type Coder interface {
	Encode(writer io.Writer, v any) error
	Decode(reader io.Reader, v any) error
}

Coder is the interface that can encode and decode data.

type Condition

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

func NewCondition

func NewCondition() *Condition

func (*Condition) FailIfExist

func (c *Condition) FailIfExist(v ...bool) *Condition

func (*Condition) FailIfNotExist

func (c *Condition) FailIfNotExist(v ...bool) *Condition

func (*Condition) IgnoreIfExist

func (c *Condition) IgnoreIfExist(v ...bool) *Condition

func (*Condition) IgnoreIfNotExist

func (c *Condition) IgnoreIfNotExist(v ...bool) *Condition

type DB

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

func Open

func Open(path string, options ...Option) (*DB, error)

Open creates and opens a database with given options.

func Wrap

func Wrap(db *bbolt.DB) *DB

Wrap return a DB with then given bbolt.DB

func (*DB) Close

func (d *DB) Close() error

Close closes the database.

func (*DB) Count

func (d *DB) Count(obj Storable, filters ...*Filter) (int, error)

Count return count of kv in the bucket.

func (*DB) Delete

func (d *DB) Delete(obj Storable, conditions ...*Condition) error

Delete deletes storable object.

func (*DB) DeleteAllBucket

func (d *DB) DeleteAllBucket() error

DeleteAllBucket remove all buckets

func (*DB) DeleteBucket

func (d *DB) DeleteBucket(hasBuckets ...HasBucket) error

DeleteBucket remove the specified buckets

func (*DB) Exist

func (d *DB) Exist(obj Storable) (bool, error)

Exist check if the storable exist

func (*DB) First

func (d *DB) First(obj Storable, filters ...*Filter) error

First injects the first value in the bucket into result.

func (*DB) Get

func (d *DB) Get(obj Storable, conditions ...*Condition) error

Get injects storable object with its key.

func (*DB) MDelete

func (d *DB) MDelete(objs ...Storable) error

MDelete remove values by key of storables

func (*DB) MGet

func (d *DB) MGet(objs ...Storable) error

MGet injects storable objects with their keys.

func (*DB) MPut

func (d *DB) MPut(objs ...Storable) error

MPut store storables into database, create bucket if it does not exist.

func (*DB) Put

func (d *DB) Put(obj Storable, conditions ...*Condition) error

Put stores storable object.

func (*DB) Scan

func (d *DB) Scan(result any, filters ...*Filter) error

Scan scans values in the bucket and put them into result.

func (*DB) Unwrap

func (d *DB) Unwrap() *bbolt.DB

Unwrap return the original bbolt.DB

type Filter

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

func NewFilter

func NewFilter() *Filter

func (*Filter) AddCondition

func (c *Filter) AddCondition(f func(k, v []byte) (skip bool, stop bool)) *Filter

func (*Filter) AddStorableCondition

func (c *Filter) AddStorableCondition(f func(obj Storable) (skip bool, stop bool)) *Filter

func (*Filter) SetPrefix

func (c *Filter) SetPrefix(prefix []byte) *Filter

func (*Filter) SetRange

func (c *Filter) SetRange(min, max []byte) *Filter

type GobCoder

type GobCoder struct {
}

GobCoder implements Coder with gob

func (GobCoder) Decode

func (c GobCoder) Decode(reader io.Reader, v any) error

func (GobCoder) Encode

func (c GobCoder) Encode(writer io.Writer, v any) error

type HasBeforePut

type HasBeforePut interface {
	BeforePut(id uint64) // will be called before put, id is an auto incrementing integer for the bucket
}

HasBeforePut is the interface that indicates the BeforePut method

type HasBucket

type HasBucket interface {
	BoltBucket() []byte
}

HasBucket is the interface that indicates the bound bucket

type HasCoder

type HasCoder interface {
	BoltCoder() Coder
}

HasCoder is the interface that indicates the Coder of the type

type JsonCoder

type JsonCoder struct {
	Intent bool
}

JsonCoder implements Coder with json

func (JsonCoder) Decode

func (c JsonCoder) Decode(reader io.Reader, v any) error

func (JsonCoder) Encode

func (c JsonCoder) Encode(writer io.Writer, v any) error

type Option

type Option func(options *innerOption)

Option represents the options that can be set when opening a database.

func WithDefaultCoder

func WithDefaultCoder(defaultCoder Coder) Option

WithDefaultCoder return Option with specified DefaultCoder

func WithFileMode

func WithFileMode(fileMode os.FileMode) Option

WithFileMode return Option with specified FileMode

func WithFreelistType

func WithFreelistType(freelistType bbolt.FreelistType) Option

WithFreelistType return Option with specified FreelistType

func WithInitialMmapSize

func WithInitialMmapSize(initialMmapSize int) Option

WithInitialMmapSize return Option with specified InitialMmapSize

func WithMmapFlags

func WithMmapFlags(mmapFlags int) Option

WithMmapFlags return Option with specified MmapFlags

func WithNoFreelistSync

func WithNoFreelistSync(noFreelistSync bool) Option

WithNoFreelistSync return Option with specified NoFreelistSync

func WithNoGrowSync

func WithNoGrowSync(noGrowSync bool) Option

WithNoGrowSync return Option with specified NoGrowSync

func WithNoSync

func WithNoSync(noSync bool) Option

WithNoSync return Option with specified NoSync

func WithOpenFile

func WithOpenFile(openFile func(string, int, os.FileMode) (*os.File, error)) Option

WithOpenFile return Option with specified OpenFile,

func WithPageSize

func WithPageSize(pageSize int) Option

WithPageSize return Option with specified PageSize

func WithReadOnly

func WithReadOnly(readOnly bool) Option

WithReadOnly return Option with specified ReadOnly

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout return Option with specified Timeout

type Storable

type Storable interface {
	HasBucket
	BoltKey() []byte
}

Storable is the interface that can be stored into bolt.

type XmlCoder

type XmlCoder struct {
}

XmlCoder implements Coder with xml

func (XmlCoder) Decode

func (c XmlCoder) Decode(reader io.Reader, v any) error

func (XmlCoder) Encode

func (c XmlCoder) Encode(writer io.Writer, v any) error