db

README

db

a key-value file system database

Documentation

Index

• Variables
• func GenerateIndexBaseKey(model any, field string, val any) string
• func GetBucket(key string) string
• func GzipCompress(src []byte) ([]byte, error)
• func GzipUncompress(src []byte) ([]byte, error)
• func NewModel(model any) any
• func PaddingZero(val any, length int) string
• func ParseReflectValue(val reflect.Value) (any, bool)
• func ToBytes(data any) []byte
• func ToEntities[T any](items []any) []T
• func ToEntity[T any](val any) T
• func ToModelName(model any) string
• func ToSnake(text string) 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 (txn *Txn) Dec(key string, step int64) (int64, error)
  • func (txn *Txn) Del(key string) error
  • func (txn *Txn) Get(key string) ([]byte, error)
  • func (txn *Txn) Has(key string) bool
  • func (txn *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, isCreate bool) error
  • func (txn *Txn) List(prefix string, fn func(key string, value []byte) (stop bool, err error), ...) error
  • func (txn *Txn) ModelCounter(model any) (count int64)
  • func (txn *Txn) ModelDel(model, id any) error
  • func (txn *Txn) ModelGet(model, id any) (any, error)
  • func (txn *Txn) ModelIdLength(model any) (length int)
  • func (txn *Txn) ModelIndexList(model any, feild string, val any, opts ...*ListOption) (list []any, err error)
  • func (txn *Txn) ModelList(model any, limit int, begin string, reverse bool) (list []any, err error)
  • func (txn *Txn) ModelNextID(model any, length int) string
  • func (txn *Txn) ModelSet(model, id any) error
  • func (txn *Txn) ModelTotal(model any) (count int64)
  • func (txn *Txn) ModelUnmarshal(model, id any) error
  • func (txn *Txn) ModelUpdate(model, id any, cb func(mPointer any) error) error
  • func (txn *Txn) Set(key string, value any) error
  • func (txn *Txn) Unmarshal(key string, value any) error

Variables

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

Functions

func GenerateIndexBaseKey

func GenerateIndexBaseKey(model any, field string, val any) string

func GetBucket

func GetBucket(key string) string

func GzipCompress

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

func GzipUncompress

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

func NewModel

func NewModel(model any) any

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 ToEntities

func ToEntities[T any](items []any) []T

func ToEntity

func ToEntity[T any](val any) T

func ToModelName

func ToModelName(model any) string

func ToSnake

func ToSnake(text string) 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 (txn *Txn) Dec(key string, step int64) (int64, error)

return new value

func (*Txn) Del

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

func (*Txn) Get

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

func (*Txn) Has

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

func (*Txn) Inc

func (txn *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, isCreate bool) error

When isCreate is true, it means to create an index, otherwise it means to delete the index

func (*Txn) List

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

func (*Txn) ModelCounter

func (txn *Txn) ModelCounter(model any) (count int64)

func (*Txn) ModelDel

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

func (*Txn) ModelGet

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

func (*Txn) ModelIdLength

func (txn *Txn) ModelIdLength(model any) (length int)

func (*Txn) ModelIndexList

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

func (*Txn) ModelList

func (txn *Txn) ModelList(model any, limit int, begin string, reverse bool) (list []any, err error)

func (*Txn) ModelNextID

func (txn *Txn) ModelNextID(model any, length int) string

func (*Txn) ModelSet

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

func (*Txn) ModelTotal

func (txn *Txn) ModelTotal(model any) (count int64)

func (*Txn) ModelUnmarshal

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

func (*Txn) ModelUpdate

func (txn *Txn) ModelUpdate(model, id any, cb func(mPointer any) error) error

func (*Txn) Set

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

func (*Txn) Unmarshal

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