nutsdb

package module

Go to main page

Versions in this module

v0

v0.11.1

Nov 13, 2022

Changes in this version

type Options

+ BufferSizeOfRecovery int

v0.11.0

Oct 31, 2022

Changes in this version

+ const B

+ const GB

+ const KB

+ const MB

+ func MatchForRange(pattern, key string, f func(key string) bool) (end bool, err error)

type Entry

+ func (e *Entry) ParsePayload(data []byte) error

+ type IteratorOptions struct

+ Reverse bool

v0.10.0

Aug 13, 2022

Changes in this version

+ const DataLRemByIndex

+ func MarshalInts(ints []int) ([]byte, error)

+ func UnmarshalInts(data []byte) ([]int, error)

+ type Iterator struct

+ func NewIterator(tx *Tx, bucket string) *Iterator

+ func (it *Iterator) Entry() *Entry

+ func (it *Iterator) Seek(key []byte) error

+ func (it *Iterator) SetNext() (bool, error)

+ type Option func(*Options)

+ func WithCleanFdsCacheThreshold(threshold float64) Option

+ func WithDir(dir string) Option

+ func WithEntryIdxMode(entryIdxMode EntryIdxMode) Option

+ func WithMaxFdNumsInCache(num int) Option

+ func WithNodeNum(num int64) Option

+ func WithRWMode(rwMode RWMode) Option

+ func WithSegmentSize(size int64) Option

+ func WithStartFileLoadingMode(rwMode RWMode) Option

+ func WithSyncEnable(enable bool) Option

type Tx

+ func (tx *Tx) LKeys(bucket, pattern string, f func(key string) bool) error

+ func (tx *Tx) LRemByIndex(bucket string, key []byte, indexes ...int) (removedNum int, err error)

+ func (tx *Tx) SKeys(bucket, pattern string, f func(key string) bool) error

+ func (tx *Tx) ZKeys(bucket, pattern string, f func(key string) bool) error

v0.9.0

Jun 17, 2022

Changes in this version

+ const DefaultMaxFileNums

+ const TooManyFileOpenErrSuffix

+ func IsBucketEmpty(err error) bool

+ func IsBucketNotFound(err error) bool

+ func IsDBClosed(err error) bool

+ func IsKeyEmpty(err error) bool

+ func IsKeyNotFound(err error) bool

+ func IsPrefixScan(err error) bool

+ func IsPrefixSearchScan(err error) bool

type DataFile

+ func (df *DataFile) Release() (err error)

+ type FdInfo struct

type FileIORWManager

+ func (fm *FileIORWManager) Release() (err error)

type MMapRWManager

+ func (mm *MMapRWManager) Release() (err error)

type Options

+ CleanFdsCacheThreshold float64

+ MaxFdNumsInCache int

type RWManager

+ Release func() (err error)

v0.8.0

Apr 1, 2022

v0.7.1

Mar 6, 2022

Changes in this version

+ const DataBPTreeBucketDeleteFlag

+ const DataListBucketDeleteFlag

+ const DataSetBucketDeleteFlag

+ const DataSortedSetBucketDeleteFlag

+ const DataStructureNone

v0.7.0

Mar 6, 2022

Changes in this version

+ var ErrNotSupportHintBPTSparseIdxMode = errors.New("not support mode `HintBPTSparseIdxMode`")

type BPTree

+ func (t *BPTree) FindRange(start, end []byte, f func(key, value []byte) bool) (numFound int, keys [][]byte, pointers []interface{})

type DB

+ func (db *DB) BackupTarGZ(w io.Writer) error

type Hint

+ DataPos uint64

+ FileID int64

+ Key []byte

+ Meta *MetaData

type MetaData

+ Bucket []byte

+ BucketSize uint32

+ Ds uint16

+ KeySize uint32

+ Status uint16

+ Timestamp uint64

+ TxID uint64

+ ValueSize uint32

type Tx

+ func (tx *Tx) DeleteBucket(ds uint16, bucket string) error

+ func (tx *Tx) IterateBuckets(ds uint16, f func(bucket string)) error

v0.6.0

Mar 21, 2021

Changes in this version

+ const PrefixSearchScan

+ var ErrBadRegexp = errors.New("bad regular expression")

+ var ErrBucketNotFound = errors.New("bucket not found")

+ var ErrPrefixSearchScan = errors.New("prefix and search scans not found")

+ var ErrPrefixSearchScansNoResult = errors.New("prefix and search scans no result")

type BPTree

+ func (t *BPTree) PrefixSearchScan(prefix []byte, reg string, offsetNum int, limitNum int) (records Records, off int, err error)

type Tx

+ func (tx *Tx) PrefixSearchScan(bucket string, prefix []byte, reg string, offsetNum int, limitNum int) (es Entries, off int, err error)

+ func (tx *Tx) PutWithTimestamp(bucket string, key, value []byte, ttl uint32, timestamp uint64) error

v0.5.0

Nov 28, 2019

Changes in this version

+ const BPTIndexSuffix

+ const BPTRootIndexSuffix

+ const BPTRootTxIDIndexSuffix

+ const BPTTxIDIndexSuffix

+ const BPTreeRootIdxHeaderSize

+ const BucketMetaHeaderSize

+ const BucketMetaSuffix

+ const DefaultInvalidAddress

+ var ErrBucketEmpty = errors.New("bucket is empty")

+ func SortFID(BPTreeRootIdxGroup []*BPTreeRootIdx, by sortBy)

type BPTree

+ Filepath string

+ FirstKey []byte

+ LastAddress int64

+ LastKey []byte

+ func (t *BPTree) All() (records Records, err error)

+ func (t *BPTree) SetKeyPosMap(keyPosMap map[string]int64)

+ func (t *BPTree) ToBinary(n *Node) (result []byte, err error)

+ func (t *BPTree) WriteNode(n *Node, off int64, syncEnable bool, fd *os.File) (number int, err error)

+ func (t *BPTree) WriteNodes(rwMode RWMode, syncEnable bool, flag int) error

+ type BPTreeRootIdx struct

+ func ReadBPTreeRootIdxAt(path string, off int64) (*BPTreeRootIdx, error)

+ func (bri *BPTreeRootIdx) Encode() []byte

+ func (bri *BPTreeRootIdx) GetCrc(buf []byte) uint32

+ func (bri *BPTreeRootIdx) IsZero() bool

+ func (bri *BPTreeRootIdx) Persistence(path string, offset int64, syncEnable bool) (number int, err error)

+ func (bri *BPTreeRootIdx) Size() int64

+ type BPTreeRootIdxWrapper struct

+ BSGroup []*BPTreeRootIdx

+ func (bsw BPTreeRootIdxWrapper) Len() int

+ func (bsw BPTreeRootIdxWrapper) Less(i, j int) bool

+ func (bsw BPTreeRootIdxWrapper) Swap(i, j int)

+ type BinaryNode struct

+ Address int64

+ IsLeaf uint16

+ Keys [order - 1]int64

+ KeysNum uint16

+ NextAddress int64

+ Pointers [order]int64

+ func ReadNode(Filepath string, address int64) (bn *BinaryNode, err error)

+ type BucketMeta struct

+ func ReadBucketMeta(name string) (bucketMeta *BucketMeta, err error)

+ func (bm *BucketMeta) Encode() []byte

+ func (bm *BucketMeta) GetCrc(buf []byte) uint32

+ func (bm *BucketMeta) Size() int64

+ type BucketMetasIdx map[string]*BucketMeta

type DB

+ ActiveBPTreeIdx *BPTree

+ ActiveCommittedTxIdsIdx *BPTree

+ BPTreeKeyEntryPosMap map[string]int64

+ BPTreeRootIdxes []*BPTreeRootIdx

type EntryIdxMode

+ const HintBPTSparseIdxMode

type Node

+ Address int64

+ Next *Node

type Tx

+ ReservedStoreTxIDIdxes map[int64]*BPTree

+ func (tx *Tx) FindLeafOnDisk(fID int64, rootOff int64, key, newKey []byte) (bn *BinaryNode, err error)

+ func (tx *Tx) FindOnDisk(fID uint64, rootOff uint64, key, newKey []byte) (entry *Entry, err error)

+ func (tx *Tx) FindTxIDOnDisk(fID, txID uint64) (ok bool, err error)

+ func (tx *Tx) GetAll(bucket string) (entries Entries, err error)

v0.4.0

Mar 15, 2019

Changes in this version

+ var ErrIndexOutOfBound = errors.New("offset out of mapped region")

+ var ErrUnmappedMemory = errors.New("unmapped memory")

+ func Truncate(path string, capacity int64, f *os.File) error

type DataFile

+ func (df *DataFile) Close() (err error)

+ type FileIORWManager struct

+ func NewFileIORWManager(path string, capacity int64) (*FileIORWManager, error)

+ func (fm *FileIORWManager) Close() (err error)

+ func (fm *FileIORWManager) ReadAt(b []byte, off int64) (n int, err error)

+ func (fm *FileIORWManager) Sync() (err error)

+ func (fm *FileIORWManager) WriteAt(b []byte, off int64) (n int, err error)

+ type MMapRWManager struct

+ func NewMMapRWManager(path string, capacity int64) (*MMapRWManager, error)

+ func (mm *MMapRWManager) Close() (err error)

+ func (mm *MMapRWManager) ReadAt(b []byte, off int64) (n int, err error)

+ func (mm *MMapRWManager) Sync() (err error)

+ func (mm *MMapRWManager) WriteAt(b []byte, off int64) (n int, err error)

type Options

+ RWMode RWMode

+ StartFileLoadingMode RWMode

+ SyncEnable bool

+ type RWManager interface

+ Close func() (err error)

+ ReadAt func(b []byte, off int64) (n int, err error)

+ Sync func() (err error)

+ WriteAt func(b []byte, off int64) (n int, err error)

+ type RWMode int

+ const FileIO

+ const MMap

v0.3.0

Mar 12, 2019

Changes in this version

+ var ErrCapacity = errors.New("capacity error")

+ var ErrFn = errors.New("err fn")

type DataFile

+ func (df *DataFile) Sync() (err error)

type EntryIdxMode

+ const HintKeyAndRAMIdxMode

+ const HintKeyValAndRAMIdxMode

v0.2.0

Mar 5, 2019

Changes in this version

+ const DataLPopFlag

+ const DataLPushFlag

+ const DataLRemFlag

+ const DataLSetFlag

+ const DataLTrimFlag

+ const DataRPopFlag

+ const DataRPushFlag

+ const DataStructureBPTree

+ const DataStructureList

+ const DataStructureSet

+ const DataStructureSortedSet

+ const DataZAddFlag

+ const DataZPopMaxFlag

+ const DataZPopMinFlag

+ const DataZRemFlag

+ const DataZRemRangeByRankFlag

+ const SeparatorForListKey

+ const SeparatorForZSetKey

+ var ErrEntryIdxModeOpt = errors.New("err EntryIdxMode option set")

+ func ErrBucketAndKey(bucket string, key []byte) error

+ func ErrNotFoundKeyInBucket(bucket string, key []byte) error

+ func ErrSeparatorForListKey() error

+ func ErrSeparatorForZSetKey() error

+ func ErrWhenBuildListIdx(err error) error

type BPTree

+ ValidKeyCount int

type DB

+ BPTreeIdx BPTreeIdx

+ ListIdx ListIdx

+ MaxFileID int64

+ SetIdx SetIdx

+ SortedSetIdx SortedSetIdx

+ type ListIdx map[string]*list.List

type Record

+ func (r *Record) IsExpired() bool

+ func (r *Record) UpdateRecord(h *Hint, e *Entry) error

+ type SetIdx map[string]*set.Set

+ type SortedSetIdx map[string]*zset.SortedSet

type Tx

+ func (tx *Tx) LPeek(bucket string, key []byte) (item []byte, err error)

+ func (tx *Tx) LPop(bucket string, key []byte) (item []byte, err error)

+ func (tx *Tx) LPush(bucket string, key []byte, values ...[]byte) error

+ func (tx *Tx) LRange(bucket string, key []byte, start, end int) (list [][]byte, err error)

+ func (tx *Tx) LRem(bucket string, key []byte, count int) error

+ func (tx *Tx) LSet(bucket string, key []byte, index int, value []byte) error

+ func (tx *Tx) LSize(bucket string, key []byte) (int, error)

+ func (tx *Tx) LTrim(bucket string, key []byte, start, end int) error

+ func (tx *Tx) RPeek(bucket string, key []byte) (item []byte, err error)

+ func (tx *Tx) RPop(bucket string, key []byte) (item []byte, err error)

+ func (tx *Tx) RPush(bucket string, key []byte, values ...[]byte) error

+ func (tx *Tx) SAdd(bucket string, key []byte, items ...[]byte) error

+ func (tx *Tx) SAreMembers(bucket string, key []byte, items ...[]byte) (bool, error)

+ func (tx *Tx) SCard(bucket string, key []byte) (int, error)

+ func (tx *Tx) SDiffByOneBucket(bucket string, key1, key2 []byte) (list [][]byte, err error)

+ func (tx *Tx) SDiffByTwoBuckets(bucket1 string, key1 []byte, bucket2 string, key2 []byte) (list [][]byte, err error)

+ func (tx *Tx) SHasKey(bucket string, key []byte) (bool, error)

+ func (tx *Tx) SIsMember(bucket string, key, item []byte) (bool, error)

+ func (tx *Tx) SMembers(bucket string, key []byte) (list [][]byte, err error)

+ func (tx *Tx) SMoveByOneBucket(bucket string, key1, key2, item []byte) (bool, error)

+ func (tx *Tx) SMoveByTwoBuckets(bucket1 string, key1 []byte, bucket2 string, key2, item []byte) (bool, error)

+ func (tx *Tx) SPop(bucket string, key []byte) ([]byte, error)

+ func (tx *Tx) SRem(bucket string, key []byte, items ...[]byte) error

+ func (tx *Tx) SUnionByOneBucket(bucket string, key1, key2 []byte) (list [][]byte, err error)

+ func (tx *Tx) SUnionByTwoBuckets(bucket1 string, key1 []byte, bucket2 string, key2 []byte) (list [][]byte, err error)

+ func (tx *Tx) ZAdd(bucket string, key []byte, score float64, val []byte) error

+ func (tx *Tx) ZCard(bucket string) (int, error)

+ func (tx *Tx) ZCount(bucket string, start, end float64, opts *zset.GetByScoreRangeOptions) (int, error)

+ func (tx *Tx) ZGetByKey(bucket string, key []byte) (*zset.SortedSetNode, error)

+ func (tx *Tx) ZMembers(bucket string) (map[string]*zset.SortedSetNode, error)

+ func (tx *Tx) ZPeekMax(bucket string) (*zset.SortedSetNode, error)

+ func (tx *Tx) ZPeekMin(bucket string) (*zset.SortedSetNode, error)

+ func (tx *Tx) ZPopMax(bucket string) (*zset.SortedSetNode, error)

+ func (tx *Tx) ZPopMin(bucket string) (*zset.SortedSetNode, error)

+ func (tx *Tx) ZRangeByRank(bucket string, start, end int) ([]*zset.SortedSetNode, error)

+ func (tx *Tx) ZRangeByScore(bucket string, start, end float64, opts *zset.GetByScoreRangeOptions) ([]*zset.SortedSetNode, error)

+ func (tx *Tx) ZRank(bucket string, key []byte) (int, error)

+ func (tx *Tx) ZRem(bucket, key string) error

+ func (tx *Tx) ZRemRangeByRank(bucket string, start, end int) error

+ func (tx *Tx) ZRevRank(bucket string, key []byte) (int, error)

+ func (tx *Tx) ZScore(bucket string, key []byte) (float64, error)

v0.1.0

Feb 28, 2019

Changes in this version

+ const Committed

+ const CountFlagDisabled

+ const CountFlagEnabled

+ const DataDeleteFlag

+ const DataEntryHeaderSize

+ const DataSetFlag

+ const DataSuffix

+ const Persistent

+ const PrefixScan

+ const RangeScan

+ const ScanNoLimit

+ const UnCommitted

+ var DefaultOptions = Options

+ var ErrBucket = errors.New("err bucket")

+ var ErrCrc = errors.New(" crc error")

+ var ErrCrcZero = errors.New("error crc is 0")

+ var ErrDBClosed = errors.New("db is closed")

+ var ErrKeyAndValSize = errors.New("key and value size too big")

+ var ErrKeyEmpty = errors.New("key cannot be empty")

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

+ var ErrNotFoundKey = errors.New("key not found in the bucket")

+ var ErrPrefixScan = errors.New("prefix scans not found")

+ var ErrPrefixScansNoResult = errors.New("prefix scans no result")

+ var ErrRangeScan = errors.New("range scans not found")

+ var ErrScansNoResult = errors.New("range scans or prefix scans no result")

+ var ErrStartKey = errors.New("err start key")

+ var ErrTxClosed = errors.New("tx is closed")

+ var ErrTxNotWritable = errors.New("tx not writable")

+ func IsExpired(ttl uint32, timestamp uint64) bool

+ func SortedEntryKeys(m map[string]*Entry) (keys []string, es map[string]*Entry)

+ type BPTree struct

+ func NewTree() *BPTree

+ func (t *BPTree) Find(key []byte) (*Record, error)

+ func (t *BPTree) FindLeaf(key []byte) *Node

+ func (t *BPTree) Insert(key []byte, e *Entry, h *Hint, countFlag bool) error

+ func (t *BPTree) PrefixScan(prefix []byte, limitNum int) (records Records, err error)

+ func (t *BPTree) Range(start, end []byte) (records Records, err error)

+ type BPTreeIdx map[string]*BPTree

+ type DB struct

+ ActiveFile *DataFile

+ HintIdx BPTreeIdx

+ KeyCount int

+ MaxFileId int64

+ func Open(opt Options) (*DB, error)

+ func (db *DB) Backup(dir string) error

+ func (db *DB) Begin(writable bool) (tx *Tx, err error)

+ func (db *DB) Close() error

+ func (db *DB) GetValidKeyCount(bucket string) (keyCount int, err error)

+ func (db *DB) Merge() error

+ func (db *DB) Update(fn func(tx *Tx) error) error

+ func (db *DB) View(fn func(tx *Tx) error) error

+ type DataFile struct

+ ActualSize int64

+ func NewDataFile(path string, capacity int64) (*DataFile, error)

+ func (df *DataFile) ReadAt(off int) (e *Entry, err error)

+ func (df *DataFile) WriteAt(b []byte, off int64) (n int, err error)

+ type Entries map[string]*Entry

+ type Entry struct

+ Key []byte

+ Meta *MetaData

+ Value []byte

+ func (e *Entry) Encode() []byte

+ func (e *Entry) GetCrc(buf []byte) uint32

+ func (e *Entry) IsZero() bool

+ func (e *Entry) Size() int64

+ type EntryIdxMode int

+ const HintAndMemoryMapIdxMode

+ const HintAndRAMIdxMode

+ type Hint struct

+ type MergeStrategy string

+ type MetaData struct

+ Flag uint16

+ TTL uint32

+ type Node struct

+ Keys [][]byte

+ KeysNum int

+ type Options struct

+ Dir string

+ EntryIdxMode EntryIdxMode

+ NodeNum int64

+ SegmentSize int64

+ type Record struct

+ E *Entry

+ H *Hint

+ type Records map[string]*Record

+ type Tx struct

+ func (tx *Tx) Commit() error

+ func (tx *Tx) Delete(bucket string, key []byte) error

+ func (tx *Tx) Get(bucket string, key []byte) (e *Entry, err error)

+ func (tx *Tx) PrefixScan(bucket string, prefix []byte, limitNum int) (es Entries, err error)

+ func (tx *Tx) Put(bucket string, key, value []byte, ttl uint32) error

+ func (tx *Tx) RangeScan(bucket string, start, end []byte) (entries Entries, err error)

+ func (tx *Tx) Rollback() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL