tbtree

Documentation

Overview

Copyright 2021 CodeNotary, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 CodeNotary, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 CodeNotary, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 CodeNotary, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 CodeNotary, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• type AppFactoryFunc
• type HistoryReader
  • func (r *HistoryReader) Close() error
  • func (r *HistoryReader) Read() (tss []uint64, err error)
• type HistoryReaderSpec
• type KV
• type Options
  • func DefaultOptions() *Options
  • func (opts *Options) WithAppFactory(appFactory AppFactoryFunc) *Options
  • func (opts *Options) WithCacheSize(cacheSize int) *Options
  • func (opts *Options) WithCompactionThld(compactionThld int) *Options
  • func (opts *Options) WithDelayDuringCompaction(delay time.Duration) *Options
  • func (opts *Options) WithFileMode(fileMode os.FileMode) *Options
  • func (opts *Options) WithFileSize(fileSize int) *Options
  • func (opts *Options) WithFlushThld(flushThld int) *Options
  • func (opts *Options) WithLog(log logger.Logger) *Options
  • func (opts *Options) WithMaxActiveSnapshots(maxActiveSnapshots int) *Options
  • func (opts *Options) WithMaxKeyLen(maxKeyLen int) *Options
  • func (opts *Options) WithMaxNodeSize(maxNodeSize int) *Options
  • func (opts *Options) WithReadOnly(readOnly bool) *Options
  • func (opts *Options) WithRenewSnapRootAfter(renewSnapRootAfter time.Duration) *Options
  • func (opts *Options) WithSynced(synced bool) *Options
• type Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Read() (key []byte, value []byte, ts uint64, hc uint64, err error)
  • func (r *Reader) ReadAsBefore(beforeTs uint64) (key []byte, ts uint64, err error)
  • func (r *Reader) Reset() error
• type ReaderSpec
• type Snapshot
  • func (s *Snapshot) Close() error
  • func (s *Snapshot) Get(key []byte) (value []byte, ts uint64, hc uint64, err error)
  • func (s *Snapshot) History(key []byte, offset uint64, descOrder bool, limit int) (tss []uint64, err error)
  • func (s *Snapshot) NewHistoryReader(spec *HistoryReaderSpec) (*HistoryReader, error)
  • func (s *Snapshot) NewReader(spec *ReaderSpec) (r *Reader, err error)
  • func (s *Snapshot) Ts() uint64
  • func (s *Snapshot) WriteTo(nw, hw io.Writer, writeOpts *WriteOpts) (nOff int64, wN, wH int64, err error)
• type TBtree
  • func Open(path string, opts *Options) (*TBtree, error)
  • func OpenWith(path string, nLog, hLog, cLog appendable.Appendable, opts *Options) (*TBtree, error)
  • func (t *TBtree) BulkInsert(kvs []*KV) error
  • func (t *TBtree) Close() error
  • func (t *TBtree) Compact() (uint64, error)
  • func (t *TBtree) ExistKeyWith(prefix []byte, neq []byte, smaller bool) (bool, error)
  • func (t *TBtree) Flush() (wN, wH int64, err error)
  • func (t *TBtree) Get(key []byte) (value []byte, ts uint64, hc uint64, err error)
  • func (t *TBtree) GetOptions() *Options
  • func (t *TBtree) History(key []byte, offset uint64, descOrder bool, limit int) (tss []uint64, err error)
  • func (t *TBtree) Insert(key []byte, value []byte) error
  • func (t *TBtree) Snapshot() (*Snapshot, error)
  • func (t *TBtree) SnapshotCount() (uint64, error)
  • func (t *TBtree) SnapshotSince(ts uint64) (*Snapshot, error)
  • func (t *TBtree) Sync() error
  • func (t *TBtree) Ts() uint64
• type WriteOpts

Constants

const (
	InnerNodeType = iota
	LeafNodeType
)

const (
	MetaVersion     = "VERSION"
	MetaMaxNodeSize = "MAX_NODE_SIZE"
)

const DefaultCacheSize = 100_000

const DefaultCompactionThld = 2

const DefaultFileMode = os.FileMode(0755)

const DefaultFileSize = 1 << 26 // 64Mb

const DefaultFlushThld = 100_000

const DefaultMaxActiveSnapshots = 100

const DefaultMaxKeyLen = 1024

const DefaultMaxNodeSize = 4096

const DefaultRenewSnapRootAfter = time.Duration(1000) * time.Millisecond

const MinCacheSize = 1

const MinNodeSize = 128

const Version = 1

Variables

var ErrAlreadyClosed = errors.New("index already closed")

var ErrCompactAlreadyInProgress = errors.New("compact already in progress")

var ErrCompactionThresholdNotReached = errors.New("compaction threshold not yet reached")

var ErrCorruptedCLog = errors.New("commit log is corrupted")

var ErrCorruptedFile = errors.New("file is corrupted")

var ErrIllegalArguments = errors.New("illegal arguments")

var ErrIllegalState = errors.New("illegal state")

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

var ErrNoMoreEntries = errors.New("no more entries")

var ErrOffsetOutOfRange = errors.New("offset out of range")

var ErrReadersNotClosed = errors.New("readers not closed")

var ErrReadingFileContent = errors.New("error reading required file content")

var ErrSnapshotsNotClosed = errors.New("snapshots not closed")

var ErrorMaxKVLenExceeded = errors.New("max kv length exceeded")

var ErrorPathIsNotADirectory = errors.New("path is not a directory")

var ErrorToManyActiveSnapshots = errors.New("max active snapshots limit reached")

Types

type AppFactoryFunc

type AppFactoryFunc func(
	rootPath string,
	subPath string,
	opts *multiapp.Options,
) (appendable.Appendable, error)

type HistoryReader

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

func (*HistoryReader) Close

func (r *HistoryReader) Close() error

func (*HistoryReader) Read

func (r *HistoryReader) Read() (tss []uint64, err error)

type HistoryReaderSpec

type HistoryReaderSpec struct {
	Key       []byte
	Offset    uint64
	DescOrder bool
	ReadLimit int
}

type KV

type KV struct {
	K []byte
	V []byte
}

type Options

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

func DefaultOptions

func DefaultOptions() *Options

func (*Options) WithAppFactory

func (opts *Options) WithAppFactory(appFactory AppFactoryFunc) *Options

func (*Options) WithCacheSize

func (opts *Options) WithCacheSize(cacheSize int) *Options

func (*Options) WithCompactionThld

func (opts *Options) WithCompactionThld(compactionThld int) *Options

func (*Options) WithDelayDuringCompaction

func (opts *Options) WithDelayDuringCompaction(delay time.Duration) *Options

func (*Options) WithFileMode

func (opts *Options) WithFileMode(fileMode os.FileMode) *Options

func (*Options) WithFileSize

func (opts *Options) WithFileSize(fileSize int) *Options

func (*Options) WithFlushThld

func (opts *Options) WithFlushThld(flushThld int) *Options

func (*Options) WithLog

func (opts *Options) WithLog(log logger.Logger) *Options

func (*Options) WithMaxActiveSnapshots

func (opts *Options) WithMaxActiveSnapshots(maxActiveSnapshots int) *Options

func (*Options) WithMaxKeyLen

func (opts *Options) WithMaxKeyLen(maxKeyLen int) *Options

func (*Options) WithMaxNodeSize

func (opts *Options) WithMaxNodeSize(maxNodeSize int) *Options

func (*Options) WithReadOnly

func (opts *Options) WithReadOnly(readOnly bool) *Options

func (*Options) WithRenewSnapRootAfter

func (opts *Options) WithRenewSnapRootAfter(renewSnapRootAfter time.Duration) *Options

func (*Options) WithSynced

func (opts *Options) WithSynced(synced bool) *Options

type Reader

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

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) Read

func (r *Reader) Read() (key []byte, value []byte, ts uint64, hc uint64, err error)

func (*Reader) ReadAsBefore

func (r *Reader) ReadAsBefore(beforeTs uint64) (key []byte, ts uint64, err error)

func (*Reader) Reset

func (r *Reader) Reset() error

type ReaderSpec

type ReaderSpec struct {
	SeekKey       []byte
	Prefix        []byte
	InclusiveSeek bool
	DescOrder     bool
}

type Snapshot

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

func (*Snapshot) Close

func (s *Snapshot) Close() error

func (*Snapshot) Get

func (s *Snapshot) Get(key []byte) (value []byte, ts uint64, hc uint64, err error)

func (*Snapshot) History

func (s *Snapshot) History(key []byte, offset uint64, descOrder bool, limit int) (tss []uint64, err error)

func (*Snapshot) NewHistoryReader

func (s *Snapshot) NewHistoryReader(spec *HistoryReaderSpec) (*HistoryReader, error)

func (*Snapshot) NewReader

func (s *Snapshot) NewReader(spec *ReaderSpec) (r *Reader, err error)

func (*Snapshot) Ts

func (s *Snapshot) Ts() uint64

func (*Snapshot) WriteTo

func (s *Snapshot) WriteTo(nw, hw io.Writer, writeOpts *WriteOpts) (nOff int64, wN, wH int64, err error)

type TBtree

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

TBTree implements a timed-btree

func Open

func Open(path string, opts *Options) (*TBtree, error)

func OpenWith

func OpenWith(path string, nLog, hLog, cLog appendable.Appendable, opts *Options) (*TBtree, error)

func (*TBtree) BulkInsert

func (t *TBtree) BulkInsert(kvs []*KV) error

func (*TBtree) Close

func (t *TBtree) Close() error

func (*TBtree) Compact

func (t *TBtree) Compact() (uint64, error)

func (*TBtree) ExistKeyWith

func (t *TBtree) ExistKeyWith(prefix []byte, neq []byte, smaller bool) (bool, error)

func (*TBtree) Flush

func (t *TBtree) Flush() (wN, wH int64, err error)

func (*TBtree) Get

func (t *TBtree) Get(key []byte) (value []byte, ts uint64, hc uint64, err error)

func (*TBtree) GetOptions

func (t *TBtree) GetOptions() *Options

func (*TBtree) History

func (t *TBtree) History(key []byte, offset uint64, descOrder bool, limit int) (tss []uint64, err error)

func (*TBtree) Insert

func (t *TBtree) Insert(key []byte, value []byte) error

func (*TBtree) Snapshot

func (t *TBtree) Snapshot() (*Snapshot, error)

func (*TBtree) SnapshotCount

func (t *TBtree) SnapshotCount() (uint64, error)

SnapshotCount returns the number of stored snapshots Note: snapshotCount(compact(t)) = 1

func (*TBtree) SnapshotSince

func (t *TBtree) SnapshotSince(ts uint64) (*Snapshot, error)

func (*TBtree) Sync

func (t *TBtree) Sync() error

func (*TBtree) Ts

func (t *TBtree) Ts() uint64

type WriteOpts

type WriteOpts struct {
	OnlyMutated    bool
	BaseNLogOffset int64
	BaseHLogOffset int64
	// contains filtered or unexported fields
}