package
0.0.0-20181015185059-61d62eb9aa4d
Repository: https://github.com/m3db/m3ninx.git
Documentation: pkg.go.dev
# README
FS Segment
┌───────────────────────────────┐ ┌───────────────────────────────┐
│ FST Fields File │ │ FST Terms File │
│-------------------------------│ │-------------------------------│
│- Vellum V1 FST │ │`n` records, each: │
│- []byte -> FST Terms Offset │─────┐ │ - payload (`size` bytes) │
└───────────────────────────────┘ │ │ - size (int64) │
└────▶│ - magic number (int64) │
│ │
│Payload: │
│- Vellum V1 FST │
│- []byte -> Postings Offset │
└───────────────────────────────┘
┌───────────────────────────────┐ │
│ Postings Data File │ │
│-------------------------------│ │
│`n` records, each: │ │
│ - payload (`size` bytes) │ │
│ - size (int64) │ │
│ - magic number (int64) │◀──────────────────┘
│ │
│Payload: │
│- Pilosa Bitset │
│- List of doc.ID │
└──────────┬────────────────────┘
│
│
│
│ ┌──────────────────────────┐ ┌───────────────────────────┐
│ │ Documents Index File │ │ Documents Data File │
│ │--------------------------│ │------------------------- │
│ │- Base Doc.ID `b` (uint64)│ │'n' records, each: │
│ │- Doc `b` offset (uint64) │ ┌─────▶│ - ID (bytes) │
│ │- Doc `b+1` offset │ │ │ - Fields (bytes) │
└──────▶│... ├────┘ └───────────────────────────┘
│- Doc `b+n-1` offset │
└──────────────────────────┘
# Packages
No description provided by the author
# Functions
NewMockSegment creates a new mock instance.
NewMockWriter creates a new mock instance.
NewSegment returns a new Segment backed by the provided options.
NewWriter returns a new writer.
# Constants
MajorVersion is the currently supported MajorVersion.
MinorVersion is the current MinorVersion.
# Structs
MockSegment is a mock of Segment interface.
MockSegmentMockRecorder is the mock recorder for MockSegment.
MockWriter is a mock of Writer interface.
MockWriterMockRecorder is the mock recorder for MockWriter.
NewSegmentOpts represent the collection of knobs used by the Segment.
SegmentData represent the collection of required parameters to construct a Segment.