db

README

db

a key-value file system database

Documentation

Index

• Variables
• func GzipCompress(src []byte) ([]byte, error)
• func GzipUncompress(src []byte) ([]byte, error)
• func PaddingZero(val any, length int) string
• func ParseReflectValue(val reflect.Value) (any, bool)
• func ToBytes(data any) []byte
• func ToModelName(model any) string
• type DB
  • func New(dir string, readOnly bool) (*DB, error)
  • func (t *DB) Close()
  • func (t *DB) List(prefix string, fn func(key string, value []byte) (stop bool, err error), ...) error
  • func (t *DB) Txn(fn func(txn *Txn) error, readOnly ...bool) error
• type ListOption
• type Txn
  • func (t *Txn) Dec(key string, step int64) (int64, error)
  • func (t *Txn) Del(key string) error
  • func (t *Txn) Get(key string) ([]byte, error)
  • func (t *Txn) Has(key string) bool
  • func (t *Txn) Inc(key string, step int64) (int64, error)
  • func (txn *Txn) IndexAdd(model any, field string, val, id any) error
  • func (txn *Txn) IndexClear(model any, field string, val any) error
  • func (txn *Txn) IndexCount(model any, field string, val any) (total int64)
  • func (txn *Txn) IndexDel(model any, field string, val, id any) error
  • func (txn *Txn) IndexFirst(model any, field string, val any) (string, error)
  • func (txn *Txn) IndexList(model any, field string, val any, opts ...*ListOption) (list []string, err error)
  • func (txn *Txn) IndexModel(id, model any) error
  • func (t *Txn) List(prefix string, fn func(key string, value []byte) (stop bool, err error), ...) error
  • func (t *Txn) Set(key string, value any) error
  • func (t *Txn) Unmarshal(key string, value any) error

Variables

var (
	ErrKeyNotFound = errors.New("key not found")
)

Functions

func GzipCompress

func GzipCompress(src []byte) ([]byte, error)

func GzipUncompress

func GzipUncompress(src []byte) ([]byte, error)

func PaddingZero

func PaddingZero(val any, length int) string

func ParseReflectValue

func ParseReflectValue(val reflect.Value) (any, bool)

Whether value can be taken directly

func ToBytes

func ToBytes(data any) []byte

func ToModelName

func ToModelName(model any) string

Types

type DB

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

func New

func New(dir string, readOnly bool) (*DB, error)

or set env: DATABASE_DIR

func (*DB) Close

func (t *DB) Close()

func (*DB) List

func (t *DB) List(prefix string, fn func(key string, value []byte) (stop bool, err error), options ...*ListOption) error

func (*DB) Txn

func (t *DB) Txn(fn func(txn *Txn) error, readOnly ...bool) error

type ListOption

type ListOption struct {
	Begin        string // The starting key, not included by default
	ContainBegin bool   // The result contains the key of begin
	Reverse      bool   // Iterate from back to front
	Limit        int    // The maximum number of iterations
	KeyOnly      bool   // Only iterate over keys
}

type Txn

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

func (*Txn) Dec

func (t *Txn) Dec(key string, step int64) (int64, error)

return new value

func (*Txn) Del

func (t *Txn) Del(key string) error

func (*Txn) Get

func (t *Txn) Get(key string) ([]byte, error)

func (*Txn) Has

func (t *Txn) Has(key string) bool

func (*Txn) Inc

func (t *Txn) Inc(key string, step int64) (int64, error)

return new value

func (*Txn) IndexAdd

func (txn *Txn) IndexAdd(model any, field string, val, id any) error

func (*Txn) IndexClear

func (txn *Txn) IndexClear(model any, field string, val any) error

func (*Txn) IndexCount

func (txn *Txn) IndexCount(model any, field string, val any) (total int64)

func (*Txn) IndexDel

func (txn *Txn) IndexDel(model any, field string, val, id any) error

func (*Txn) IndexFirst

func (txn *Txn) IndexFirst(model any, field string, val any) (string, error)

func (*Txn) IndexList

func (txn *Txn) IndexList(model any, field string, val any, opts ...*ListOption) (list []string, err error)

func (*Txn) IndexModel

func (txn *Txn) IndexModel(id, model any) error

func (*Txn) List

func (t *Txn) List(prefix string, fn func(key string, value []byte) (stop bool, err error), options ...*ListOption) error

func (*Txn) Set

func (t *Txn) Set(key string, value any) error

func (*Txn) Unmarshal

func (t *Txn) Unmarshal(key string, value any) error