Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

moss

package module

Go to main page

Versions in this module

v0

v0.3.0

Dec 9, 2021

v0.2.0

Jul 27, 2021

v0.1.1

Nov 30, 2021

v0.1.0

Apr 16, 2020

Changes in this version

+ const OperationDel

+ const OperationMerge

+ const OperationSet

+ var AllocationGranularity = 65536 — windows/amd64

+ var AllocationGranularity = StorePageSize — darwin/amd64, js/wasm, linux/amd64

+ var CompactionAllow = CompactionConcern(1)

+ var CompactionDisable = CompactionConcern(0)

+ var CompactionForce = CompactionConcern(2)

+ var DefaultCollectionOptions = CollectionOptions

+ var DefaultNaiveSeekToMaxTries = 100

+ var DefaultPersistKind = SegmentKindBasic

+ var DefaultStoreOptions = StoreOptions

+ var ErrAborted = errors.New("operation-aborted")

+ var ErrAllocTooLarge = errors.New("alloc-too-large")

+ var ErrAlreadyInitialized = errors.New("already-initialized")

+ var ErrBadCollectionName = errors.New("bad-collection-name")

+ var ErrCanceled = errors.New("canceled")

+ var ErrClosed = errors.New("closed")

+ var ErrIteratorDone = errors.New("iterator-done")

+ var ErrKeyTooLarge = errors.New("key-too-large")

+ var ErrMaxTries = errors.New("max-tries")

+ var ErrMergeOperatorFullMergeFailed = errors.New("merge-operator-full-merge-failed")

+ var ErrMergeOperatorNil = errors.New("merge-operator-nil")

+ var ErrNoSuchCollection = errors.New("no-such-collection")

+ var ErrNoValidFooter = errors.New("no-valid-footer")

+ var ErrNothingToCompact = errors.New("nothing-to-compact")

+ var ErrSegmentCorrupted = errors.New("segment-corrupted")

+ var ErrUnexpected = errors.New("unexpected")

+ var ErrUnimplemented = errors.New("unimplemented")

+ var ErrValueTooLarge = errors.New("value-too-large")

+ var EventKindBatchExecute = EventKind(6)

+ var EventKindBatchExecuteStart = EventKind(5)

+ var EventKindClose = EventKind(2)

+ var EventKindCloseStart = EventKind(1)

+ var EventKindMergerProgress = EventKind(3)

+ var EventKindPersisterProgress = EventKind(4)

+ var IsTimingCoarse = false — darwin/amd64, js/wasm, linux/amd64

+ var IsTimingCoarse = true — windows/amd64

+ var SegmentKindBasic = "a"

+ var SegmentLoaders = map[string]SegmentLoaderFunc

+ var SegmentPersisters = map[string]SegmentPersisterFunc

+ var SkipStats bool

+ var StoreEndian = binary.LittleEndian

+ var StoreMagicBeg = []byte("0m1o2s")

+ var StoreMagicEnd = []byte("3s4p5s")

+ var StorePageSize = 4096

+ var StorePrefix = "data-"

+ var StoreSuffix = ".moss"

+ var StoreVersion = uint32(4)

+ func ByteSliceToUint64Slice(in []byte) ([]uint64, error)

+ func FormatFName(seq int64) string

+ func HeaderLength() uint64

+ func OpenStoreCollection(dir string, options StoreOptions, persistOptions StorePersistOptions) (*Store, Collection, error)

+ func ParseFNameSeq(fname string) (int64, error)

+ func ToOsFile(f File) *os.File

+ func Uint64SliceToByteSlice(in []uint64) ([]byte, error)

+ type Batch interface

+ Alloc func(numBytes int) ([]byte, error)

+ AllocDel func(keyFromAlloc []byte) error

+ AllocMerge func(keyFromAlloc, valFromAlloc []byte) error

+ AllocSet func(keyFromAlloc, valFromAlloc []byte) error

+ Close func() error

+ Del func(key []byte) error

+ DelChildCollection func(collectionName string) error

+ Merge func(key, val []byte) error

+ NewChildCollectionBatch func(collectionName string, options BatchOptions) (Batch, error)

+ Set func(key, val []byte) error

+ type BatchOptions struct

+ TotalKeyValBytes int

+ TotalOps int

+ type Collection interface

+ Close func() error

+ ExecuteBatch func(b Batch, writeOptions WriteOptions) error

+ Get func(key []byte, readOptions ReadOptions) ([]byte, error)

+ Histograms func() ghistogram.Histograms

+ NewBatch func(totalOps, totalKeyValBytes int) (Batch, error)

+ Options func() CollectionOptions

+ Snapshot func() (Snapshot, error)

+ Start func() error

+ Stats func() (*CollectionStats, error)

+ func NewCollection(options CollectionOptions) (Collection, error)

+ type CollectionOptions struct

+ CachePersisted bool

+ Debug int

+ DeferredSort bool

+ Log func(format string, a ...interface{})

+ LowerLevelInit Snapshot

+ LowerLevelUpdate LowerLevelUpdate

+ MaxDirtyKeyValBytes uint64

+ MaxDirtyOps uint64

+ MaxPreMergerBatches int

+ MergeOperator MergeOperator

+ MergerCancelCheckEvery int

+ MergerIdleRunTimeoutMS int64

+ MinMergePercentage float64

+ OnError func(error)

+ OnEvent func(event Event)

+ ReadOnly bool

+ type CollectionStats struct

+ CurCleanBytes uint64

+ CurCleanOps uint64

+ CurCleanSegments uint64

+ CurDirtyBaseBytes uint64

+ CurDirtyBaseOps uint64

+ CurDirtyBaseSegments uint64

+ CurDirtyBytes uint64

+ CurDirtyMidBytes uint64

+ CurDirtyMidOps uint64

+ CurDirtyMidSegments uint64

+ CurDirtyOps uint64

+ CurDirtySegments uint64

+ CurDirtyTopBytes uint64

+ CurDirtyTopOps uint64

+ CurDirtyTopSegments uint64

+ TotCloseBeg uint64

+ TotCloseEnd uint64

+ TotCloseLowerLevelBeg uint64

+ TotCloseLowerLevelEnd uint64

+ TotCloseMergerDone uint64

+ TotClosePersisterDone uint64

+ TotExecuteBatchAwakeMergerBeg uint64

+ TotExecuteBatchAwakeMergerEnd uint64

+ TotExecuteBatchBeg uint64

+ TotExecuteBatchEmpty uint64

+ TotExecuteBatchEnd uint64

+ TotExecuteBatchErr uint64

+ TotExecuteBatchWaitBeg uint64

+ TotExecuteBatchWaitEnd uint64

+ TotGet uint64

+ TotGetErr uint64

+ TotMergerAll uint64

+ TotMergerEmptyDirtyMid uint64

+ TotMergerEnd uint64

+ TotMergerIdleRuns uint64

+ TotMergerIdleSleeps uint64

+ TotMergerInternalBeg uint64

+ TotMergerInternalEnd uint64

+ TotMergerInternalErr uint64

+ TotMergerInternalSkip uint64

+ TotMergerLoop uint64

+ TotMergerLoopRepeat uint64

+ TotMergerLowerLevelNotify uint64

+ TotMergerLowerLevelNotifySkip uint64

+ TotMergerWaitIncomingBeg uint64

+ TotMergerWaitIncomingEnd uint64

+ TotMergerWaitIncomingSkip uint64

+ TotMergerWaitIncomingStop uint64

+ TotMergerWaitOutgoingBeg uint64

+ TotMergerWaitOutgoingEnd uint64

+ TotMergerWaitOutgoingSkip uint64

+ TotMergerWaitOutgoingStop uint64

+ TotNewBatch uint64

+ TotNewBatchTotalKeyValBytes uint64

+ TotNewBatchTotalOps uint64

+ TotNotifyMergerBeg uint64

+ TotNotifyMergerEnd uint64

+ TotOnError uint64

+ TotPersisterEnd uint64

+ TotPersisterLoop uint64

+ TotPersisterLoopRepeat uint64

+ TotPersisterLowerLevelUpdateBeg uint64

+ TotPersisterLowerLevelUpdateEnd uint64

+ TotPersisterLowerLevelUpdateErr uint64

+ TotPersisterWaitBeg uint64

+ TotPersisterWaitEnd uint64

+ TotSnapshotBeg uint64

+ TotSnapshotEnd uint64

+ TotSnapshotInternalBeg uint64

+ TotSnapshotInternalClose uint64

+ TotSnapshotInternalEnd uint64

+ func (s *CollectionStats) AtomicCopyTo(r *CollectionStats)

+ type CompactionConcern int

+ type EntryEx struct

+ Operation uint64

+ type Event struct

+ Collection Collection

+ Duration time.Duration

+ Kind EventKind

+ type EventKind int

+ type File interface

+ Stat func() (os.FileInfo, error)

+ Sync func() error

+ Truncate func(size int64) error

+ type FileRef struct

+ func (r *FileRef) AddRef() File

+ func (r *FileRef) Close() error

+ func (r *FileRef) DecRef() (err error)

+ func (r *FileRef) FetchRefCount() int

+ func (r *FileRef) OnAfterClose(cb func())

+ func (r *FileRef) OnBeforeClose(cb func())

+ type Footer struct

+ ChildFooters map[string]*Footer

+ PrevFooterOffset int64

+ SegmentLocs SegmentLocs

+ func ReadFooter(options *StoreOptions, file File) (*Footer, error)

+ func ScanFooter(options *StoreOptions, fref *FileRef, fileName string, pos int64) (*Footer, error)

+ func (f *Footer) AddRef()

+ func (f *Footer) ChildCollectionNames() ([]string, error)

+ func (f *Footer) ChildCollectionSnapshot(childCollectionName string) (Snapshot, error)

+ func (f *Footer) Close() error

+ func (f *Footer) DecRef()

+ func (f *Footer) Get(key []byte, readOptions ReadOptions) ([]byte, error)

+ func (f *Footer) Length() uint64

+ func (f *Footer) StartIterator(startKeyIncl, endKeyExcl []byte, iteratorOptions IteratorOptions) (Iterator, error)

+ type Header struct

+ CreatedAt string

+ CreatedEndian string

+ Version uint32

+ type InitCloser interface

+ InitCloser func(io.Closer) error

+ type Iterator interface

+ Close func() error

+ Current func() (key, val []byte, err error)

+ CurrentEx func() (entryEx EntryEx, key, val []byte, err error)

+ Next func() error

+ SeekTo func(seekToKey []byte) error

+ type IteratorOptions struct

+ IncludeDeletions bool

+ MaxSegmentHeight int

+ MinSegmentLevel int

+ SkipLowerLevel bool

+ type LowerLevelUpdate func(higher Snapshot) (lower Snapshot, err error)

+ type MergeOperator interface

+ FullMerge func(key, existingValue []byte, operands [][]byte) ([]byte, bool)

+ Name func() string

+ PartialMerge func(key, leftOperand, rightOperand []byte) ([]byte, bool)

+ type MergeOperatorStringAppend struct

+ Sep string

+ func (mo *MergeOperatorStringAppend) FullMerge(key, existingValue []byte, operands [][]byte) ([]byte, bool)

+ func (mo *MergeOperatorStringAppend) Name() string

+ func (mo *MergeOperatorStringAppend) PartialMerge(key, leftOperand, rightOperand []byte) ([]byte, bool)

+ type OpenFile func(name string, flag int, perm os.FileMode) (File, error)

+ type OsFile interface

+ OsFile func() *os.File

+ type ReadOptions struct

+ NoCopyValue bool

+ SkipLowerLevel bool

+ type Segment interface

+ Cursor func(startKeyInclusive []byte, endKeyExclusive []byte) (SegmentCursor, error)

+ Get func(key []byte) (operation uint64, val []byte, err error)

+ Kind func() string

+ Len func() int

+ NumKeyValBytes func() (uint64, uint64)

+ RequestSort func(synchronous bool) bool

+ type SegmentCursor interface

+ Current func() (operation uint64, key []byte, val []byte)

+ Next func() error

+ Seek func(startKeyInclusive []byte) error

+ type SegmentLoaderFunc func(sloc *SegmentLoc) (Segment, error)

+ type SegmentLoc struct

+ BufBytes uint64

+ BufOffset uint64

+ Kind string

+ KvsBytes uint64

+ KvsOffset uint64

+ TotKeyByte uint64

+ TotOpsDel uint64

+ TotOpsSet uint64

+ TotValByte uint64

+ func (sloc *SegmentLoc) TotOps() int

+ type SegmentLocs []SegmentLoc

+ func (slocs SegmentLocs) AddRef()

+ func (slocs SegmentLocs) Close() error

+ func (slocs SegmentLocs) DecRef()

+ type SegmentMutator interface

+ Mutate func(operation uint64, key, val []byte) error

+ type SegmentPersister interface

+ Persist func(file File, options *StoreOptions) (SegmentLoc, error)

+ type SegmentPersisterFunc func(s Segment, f File, pos int64, options *StoreOptions) (SegmentLoc, error)

+ type SegmentStackStats struct

+ CurBytes uint64

+ CurOps uint64

+ CurSegments uint64

+ func (sss *SegmentStackStats) AddTo(dest *SegmentStackStats)

+ type SegmentValidater interface

+ Valid func() error

+ type Snapshot interface

+ ChildCollectionNames func() ([]string, error)

+ ChildCollectionSnapshot func(childCollectionName string) (Snapshot, error)

+ Close func() error

+ Get func(key []byte, readOptions ReadOptions) ([]byte, error)

+ StartIterator func(startKeyInclusive, endKeyExclusive []byte, iteratorOptions IteratorOptions) (Iterator, error)

+ type SnapshotWrapper struct

+ func NewSnapshotWrapper(ss Snapshot, closer io.Closer) *SnapshotWrapper

+ func (w *SnapshotWrapper) ChildCollectionNames() ([]string, error)

+ func (w *SnapshotWrapper) ChildCollectionSnapshot(childCollectionName string) (Snapshot, error)

+ func (w *SnapshotWrapper) Close() (err error)

+ func (w *SnapshotWrapper) Get(key []byte, readOptions ReadOptions) ([]byte, error)

+ func (w *SnapshotWrapper) StartIterator(startKeyInclusive, endKeyExclusive []byte, iteratorOptions IteratorOptions) (Iterator, error)

+ type Store struct

+ func OpenStore(dir string, options StoreOptions) (*Store, error)

+ func (s *Store) AddRef()

+ func (s *Store) Close() error

+ func (s *Store) CloseEx(options StoreCloseExOptions) error

+ func (s *Store) Dir() string

+ func (s *Store) Histograms() ghistogram.Histograms

+ func (s *Store) IsAborted() bool

+ func (s *Store) OpenCollection(options StoreOptions, persistOptions StorePersistOptions) (Collection, error)

+ func (s *Store) Options() StoreOptions

+ func (s *Store) Persist(higher Snapshot, persistOptions StorePersistOptions) (Snapshot, error)

+ func (s *Store) Snapshot() (Snapshot, error)

+ func (s *Store) SnapshotPrevious(ss Snapshot) (Snapshot, error)

+ func (s *Store) SnapshotRevert(revertTo Snapshot) error

+ func (s *Store) Stats() (map[string]interface{}, error)

+ type StoreCloseExOptions struct

+ Abort bool

+ type StoreOptions struct

+ CollectionOptions CollectionOptions

+ CompactionBufferPages int

+ CompactionLevelMaxSegments int

+ CompactionLevelMultiplier int

+ CompactionPercentage float64

+ CompactionSync bool

+ CompactionSyncAfterBytes int

+ KeepFiles bool

+ Log func(format string, a ...interface{})

+ OpenFile OpenFile

+ PersistKind string

+ SegmentKeysIndexMaxBytes int

+ SegmentKeysIndexMinKeyBytes int

+ type StorePersistOptions struct

+ CompactionConcern CompactionConcern

+ NoSync bool

+ type WriteOptions struct