nutsdb

package module

Go to main page

Versions in this module

v1

v1.0.4

Feb 25, 2024

v1.0.3

Dec 27, 2023

Changes in this version

+ const BucketStatusDeleted

+ var ErrKVArgsLenNotEven = errors.New("parameters is used to represent key value pairs and cannot be odd numbers")

+ var ErrOffsetInvalid = errors.New("offset is invalid")

+ var ErrStartGreaterThanEnd = errors.New("start is greater than end")

+ type EntryStatus = uint8

+ const EntryDeleted

+ const EntryUpdated

+ const NotFoundEntry

type Tx

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

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

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

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

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

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

+ func (tx *Tx) MGet(bucket string, keys ...[]byte) ([][]byte, error)

+ func (tx *Tx) MSet(bucket string, ttl uint32, args ...[]byte) error

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

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

v1.0.2

Dec 13, 2023

Changes in this version

+ const BucketStatusDelete

+ const BucketStatusExistAlready

+ const BucketStatusNew

+ const BucketStatusUnknown

+ const BucketStatusUpdated

+ var ErrValueNotInteger = errors.New("value is not an integer")

+ type BucketStatus = uint8

+ type DataFlag = uint16

+ type DataStatus = uint16

+ type DataStructure = uint16

type Entry

+ func (e *Entry) IsBelongsToBPlusTree() bool

+ func (e *Entry) IsBelongsToList() bool

+ func (e *Entry) IsBelongsToSet() bool

+ func (e *Entry) IsBelongsToSortSet() bool

+ type IDMarkerInBucket map[BucketName]map[Ds]BucketId

+ type InfoMapperInBucket map[BucketId]*Bucket

type MetaData

+ func (meta *MetaData) IsBPlusTree() bool

+ func (meta *MetaData) IsList() bool

+ func (meta *MetaData) IsSet() bool

+ func (meta *MetaData) IsSortSet() bool

type Tx

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

+ func (tx *Tx) DecrBy(bucket string, key []byte, decrement int64) error

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

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

+ func (tx *Tx) GetSet(bucket string, key, value []byte) (oldValue []byte, err error)

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

+ func (tx *Tx) IncrBy(bucket string, key []byte, increment int64) error

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

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

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

v1.0.1

Nov 30, 2023

v1.0.0

Nov 27, 2023

Changes in this version

+ const BucketStoreFileName

+ const DsSize

+ const IdSize

+ const MaxEntryHeaderSize

+ const MinEntryHeaderSize

+ var BucketMetaSize int64

+ var ErrBucketAlreadyExist = errors.New("bucket is already exist")

+ var ErrBucketCrcInvalid = errors.New("bucket crc invalid")

+ var ErrBucketNotExist = errors.New("bucket not exist")

+ var ErrHeaderSizeOutOfBounds = errors.New("the header size is out of bounds")

+ var ErrPayLoadSizeMismatch = errors.New("the payload size in Meta mismatch with the payload size needed")

+ var ErrorBucketNotExist = errors.New(...)

+ func UvarintSize(x uint64) int

+ type Bucket struct

+ Ds Ds

+ Id BucketId

+ Meta *BucketMeta

+ Name string

+ func (b *Bucket) Decode(bytes []byte) error

+ func (b *Bucket) Encode() []byte

+ func (b *Bucket) GetCRC(headerBuf []byte, dataBuf []byte) uint32

+ func (b *Bucket) GetEntrySize() int

+ func (b *Bucket) GetPayloadSize() int

+ type BucketId uint64

+ type BucketManager struct

+ BucketIDMarker map[BucketName]map[Ds]BucketId

+ BucketInfoMapper map[BucketId]*Bucket

+ Gen *IDGenerator

+ func NewBucketManager(dir string) (*BucketManager, error)

+ func (bm *BucketManager) ExistBucket(ds Ds, name BucketName) bool

+ func (bm *BucketManager) GetBucket(ds Ds, name BucketName) (b *Bucket, err error)

+ func (bm *BucketManager) GetBucketById(id uint64) (*Bucket, error)

+ func (bm *BucketManager) GetBucketID(ds Ds, name BucketName) (BucketId, error)

+ func (bm *BucketManager) SubmitPendingBucketChange(reqs []*bucketSubmitRequest) error

type BucketMeta

+ Crc uint32

+ Op BucketOperation

+ func (meta *BucketMeta) Decode(bytes []byte)

+ type BucketName string

+ type BucketOperation uint16

+ const BucketDeleteOperation

+ const BucketInsertOperation

+ const BucketUpdateOperation

type DataFile

+ func (df *DataFile) ReadEntry(off int, payloadSize int64) (e *Entry, err error)

+ type Ds uint16

type FileIORWManager

+ func (fm *FileIORWManager) Size() int64

+ type IDGenerator struct

+ func (g *IDGenerator) GenId() uint64

+ type LRUCache struct

+ func NewLruCache(cap int) *LRUCache

+ func (c *LRUCache) Add(key interface{}, value interface{})

+ func (c *LRUCache) Clear()

+ func (c *LRUCache) Get(key interface{}) interface{}

+ func (c *LRUCache) Len() int

+ func (c *LRUCache) Remove(key interface{})

+ type LruEntry struct

+ Key interface{}

+ Value interface{}

type MMapRWManager

+ func (mm *MMapRWManager) Size() int64

type MetaData

+ BucketId uint64

+ func (meta *MetaData) Size() int64

+ func (meta *MetaData) WithBucketId(bucketID uint64) *MetaData

type Option

+ func WithHintKeyAndRAMIdxCacheSize(size int) Option

type Options

+ HintKeyAndRAMIdxCacheSize int

type RWManager

+ Size func() int64

type Record

+ DataPos uint64

+ FileID int64

+ Key []byte

+ TTL uint32

+ Timestamp uint64

+ TxID uint64

+ Value []byte

+ ValueSize uint32

+ func (r *Record) WithDataPos(pos uint64) *Record

+ func (r *Record) WithFileId(fid int64) *Record

+ func (r *Record) WithKey(k []byte) *Record

+ func (r *Record) WithTTL(ttl uint32) *Record

+ func (r *Record) WithTimestamp(timestamp uint64) *Record

+ func (r *Record) WithTxID(txID uint64) *Record

+ func (r *Record) WithValueSize(valueSize uint32) *Record

type Tx

+ func (tx *Tx) DeleteBucketInIndex() error

+ func (tx *Tx) NewBucket(ds uint16, name string) (err error)

+ func (tx *Tx) NewKVBucket(name string) error

+ func (tx *Tx) NewListBucket(name string) error

+ func (tx *Tx) NewSetBucket(name string) error

+ func (tx *Tx) NewSortSetBucket(name string) error

+ func (tx *Tx) SubmitBucket() error

v0

v0.14.3

Nov 21, 2023

v0.14.2

Nov 7, 2023

Changes in this version

+ const DataBTreeBucketDeleteFlag

+ var ErrEmptyList = errors.New("the list is empty")

+ var ErrRecordIsNil = errors.New("the record is nil")

+ var ErrStartOrEnd = errors.New("start or end error")

+ func ConvertBigEndianBytesToUint64(data []byte) uint64

+ func ConvertUint64ToBigEndianBytes(value uint64) []byte

+ func GetDiskSizeFromSingleObject(obj interface{}) int64

type BTree

+ func (bt *BTree) AllItems() []*Item

+ func (bt *BTree) InsertRecord(key []byte, r *Record) bool

+ func (bt *BTree) Max() (*Item, bool)

+ func (bt *BTree) Min() (*Item, bool)

+ func (bt *BTree) PopMax() (*Item, bool)

+ func (bt *BTree) PopMin() (*Item, bool)

+ type HeadTailSeq struct

+ Head uint64

+ Tail uint64

type List

+ Seq map[string]*HeadTailSeq

type Tx

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

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

v0.14.1

Sep 15, 2023

Changes in this version

+ const DataStructureBTree

+ var ErrCount = errors.New("err count")

+ var ErrNotSupportMergeWhenUsingList = errors.New("not support merge when using list for now")

+ var ErrTxnExceedWriteLimit = errors.New("Txn is exceed max write record count")

type DB

+ RecordCount int64

+ type IdxType interface

type Option

+ func WithMaxWriteRecordCount(maxWriteRecordCount int64) Option

type Options

+ MaxWriteRecordCount int64

v0.14.0

Aug 31, 2023

Changes in this version

+ const SkipListMaxLevel

+ const SkipListP

+ var ErrSortedSetIsEmpty = errors.New("the sortedSet if empty")

+ var ErrSortedSetMemberNotExist = errors.New("the member of sortedSet does not exist")

+ var ErrSortedSetNotFound = errors.New("the sortedSet does not exist")

+ type EntryWhenRecovery struct

+ type ExpiredDeleteType uint8

+ const TimeHeap

+ const TimeWheel

+ type GetByScoreRangeOptions struct

+ ExcludeEnd bool

+ ExcludeStart bool

+ Limit int

type Options

+ ExpiredDeleteType ExpiredDeleteType

type Record

+ V []byte

+ func (r *Record) WithValue(v []byte) *Record

+ type SCORE float64

+ type SkipList struct

+ func (sl *SkipList) FindRank(hash uint32) int

+ func (sl *SkipList) FindRevRank(hash uint32) int

+ func (sl *SkipList) GetByRank(rank int, remove bool) *SkipListNode

+ func (sl *SkipList) GetByRankRange(start, end int, remove bool) []*SkipListNode

+ func (sl *SkipList) GetByScoreRange(start SCORE, end SCORE, options *GetByScoreRangeOptions) []*SkipListNode

+ func (sl *SkipList) GetByValue(value []byte) *SkipListNode

+ func (sl *SkipList) PeekMax() *SkipListNode

+ func (sl *SkipList) PeekMin() *SkipListNode

+ func (sl *SkipList) PopMax() *SkipListNode

+ func (sl *SkipList) PopMin() *SkipListNode

+ func (sl *SkipList) Put(score SCORE, value []byte, record *Record) error

+ func (sl *SkipList) Remove(hash uint32) *SkipListNode

+ func (sl *SkipList) Size() int

+ type SkipListLevel struct

+ type SkipListNode struct

+ func (sln *SkipListNode) Hash() uint32

+ func (sln *SkipListNode) Score() SCORE

+ type SortedSet struct

+ M map[string]*SkipList

+ func NewSortedSet(db *DB) *SortedSet

+ func (z *SortedSet) ZAdd(key string, score SCORE, value []byte, record *Record) error

+ func (z *SortedSet) ZCard(key string) (int, error)

+ func (z *SortedSet) ZCount(key string, start SCORE, end SCORE, opts *GetByScoreRangeOptions) (int, error)

+ func (z *SortedSet) ZExist(key string, value []byte) (bool, error)

+ func (z *SortedSet) ZMembers(key string) (map[*Record]SCORE, error)

+ func (z *SortedSet) ZPeekMax(key string) (*Record, SCORE, error)

+ func (z *SortedSet) ZPeekMin(key string) (*Record, SCORE, error)

+ func (z *SortedSet) ZPopMax(key string) (*Record, SCORE, error)

+ func (z *SortedSet) ZPopMin(key string) (*Record, SCORE, error)

+ func (z *SortedSet) ZRangeByRank(key string, start int, end int) ([]*Record, []float64, error)

+ func (z *SortedSet) ZRangeByScore(key string, start SCORE, end SCORE, opts *GetByScoreRangeOptions) ([]*Record, []float64, error)

+ func (z *SortedSet) ZRank(key string, value []byte) (int, error)

+ func (z *SortedSet) ZRem(key string, value []byte) (*Record, error)

+ func (z *SortedSet) ZRemRangeByRank(key string, start int, end int) error

+ func (z *SortedSet) ZRevRank(key string, value []byte) (int, error)

+ func (z *SortedSet) ZScore(key string, value []byte) (float64, error)

+ type SortedSetMember struct

+ Score float64

+ Value []byte

type Tx

+ func (tx *Tx) ZCheck(bucket string) error

v0.13.1

Aug 10, 2023

Changes in this version

+ const DataStructureTree

+ const DefaultThrottleSize

+ const KvWriteChCapacity

+ var ErrCommitAfterFinish = errors.New("Batch commit not permitted after finish")

+ var ErrEntryZero = errors.New("entry is zero ")

+ var ErrMemberEmpty = errors.New("item empty")

+ var ErrSetMemberNotExist = errors.New("set member not exist")

+ var ErrSetNotExist = errors.New("set not exist")

+ var ErrTxnTooBig = errors.New("Txn is too big to fit into one request")

+ type BTree struct

+ func NewBTree() *BTree

+ func (bt *BTree) All() []*Record

+ func (bt *BTree) Count() int

+ func (bt *BTree) Delete(key []byte) bool

+ func (bt *BTree) Find(key []byte) (*Record, bool)

+ func (bt *BTree) Insert(key []byte, e *Entry, h *Hint) bool

+ func (bt *BTree) PrefixScan(prefix []byte, offset, limitNum int) []*Record

+ func (bt *BTree) PrefixSearchScan(prefix []byte, reg string, offset, limitNum int) []*Record

+ func (bt *BTree) Range(start, end []byte) []*Record

+ type BTreeIdx map[string]*BTree

type DB

+ BTreeIdx BTreeIdx

+ func (db *DB) NewWriteBatch() (*WriteBatch, error)

+ type Item struct

type Iterator

+ func (it *Iterator) Key() []byte

+ func (it *Iterator) Next() bool

+ func (it *Iterator) Rewind() bool

+ func (it *Iterator) Valid() bool

+ func (it *Iterator) Value() ([]byte, error)

type Option

+ func WithMaxBatchCount(count int64) Option

+ func WithMaxBatchSize(size int64) Option

type Options

+ MaxBatchCount int64

+ MaxBatchSize int64

+ type Set struct

+ M map[string]map[uint32]*Record

+ func NewSet() *Set

+ func (s *Set) SAdd(key string, values [][]byte, records []*Record) error

+ func (s *Set) SAreMembers(key string, values ...[]byte) (bool, error)

+ func (s *Set) SCard(key string) int

+ func (s *Set) SDiff(key1, key2 string) ([]*Record, error)

+ func (s *Set) SHasKey(key string) bool

+ func (s *Set) SInter(key1, key2 string) ([]*Record, error)

+ func (s *Set) SIsMember(key string, value []byte) (bool, error)

+ func (s *Set) SMembers(key string) ([]*Record, error)

+ func (s *Set) SMove(key1, key2 string, value []byte) (bool, error)

+ func (s *Set) SPop(key string) *Record

+ func (s *Set) SRem(key string, values ...[]byte) error

+ func (s *Set) SUnion(key1, key2 string) ([]*Record, error)

+ type Throttle struct

+ func NewThrottle(max int) *Throttle

+ func (t *Throttle) Do() error

+ func (t *Throttle) Done(err error)

+ func (t *Throttle) Finish() error

type Tx

+ func (tx *Tx) CommitWith(cb func(error))

+ type WriteBatch struct

+ func (wb *WriteBatch) Cancel() error

+ func (wb *WriteBatch) Delete(bucket string, key []byte) error

+ func (wb *WriteBatch) Error() error

+ func (wb *WriteBatch) Flush() error

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

+ func (wb *WriteBatch) Reset() error

+ func (wb *WriteBatch) SetMaxPendingTxns(max int)

v0.13.0

Jul 31, 2023

Changes in this version

+ var ErrDataStructureNotSupported = errors.New("this data structure is not supported for now")

+ var ErrDontNeedMerge = errors.New("the number of files waiting to be merged is at least 2")

+ var ErrIndexOutOfRange = errors.New("index out of range")

+ var ErrIsMerging = errors.New("merge in progress")

+ var ErrListNotFound = errors.New("the list not found")

+ type CEntries struct

+ LessFunc func(l, r string) bool

+ func (c CEntries) Len() int

+ func (c CEntries) Less(i, j int) bool

+ func (c CEntries) Swap(i, j int)

type Entries

+ func (e Entries) Len() int

+ func (e Entries) Less(i, j int) bool

+ func (e Entries) Swap(i, j int)

+ func (e Entries) ToCEntries(lFunc func(l, r string) bool) CEntries

+ type ErrorHandler interface

+ HandleError func(err error)

+ type ErrorHandlerFunc func(err error)

+ func (fn ErrorHandlerFunc) HandleError(err error)

+ type LessFunc func(l, r string) bool

+ type List struct

+ Items map[string]*dll.List

+ TTL map[string]uint32

+ TimeStamp map[string]uint64

+ func NewList() *List

+ func (l *List) GetListTTL(key string) (uint32, error)

+ func (l *List) IsEmpty(key string) (bool, error)

+ func (l *List) IsExpire(key string) bool

+ func (l *List) LPeek(key string) (*Record, error)

+ func (l *List) LPop(key string) (*Record, error)

+ func (l *List) LPush(key string, r *Record) error

+ func (l *List) LRange(key string, start, end int) ([]*Record, error)

+ func (l *List) LRem(key string, count int, cmp func(r *Record) (bool, error)) error

+ func (l *List) LRemByIndex(key string, indexes []int) error

+ func (l *List) LSet(key string, index int, r *Record) error

+ func (l *List) LTrim(key string, start, end int) error

+ func (l *List) RPeek(key string) (*Record, error)

+ func (l *List) RPop(key string) (*Record, error)

+ func (l *List) RPush(key string, r *Record) error

+ func (l *List) Size(key string) (int, error)

type Option

+ func WithCommitBufferSize(commitBufferSize int64) Option

+ func WithErrorHandler(errorHandler ErrorHandler) Option

+ func WithLessFunc(lessFunc LessFunc) Option

type Options

+ CommitBufferSize int64

+ ErrorHandler ErrorHandler

+ LessFunc LessFunc

+ MergeInterval time.Duration

type Tx

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

v0.12.6

Jul 26, 2023

Changes in this version

type MetaData

+ func NewMetaData() *MetaData

+ func (meta *MetaData) WithBucketSize(bucketSize uint32) *MetaData

+ func (meta *MetaData) WithCrc(crc uint32) *MetaData

+ func (meta *MetaData) WithDs(ds uint16) *MetaData

+ func (meta *MetaData) WithFlag(flag uint16) *MetaData

+ func (meta *MetaData) WithKeySize(keySize uint32) *MetaData

+ func (meta *MetaData) WithStatus(status uint16) *MetaData

+ func (meta *MetaData) WithTTL(ttl uint32) *MetaData

+ func (meta *MetaData) WithTimeStamp(timestamp uint64) *MetaData

+ func (meta *MetaData) WithTxID(txID uint64) *MetaData

+ func (meta *MetaData) WithValueSize(valueSize uint32) *MetaData

v0.12.5

Jul 25, 2023

Changes in this version

+ func GetRandomBytes(length int) []byte

+ func GetTestBytes(i int) []byte

v0.12.4

Jul 25, 2023

Changes in this version

+ const FLockName

+ var ErrCannotRollbackAClosedTx = errors.New("can not rollback a closed tx")

+ var ErrDirLocked = errors.New("the dir of db is locked")

+ var ErrDirUnlocked = errors.New("the dir of db is unlocked")

+ func NewIndex() *index

+ func OneOfUint16Array(value uint16, array []uint16) bool

type DB

+ Index *index

type Entry

+ func NewEntry() *Entry

+ func (e *Entry) GetBucketString() string

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

+ func (e *Entry) WithBucket(bucket []byte) *Entry

+ func (e *Entry) WithKey(key []byte) *Entry

+ func (e *Entry) WithMeta(meta *MetaData) *Entry

+ func (e *Entry) WithValue(value []byte) *Entry

type Hint

+ func NewHint() *Hint

+ func (h *Hint) WithDataPos(pos uint64) *Hint

+ func (h *Hint) WithFileId(fid int64) *Hint

+ func (h *Hint) WithKey(key []byte) *Hint

+ func (h *Hint) WithMeta(meta *MetaData) *Hint

type Option

+ func WithGCWhenClose(enable bool) Option

type Options

+ GCWhenClose bool

type Record

+ func NewRecord() *Record

+ func (r *Record) WithBucket(bucket string) *Record

+ func (r *Record) WithEntry(e *Entry) *Record

+ func (r *Record) WithHint(hint *Hint) *Record

v0.12.3

Jun 16, 2023

Changes in this version

type Record

+ Bucket string

v0.12.2

May 21, 2023

v0.12.1

May 19, 2023

Changes in this version

+ const MAX_SIZE

+ var ErrCannotCommitAClosedTx = errors.New("can not commit a closed tx")

+ var ErrCannotRollbackACommittingTx = errors.New("can not rollback a committing tx")

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

type DB

+ func (db *DB) IsClose() bool

type Entry

+ Bucket []byte

type MetaData

+ Crc uint32

type Tx

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

v0.12.0

Feb 26, 2023

Changes in this version

+ const B

+ const BPTIndexSuffix

+ const BPTRootIndexSuffix

+ const BPTRootTxIDIndexSuffix

+ const BPTTxIDIndexSuffix

+ const BPTreeRootIdxHeaderSize

+ const BucketMetaHeaderSize

+ const BucketMetaSuffix

+ const Committed

+ const CountFlagDisabled

+ const CountFlagEnabled

+ const DataBPTreeBucketDeleteFlag

+ const DataDeleteFlag

+ const DataEntryHeaderSize

+ const DataExpireListFlag

+ const DataLPopFlag

+ const DataLPushFlag

+ const DataLRemByIndex

+ const DataLRemFlag

+ const DataLSetFlag

+ const DataLTrimFlag

+ const DataListBucketDeleteFlag

+ const DataRPopFlag

+ const DataRPushFlag

+ const DataSetBucketDeleteFlag

+ const DataSetFlag

+ const DataSortedSetBucketDeleteFlag

+ const DataStructureBPTree

+ const DataStructureList

+ const DataStructureNone

+ const DataStructureSet

+ const DataStructureSortedSet

+ const DataSuffix

+ const DataZAddFlag

+ const DataZPopMaxFlag

+ const DataZPopMinFlag

+ const DataZRemFlag

+ const DataZRemRangeByRankFlag

+ const DefaultInvalidAddress

+ const DefaultMaxFileNums

+ const GB

+ const KB

+ const MB

+ const Persistent

+ const PrefixScan

+ const PrefixSearchScan

+ const RangeScan

+ const ScanNoLimit

+ const SeparatorForListKey

+ const SeparatorForZSetKey

+ const TooManyFileOpenErrSuffix

+ const UnCommitted

+ var DefaultOptions = func() Options { ... }()

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

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

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

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

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

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

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

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

+ var ErrDataSizeExceed = errors.New("data size too big")

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

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

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

+ 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 ErrNotSupportHintBPTSparseIdxMode = errors.New("not support mode `HintBPTSparseIdxMode`")

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

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

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

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

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

+ var ErrSeparatorForListKey = errors.Errorf("contain separator (%s) for List key", SeparatorForListKey)

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

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

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

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

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

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

+ func ErrSeparatorForZSetKey() error

+ func ErrWhenBuildListIdx(err error) error

+ func IsBucketEmpty(err error) bool

+ func IsBucketNotFound(err error) bool

+ func IsDBClosed(err error) bool

+ func IsExpired(ttl uint32, timestamp uint64) bool

+ func IsKeyEmpty(err error) bool

+ func IsKeyNotFound(err error) bool

+ func IsPrefixScan(err error) bool

+ func IsPrefixSearchScan(err error) bool

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

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

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

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

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

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

+ type BPTree struct

+ Filepath string

+ FirstKey []byte

+ LastAddress int64

+ LastKey []byte

+ ValidKeyCount int

+ func NewTree() *BPTree

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

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

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

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

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

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

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

+ func (t *BPTree) Range(start, end []byte) (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 BPTreeIdx map[string]*BPTree

+ type BPTreeRootIdx struct

+ func ReadBPTreeRootIdxAt(fd *os.File, 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 + 1]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 struct

+ ActiveBPTreeIdx *BPTree

+ ActiveCommittedTxIdsIdx *BPTree

+ ActiveFile *DataFile

+ BPTreeIdx BPTreeIdx

+ BPTreeKeyEntryPosMap map[string]int64

+ BPTreeRootIdxes []*BPTreeRootIdx

+ KeyCount int

+ ListIdx ListIdx

+ MaxFileID int64

+ SetIdx SetIdx

+ SortedSetIdx SortedSetIdx

+ func Open(options Options, ops ...Option) (*DB, error)

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

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

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

+ func (db *DB) Close() 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, rwManager RWManager) *DataFile

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

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

+ func (df *DataFile) ReadRecord(off int, payloadSize int64) (e *Entry, err error)

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

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

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

+ type Entries []*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) ParseMeta(buf []byte) error

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

+ func (e *Entry) Size() int64

+ type EntryIdxMode int

+ const HintBPTSparseIdxMode

+ const HintKeyAndRAMIdxMode

+ const HintKeyValAndRAMIdxMode

+ type FdInfo struct

+ type FileIORWManager struct

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

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

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

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

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

+ type Hint struct

+ DataPos uint64

+ FileID int64

+ Key []byte

+ Meta *MetaData

+ type Iterator struct

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

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

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

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

+ type IteratorOptions struct

+ Reverse bool

+ type ListIdx map[string]*list.List

+ type MMapRWManager struct

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

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

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

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

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

+ type MetaData struct

+ Bucket []byte

+ BucketSize uint32

+ Ds uint16

+ Flag uint16

+ KeySize uint32

+ Status uint16

+ TTL uint32

+ Timestamp uint64

+ TxID uint64

+ ValueSize uint32

+ func (meta *MetaData) PayloadSize() int64

+ type Node struct

+ Address int64

+ Keys [][]byte

+ KeysNum int

+ Next *Node

+ type Option func(*Options)

+ func WithBufferSizeOfRecovery(size int) Option

+ 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 WithSyncEnable(enable bool) Option

+ type Options struct

+ BufferSizeOfRecovery int

+ CleanFdsCacheThreshold float64

+ Dir string

+ EntryIdxMode EntryIdxMode

+ MaxFdNumsInCache int

+ NodeNum int64

+ RWMode RWMode

+ SegmentSize int64

+ SyncEnable bool

+ type RWManager interface

+ Close func() (err error)

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

+ Release func() (err error)

+ Sync func() (err error)

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

+ type RWMode int

+ const FileIO

+ const MMap

+ type Record struct

+ E *Entry

+ H *Hint

+ func (r *Record) IsExpired() bool

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

+ type Records []*Record

+ type SetIdx map[string]*set.Set

+ type SortedSetIdx map[string]*zset.SortedSet

+ type Tx struct

+ ReservedStoreTxIDIdxes map[int64]*BPTree

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

+ func (tx *Tx) Commit() error

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

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

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

+ 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) Get(bucket string, key []byte) (e *Entry, err error)

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

+ func (tx *Tx) IterateBuckets(ds uint16, pattern string, f func(key string) bool) error

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

+ 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, value []byte) (removedNum int, err error)

+ func (tx *Tx) LRemByIndex(bucket string, key []byte, indexes ...int) (removedNum int, err 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) PrefixScan(bucket string, prefix []byte, offsetNum int, limitNum int) (es Entries, off int, err error)

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

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

+ func (tx *Tx) PutWithTimestamp(bucket string, key, value []byte, ttl uint32, timestamp uint64) 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) RangeScan(bucket string, start, end []byte) (es Entries, err error)

+ func (tx *Tx) Rollback() 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) SKeys(bucket, pattern string, f func(key string) 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) ZKeys(bucket, pattern string, f func(key string) bool) 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)

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