Documentation ¶
Overview ¶
Package tsi1 provides a memory-mapped index implementation that supports high cardinality series.
Overview ¶
The top-level object in tsi1 is the Index. It is the primary access point from the rest of the system. The Index is composed of LogFile and IndexFile objects.
Log files are small write-ahead log files that record new series immediately in the order that they are received. The data within the file is indexed in-memory so it can be quickly accessed. When the system is restarted, this log file is replayed and the in-memory representation is rebuilt.
Index files also contain series information, however, they are highly indexed so that reads can be performed quickly. Index files are built through a process called compaction where a log file or multiple index files are merged together.
Operations ¶
The index can perform many tasks related to series, measurement, & tag data. All data is inserted by adding a series to the index. When adding a series, the measurement, tag keys, and tag values are all extracted and indexed separately.
Once a series has been added, it can be removed in several ways. First, the individual series can be removed. Second, it can be removed as part of a bulk operation by deleting the entire measurement.
The query engine needs to be able to look up series in a variety of ways such as by measurement name, by tag value, or by using regular expressions. The index provides an API to iterate over subsets of series and perform set operations such as unions and intersections.
Log File Layout ¶
The write-ahead file that series initially are inserted into simply appends all new operations sequentially. It is simply composed of a series of log entries. An entry contains a flag to specify the operation type, the measurement name, the tag set, and a checksum.
┏━━━━━━━━━LogEntry━━━━━━━━━┓ ┃ ┌──────────────────────┐ ┃ ┃ │ Flag │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Measurement │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Key/Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Key/Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Key/Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Checksum │ ┃ ┃ └──────────────────────┘ ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━┛
When the log file is replayed, if the checksum is incorrect or the entry is incomplete (because of a partially failed write) then the log is truncated.
Index File Layout ¶
The index file is composed of 3 main block types: one series block, one or more tag blocks, and one measurement block. At the end of the index file is a trailer that records metadata such as the offsets to these blocks.
Series Block Layout ¶
The series block stores raw series keys in sorted order. It also provides hash indexes so that series can be looked up quickly. Hash indexes are inserted periodically so that memory size is limited at write time. Once all the series and hash indexes have been written then a list of index entries are written so that hash indexes can be looked up via binary search.
The end of the block contains two HyperLogLog++ sketches which track the estimated number of created series and deleted series. After the sketches is a trailer which contains metadata about the block.
┏━━━━━━━SeriesBlock━━━━━━━━┓ ┃ ┌──────────────────────┐ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Series Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Index Entries │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ HLL Sketches │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Trailer │ ┃ ┃ └──────────────────────┘ ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Tag Block Layout ¶
After the series block is one or more tag blocks. One of these blocks exists for every measurement in the index file. The block is structured as a sorted list of values for each key and then a sorted list of keys. Each of these lists has their own hash index for fast direct lookups.
┏━━━━━━━━Tag Block━━━━━━━━━┓ ┃ ┌──────────────────────┐ ┃ ┃ │ Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ └──────────────────────┘ ┃ ┃ ┌──────────────────────┐ ┃ ┃ │ Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Value │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ └──────────────────────┘ ┃ ┃ ┌──────────────────────┐ ┃ ┃ │ Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Key │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ └──────────────────────┘ ┃ ┃ ┌──────────────────────┐ ┃ ┃ │ Trailer │ ┃ ┃ └──────────────────────┘ ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Each entry for values contains a sorted list of offsets for series keys that use that value. Series iterators can be built around a single tag key value or multiple iterators can be merged with set operators such as union or intersection.
Measurement block ¶
The measurement block stores a sorted list of measurements, their associated series offsets, and the offset to their tag block. This allows all series for a measurement to be traversed quickly and it allows fast direct lookups of measurements and their tags.
This block also contains HyperLogLog++ sketches for new and deleted measurements.
┏━━━━Measurement Block━━━━━┓ ┃ ┌──────────────────────┐ ┃ ┃ │ Measurement │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Measurement │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Measurement │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ │ ┃ ┃ │ Hash Index │ ┃ ┃ │ │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ HLL Sketches │ ┃ ┃ ├──────────────────────┤ ┃ ┃ │ Trailer │ ┃ ┃ └──────────────────────┘ ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Manifest file ¶
The index is simply an ordered set of log and index files. These files can be merged together or rewritten but their order must always be the same. This is because series, measurements, & tags can be marked as deleted (aka tombstoned) and this action needs to be tracked in time order.
Whenever the set of active files is changed, a manifest file is written to track the set. The manifest specifies the ordering of files and, on startup, all files not in the manifest are removed from the index directory.
Compacting index files ¶
Compaction is the process of taking files and merging them together into a single file. There are two stages of compaction within TSI.
First, once log files exceed a size threshold then they are compacted into an index file. This threshold is relatively small because log files must maintain their index in the heap which TSI tries to avoid. Small log files are also very quick to convert into an index file so this is done aggressively.
Second, once a contiguous set of index files exceed a factor (e.g. 10x) then they are all merged together into a single index file and the old files are discarded. Because all blocks are written in sorted order, the new index file can be streamed and minimize memory use.
Concurrency ¶
Index files are immutable so they do not require fine grained locks, however, compactions require that we track which files are in use so they are not discarded too soon. This is done by using reference counting with file sets.
A file set is simply an ordered list of index files. When the current file set is obtained from the index, a counter is incremented to track its usage. Once the user is done with the file set, it is released and the counter is decremented. A file cannot be removed from the file system until this counter returns to zero.
Besides the reference counting, there are no other locking mechanisms when reading or writing index files. Log files, however, do require a lock whenever they are accessed. This is another reason to minimize log file size.
Index ¶
- Constants
- Variables
- func FormatIndexFileName(id, level int) string
- func FormatLogFileName(id int) string
- func IsIndexDir(path string) (bool, error)
- func IsPartitionDir(path string) (bool, error)
- func NewTSDBMeasurementIteratorAdapter(itr MeasurementIterator) tsdb.MeasurementIterator
- func NewTSDBTagKeyIteratorAdapter(itr TagKeyIterator) tsdb.TagKeyIterator
- func NewTSDBTagValueIteratorAdapter(itr TagValueIterator) tsdb.TagValueIterator
- func ParseFilename(name string) (level, id int)
- type CompactionLevel
- type File
- type FileSet
- func (fs FileSet) Close() error
- func (fs *FileSet) Files() []File
- func (fs *FileSet) HasTagKey(name, key []byte) bool
- func (fs *FileSet) HasTagValue(name, key, value []byte) bool
- func (fs *FileSet) LastContiguousIndexFilesByLevel(level int) []*IndexFile
- func (fs *FileSet) MaxID() int
- func (fs *FileSet) Measurement(name []byte) MeasurementElem
- func (fs *FileSet) MeasurementIterator() MeasurementIterator
- func (fs *FileSet) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
- func (fs *FileSet) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
- func (fs *FileSet) MeasurementsSketches() (estimator.Sketch, estimator.Sketch, error)
- func (fs *FileSet) MustReplace(oldFiles []File, newFile File) *FileSet
- func (fs *FileSet) PrependLogFile(f *LogFile) *FileSet
- func (fs *FileSet) Release()
- func (fs *FileSet) Retain()
- func (fs *FileSet) SeriesSketches() (estimator.Sketch, estimator.Sketch, error)
- func (fs *FileSet) Size() int64
- func (fs *FileSet) TagKeyIterator(name []byte) TagKeyIterator
- func (fs *FileSet) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
- func (fs *FileSet) TagValueIterator(name, key []byte) TagValueIterator
- func (fs *FileSet) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
- type Files
- type Index
- func (i *Index) Bytes() int
- func (i *Index) Close() error
- func (i *Index) Compact()
- func (i *Index) CreateSeriesIfNotExists(key, name []byte, tags models.Tags, tracker tsdb.StatsTracker) error
- func (i *Index) CreateSeriesListIfNotExists(keys, names [][]byte, tagsSlice []models.Tags, tracker tsdb.StatsTracker) error
- func (i *Index) Database() string
- func (i *Index) DisableCompactions()
- func (i *Index) DiskSizeBytes() int64
- func (i *Index) DropMeasurement(name []byte) error
- func (i *Index) DropMeasurementIfSeriesNotExist(name []byte) (bool, error)
- func (i *Index) DropSeries(seriesID uint64, key []byte, cascade bool) error
- func (i *Index) DropSeriesGlobal(key []byte) error
- func (i *Index) DropSeriesList(seriesIDs []uint64, keys [][]byte, _ bool) error
- func (i *Index) EnableCompactions()
- func (i *Index) FieldSet() *tsdb.MeasurementFieldSet
- func (i *Index) ForEachMeasurementName(fn func(name []byte) error) error
- func (i *Index) HasTagKey(name, key []byte) (bool, error)
- func (i *Index) HasTagValue(name, key, value []byte) (bool, error)
- func (i *Index) InitializeSeries(keys, names [][]byte, tags []models.Tags) error
- func (i *Index) MeasurementExists(name []byte) (bool, error)
- func (i *Index) MeasurementHasSeries(name []byte) (bool, error)
- func (i *Index) MeasurementIterator() (tsdb.MeasurementIterator, error)
- func (i *Index) MeasurementNamesByRegex(re *regexp.Regexp) ([][]byte, error)
- func (i *Index) MeasurementSeriesIDIterator(name []byte) (tsdb.SeriesIDIterator, error)
- func (i *Index) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
- func (i *Index) MeasurementsSketches() (estimator.Sketch, estimator.Sketch, error)
- func (i *Index) Open() (rErr error)
- func (i *Index) PartitionAt(index int) *Partition
- func (i *Index) Path() string
- func (i *Index) Rebuild()
- func (i *Index) RetainFileSet() (*FileSet, error)
- func (i *Index) SeriesFile() *tsdb.SeriesFile
- func (i *Index) SeriesIDSet() *tsdb.SeriesIDSet
- func (i *Index) SeriesN() int64
- func (i *Index) SeriesSketches() (estimator.Sketch, estimator.Sketch, error)
- func (i *Index) SetFieldName(measurement []byte, name string)
- func (i *Index) SetFieldSet(fs *tsdb.MeasurementFieldSet)
- func (i *Index) TagKeyCardinality(name, key []byte) int
- func (i *Index) TagKeyIterator(name []byte) (tsdb.TagKeyIterator, error)
- func (i *Index) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
- func (i *Index) TagValueIterator(name, key []byte) (tsdb.TagValueIterator, error)
- func (i *Index) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
- func (i *Index) Type() string
- func (i *Index) UniqueReferenceID() uintptr
- func (i *Index) Wait()
- func (i *Index) WithLogger(l *zap.Logger)
- type IndexFile
- func (f *IndexFile) Close() error
- func (f *IndexFile) Compacting() bool
- func (f *IndexFile) HasSeries(name []byte, tags models.Tags, buf []byte) (exists, tombstoned bool)
- func (f *IndexFile) ID() int
- func (f *IndexFile) Level() int
- func (f *IndexFile) Measurement(name []byte) MeasurementElem
- func (f *IndexFile) MeasurementHasSeries(ss *tsdb.SeriesIDSet, name []byte) (ok bool)
- func (f *IndexFile) MeasurementIterator() MeasurementIterator
- func (f *IndexFile) MeasurementN() (n uint64)
- func (f *IndexFile) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
- func (f *IndexFile) MeasurementsSketches() (sketch, tSketch estimator.Sketch, err error)
- func (f *IndexFile) Open() error
- func (f *IndexFile) Path() string
- func (f *IndexFile) Release()
- func (f *IndexFile) Retain()
- func (f *IndexFile) SeriesIDSet() (*tsdb.SeriesIDSet, error)
- func (f *IndexFile) SeriesSketches() (sketch, tSketch estimator.Sketch, err error)
- func (f *IndexFile) SetPath(path string)
- func (f *IndexFile) Size() int64
- func (f *IndexFile) TagKey(name, key []byte) TagKeyElem
- func (f *IndexFile) TagKeyIterator(name []byte) TagKeyIterator
- func (f *IndexFile) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
- func (f *IndexFile) TagValue(name, key, value []byte) TagValueElem
- func (f *IndexFile) TagValueElem(name, key, value []byte) TagValueElem
- func (f *IndexFile) TagValueIterator(name, key []byte) TagValueIterator
- func (f *IndexFile) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
- func (f *IndexFile) TombstoneSeriesIDSet() (*tsdb.SeriesIDSet, error)
- func (f *IndexFile) UnmarshalBinary(data []byte) error
- type IndexFileTrailer
- type IndexFiles
- func (p IndexFiles) CompactTo(w io.Writer, sfile *tsdb.SeriesFile, m, k uint64, cancel <-chan struct{}) (n int64, err error)
- func (p IndexFiles) Files() []File
- func (p IndexFiles) IDs() []int
- func (p IndexFiles) MeasurementIterator() MeasurementIterator
- func (p *IndexFiles) MeasurementNames() [][]byte
- func (p IndexFiles) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
- func (p IndexFiles) Release()
- func (p IndexFiles) Retain()
- func (p IndexFiles) Stat() (*IndexFilesInfo, error)
- func (p *IndexFiles) TagKeyIterator(name []byte) (TagKeyIterator, error)
- func (p IndexFiles) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
- type IndexFilesInfo
- type IndexOption
- type LogEntry
- type LogFile
- func (f *LogFile) AddSeriesList(seriesSet *tsdb.SeriesIDSet, names [][]byte, tagsSlice []models.Tags, ...) ([]uint64, error)
- func (f *LogFile) Close() error
- func (f *LogFile) CompactTo(w io.Writer, m, k uint64, cancel <-chan struct{}) (n int64, err error)
- func (f *LogFile) DeleteMeasurement(name []byte) error
- func (f *LogFile) DeleteSeriesID(id uint64) error
- func (f *LogFile) DeleteSeriesIDList(ids []uint64) error
- func (f *LogFile) DeleteTagKey(name, key []byte) error
- func (f *LogFile) DeleteTagValue(name, key, value []byte) error
- func (f *LogFile) Filter() *bloom.Filter
- func (f *LogFile) FlushAndSync() error
- func (f *LogFile) ID() int
- func (f *LogFile) Level() int
- func (f *LogFile) Measurement(name []byte) MeasurementElem
- func (f *LogFile) MeasurementHasSeries(ss *tsdb.SeriesIDSet, name []byte) bool
- func (f *LogFile) MeasurementIterator() MeasurementIterator
- func (f *LogFile) MeasurementN() (n uint64)
- func (f *LogFile) MeasurementNames() []string
- func (f *LogFile) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
- func (f *LogFile) MeasurementsSketches() (sketch, tSketch estimator.Sketch, err error)
- func (f *LogFile) ModTime() time.Time
- func (f *LogFile) Open() error
- func (f *LogFile) Path() string
- func (f *LogFile) Release()
- func (f *LogFile) Retain()
- func (f *LogFile) SeriesIDIterator() tsdb.SeriesIDIterator
- func (f *LogFile) SeriesIDSet() (*tsdb.SeriesIDSet, error)
- func (f *LogFile) SeriesN() (n uint64)
- func (f *LogFile) SeriesSketches() (sketch, tSketch estimator.Sketch, err error)
- func (f *LogFile) SetPath(path string)
- func (f *LogFile) Size() int64
- func (f *LogFile) Stat() (int64, time.Time)
- func (f *LogFile) TagKey(name, key []byte) TagKeyElem
- func (f *LogFile) TagKeyIterator(name []byte) TagKeyIterator
- func (f *LogFile) TagKeyN() (n uint64)
- func (f *LogFile) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
- func (f *LogFile) TagValue(name, key, value []byte) TagValueElem
- func (f *LogFile) TagValueIterator(name, key []byte) TagValueIterator
- func (f *LogFile) TagValueN() (n uint64)
- func (f *LogFile) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
- func (f *LogFile) TombstoneSeriesIDSet() (*tsdb.SeriesIDSet, error)
- func (f *LogFile) Writes(entries []LogEntry) error
- type Manifest
- type MeasurementBlock
- func (blk *MeasurementBlock) Elem(name []byte) (e MeasurementBlockElem, ok bool)
- func (blk *MeasurementBlock) Iterator() MeasurementIterator
- func (blk *MeasurementBlock) SeriesIDIterator(name []byte) tsdb.SeriesIDIterator
- func (blk *MeasurementBlock) Sketches() (sketch, tSketch estimator.Sketch, err error)
- func (blk *MeasurementBlock) UnmarshalBinary(data []byte) error
- func (blk *MeasurementBlock) Version() int
- type MeasurementBlockElem
- func (e *MeasurementBlockElem) Deleted() bool
- func (e *MeasurementBlockElem) ForEachSeriesID(fn func(uint64) error) error
- func (e *MeasurementBlockElem) HasSeries() bool
- func (e *MeasurementBlockElem) Name() []byte
- func (e *MeasurementBlockElem) SeriesData() []byte
- func (e *MeasurementBlockElem) SeriesID(i int) uint64
- func (e *MeasurementBlockElem) SeriesIDs() []uint64
- func (e *MeasurementBlockElem) SeriesN() uint64
- func (e *MeasurementBlockElem) Size() int
- func (e *MeasurementBlockElem) TagBlockOffset() int64
- func (e *MeasurementBlockElem) TagBlockSize() int64
- func (e *MeasurementBlockElem) UnmarshalBinary(data []byte) error
- type MeasurementBlockTrailer
- type MeasurementBlockWriter
- type MeasurementElem
- type MeasurementElems
- type MeasurementIterator
- type Partition
- func (p *Partition) AssignShard(k string, shardID uint64)
- func (p *Partition) CheckLogFile() error
- func (p *Partition) Close() error
- func (p *Partition) Compact()
- func (p *Partition) CurrentCompactionN() int
- func (p *Partition) DisableCompactions()
- func (p *Partition) DropMeasurement(name []byte) error
- func (p *Partition) DropSeries(seriesID uint64) error
- func (p *Partition) DropSeriesList(seriesIDs []uint64) error
- func (p *Partition) EnableCompactions()
- func (p *Partition) FieldSet() *tsdb.MeasurementFieldSet
- func (p *Partition) FileN() int
- func (p *Partition) ForEachMeasurementName(fn func(name []byte) error) error
- func (p *Partition) ForEachMeasurementTagKey(name []byte, fn func(key []byte) error) error
- func (p *Partition) HasTagKey(name, key []byte) (bool, error)
- func (p *Partition) HasTagValue(name, key, value []byte) (bool, error)
- func (p *Partition) IsOpen() bool
- func (p *Partition) Manifest() *Manifest
- func (p *Partition) ManifestPath() string
- func (p *Partition) MeasurementExists(name []byte) (bool, error)
- func (p *Partition) MeasurementHasSeries(name []byte) (bool, error)
- func (p *Partition) MeasurementIterator() (tsdb.MeasurementIterator, error)
- func (p *Partition) MeasurementNamesByRegex(re *regexp.Regexp) ([][]byte, error)
- func (p *Partition) MeasurementSeriesIDIterator(name []byte) (tsdb.SeriesIDIterator, error)
- func (p *Partition) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
- func (p *Partition) MeasurementsSketches() (estimator.Sketch, estimator.Sketch, error)
- func (p *Partition) NeedsCompaction(checkRunning bool) bool
- func (p *Partition) NextSequence() int
- func (p *Partition) Open() (rErr error)
- func (p *Partition) Path() string
- func (p *Partition) Rebuild()
- func (p *Partition) RemoveShard(shardID uint64)
- func (p *Partition) RetainFileSet() (*FileSet, error)
- func (p *Partition) SeriesFile() *tsdb.SeriesFile
- func (p *Partition) SeriesSketches() (estimator.Sketch, estimator.Sketch, error)
- func (p *Partition) SetFieldName(measurement []byte, name string)
- func (p *Partition) SetFieldSet(fs *tsdb.MeasurementFieldSet)
- func (p *Partition) SetManifestPathForTest(path string)
- func (p *Partition) SetMaxLogFileSize(new int64) (old int64)
- func (p *Partition) TagKeyCardinality(name, key []byte) int
- func (p *Partition) TagKeyIterator(name []byte) tsdb.TagKeyIterator
- func (p *Partition) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
- func (p *Partition) TagValueIterator(name, key []byte) tsdb.TagValueIterator
- func (p *Partition) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
- func (p *Partition) Wait()
- func (p *Partition) WithLogger(logger *zap.Logger)
- type TagBlock
- func (blk *TagBlock) DecodeTagKeyElem(key []byte, elem *TagBlockKeyElem) bool
- func (blk *TagBlock) DecodeTagValueElem(key, value []byte, valueElem *TagBlockValueElem) bool
- func (blk *TagBlock) TagKeyElem(key []byte) TagKeyElem
- func (blk *TagBlock) TagKeyIterator() TagKeyIterator
- func (blk *TagBlock) TagValueElem(key, value []byte) TagValueElem
- func (blk *TagBlock) UnmarshalBinary(data []byte) error
- func (blk *TagBlock) Version() int
- type TagBlockEncoder
- type TagBlockKeyElem
- type TagBlockTrailer
- type TagBlockValueElem
- func (e *TagBlockValueElem) Deleted() bool
- func (e *TagBlockValueElem) SeriesData() []byte
- func (e *TagBlockValueElem) SeriesID(i int) uint64
- func (e *TagBlockValueElem) SeriesIDSet() (*tsdb.SeriesIDSet, error)
- func (e *TagBlockValueElem) SeriesIDs() ([]uint64, error)
- func (e *TagBlockValueElem) SeriesN() uint64
- func (e *TagBlockValueElem) Size() int
- func (e *TagBlockValueElem) Value() []byte
- type TagKeyElem
- type TagKeyIterator
- type TagValueElem
- type TagValueIterator
- type TagValueSeriesIDCache
Constants ¶
const ( // IndexFile trailer fields IndexFileVersionSize = 2 // IndexFileTrailerSize is the size of the trailer. Currently 82 bytes. IndexFileTrailerSize = IndexFileVersionSize + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 0 )
IndexFile field size constants.
const ( LogEntrySeriesTombstoneFlag = 0x01 LogEntryMeasurementTombstoneFlag = 0x02 LogEntryTagKeyTombstoneFlag = 0x04 LogEntryTagValueTombstoneFlag = 0x08 )
Log entry flag constants.
const ( MeasurementTombstoneFlag = 0x01 MeasurementSeriesIDSetFlag = 0x02 )
Measurement flag constants.
const ( // 1 byte offset for the block to ensure non-zero offsets. MeasurementFillSize = 1 // Measurement trailer fields MeasurementTrailerSize = 0 + 2 + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 8 // tombstone measurement sketch offset/size // Measurement key block fields. MeasurementNSize = 8 MeasurementOffsetSize = 8 SeriesIDSize = 8 )
Measurement field size constants.
const ( LogFileExt = ".tsl" IndexFileExt = ".tsi" CompactingExt = ".compacting" )
File extensions.
const ( TagValueTombstoneFlag = 0x01 TagValueSeriesIDSetFlag = 0x02 )
Tag value flag constants.
const ( // TagBlock key block fields. TagKeyNSize = 8 TagKeyOffsetSize = 8 // TagBlock value block fields. TagValueNSize = 8 TagValueOffsetSize = 8 )
TagBlock variable size constants.
const FileSignature = "TSI1"
FileSignature represents a magic number at the header of the index file.
const IndexFileVersion = 1
IndexFileVersion is the current TSI1 index file version.
const IndexName = tsdb.TSI1IndexName
IndexName is the name of the index.
const LoadFactor = 80
LoadFactor is the fill percent for RHH indexes.
const ManifestFileName = "MANIFEST"
ManifestFileName is the name of the index manifest file.
const MaxIndexFileSize = 4 * (1 << 30)
MaxIndexFileSize is the maximum expected size of an index file.
const MaxIndexMergeCount = 2
MaxIndexMergeCount is the maximum number of files that can be merged together at once.
const MeasurementBlockVersion = 1
MeasurementBlockVersion is the version of the measurement block.
const TagBlockTrailerSize = 0 + 8 + 8 + 8 + 8 + 8 + 8 + 8 + 2 // version
TagBlockTrailerSize is the total size of the on-disk trailer.
const TagBlockVersion = 1
TagBlockVersion is the version of the tag block.
const (
TagKeyTombstoneFlag = 0x01
)
Tag key flag constants.
const Version = 1
Version is the current version of the TSI index.
Variables ¶
var ( ErrInvalidIndexFile = errors.New("invalid index file") ErrUnsupportedIndexFileVersion = errors.New("unsupported index file version") )
IndexFile errors.
var ( ErrUnsupportedMeasurementBlockVersion = errors.New("unsupported measurement block version") ErrMeasurementBlockSizeMismatch = errors.New("measurement block size mismatch") )
Measurement errors.
var ( ErrUnsupportedTagBlockVersion = errors.New("unsupported tag block version") ErrTagBlockSizeMismatch = errors.New("tag block size mismatch") )
TagBlock errors.
var DefaultCompactionLevels = []CompactionLevel{
{M: 0, K: 0},
{M: 1 << 25, K: 6},
{M: 1 << 25, K: 6},
{M: 1 << 26, K: 6},
{M: 1 << 27, K: 6},
{M: 1 << 28, K: 6},
{M: 1 << 29, K: 6},
{M: 1 << 30, K: 6},
}
DefaultCompactionLevels is the default settings used by the index.
var DefaultPartitionN uint64 = 8
DefaultPartitionN determines how many shards the index will be partitioned into.
NOTE: Currently, this must not be change once a database is created. Further, it must also be a power of 2.
var DisableCompactions = func() IndexOption { return func(i *Index) { i.disableCompactions = true } }
DisableCompactions disables compactions on the Index.
var DisableFsync = func() IndexOption { return func(i *Index) { i.disableFsync = true } }
DisableFsync disables flushing and syncing of underlying files. Primarily this impacts the LogFiles. This option can be set when working with the index in an offline manner, for cases where a hard failure can be overcome by re-running the tooling.
var ErrCompactionInterrupted = errors.New("tsi1: compaction interrupted")
ErrCompactionInterrupted is returned if compactions are disabled or an index is closed while a compaction is occurring.
var ErrIncompatibleVersion = errors.New("incompatible tsi1 index MANIFEST")
ErrIncompatibleVersion is returned when attempting to read from an incompatible tsi1 manifest file.
var (
ErrLogEntryChecksumMismatch = errors.New("log entry checksum mismatch")
)
Log errors.
var WithLogFileBufferSize = func(sz int) IndexOption { return func(i *Index) { if sz > 1<<17 { sz = 1 << 17 } else if sz < 1<<12 { sz = 1 << 12 } i.logfileBufferSize = sz } }
WithLogFileBufferSize sets the size of the buffer used within LogFiles. Typically appending an entry to a LogFile involves writing 11 or 12 bytes, so depending on how many new series are being created within a batch, it may be appropriate to set this.
var WithLogger = func(l zap.Logger) IndexOption { return func(i *Index) { i.logger = l.With(zap.String("index", "tsi")) } }
WithLogger sets the logger for the Index.
var WithMaximumLogFileAge = func(dur time.Duration) IndexOption { return func(i *Index) { i.maxLogFileAge = dur } }
var WithMaximumLogFileSize = func(size int64) IndexOption { return func(i *Index) { i.maxLogFileSize = size } }
WithMaximumLogFileSize sets the maximum size of LogFiles before they're compacted into IndexFiles.
var WithPath = func(path string) IndexOption { return func(i *Index) { i.path = path } }
WithPath sets the root path of the Index
var WithSeriesIDCacheSize = func(sz int) IndexOption { return func(i *Index) { i.tagValueCacheSize = sz } }
WithSeriesIDCacheSize sets the size of the series id set cache. If set to 0, then the cache is disabled.
Functions ¶
func FormatIndexFileName ¶
FormatIndexFileName generates an index filename for the given index.
func FormatLogFileName ¶
FormatLogFileName generates a log filename for the given index.
func IsIndexDir ¶ added in v1.5.0
IsIndexDir returns true if directory contains at least one partition directory.
func IsPartitionDir ¶ added in v1.5.0
IsPartitionDir returns true if directory contains a MANIFEST file.
func NewTSDBMeasurementIteratorAdapter ¶ added in v1.5.0
func NewTSDBMeasurementIteratorAdapter(itr MeasurementIterator) tsdb.MeasurementIterator
NewTSDBMeasurementIteratorAdapter return an iterator which implements tsdb.MeasurementIterator.
func NewTSDBTagKeyIteratorAdapter ¶ added in v1.5.0
func NewTSDBTagKeyIteratorAdapter(itr TagKeyIterator) tsdb.TagKeyIterator
NewTSDBTagKeyIteratorAdapter return an iterator which implements tsdb.TagKeyIterator.
func NewTSDBTagValueIteratorAdapter ¶ added in v1.5.0
func NewTSDBTagValueIteratorAdapter(itr TagValueIterator) tsdb.TagValueIterator
NewTSDBTagValueIteratorAdapter return an iterator which implements tsdb.TagValueIterator.
func ParseFilename ¶
ParseFilename extracts the numeric id from a log or index file path. Returns 0 if it cannot be parsed.
Types ¶
type CompactionLevel ¶
type CompactionLevel struct { // Bloom filter bit size & hash count M uint64 `json:"m,omitempty"` K uint64 `json:"k,omitempty"` }
CompactionLevel represents a grouping of index files based on bloom filter settings. By having the same bloom filter settings, the filters can be merged and evaluated at a higher level.
type File ¶
type File interface { Close() error Path() string ID() int Level() int Measurement(name []byte) MeasurementElem MeasurementIterator() MeasurementIterator MeasurementHasSeries(ss *tsdb.SeriesIDSet, name []byte) bool TagKey(name, key []byte) TagKeyElem TagKeyIterator(name []byte) TagKeyIterator TagValue(name, key, value []byte) TagValueElem TagValueIterator(name, key []byte) TagValueIterator // Series iteration. MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error) // Sketches for cardinality estimation MeasurementsSketches() (s, t estimator.Sketch, err error) SeriesSketches() (s, t estimator.Sketch, err error) // Bitmap series existance. SeriesIDSet() (*tsdb.SeriesIDSet, error) TombstoneSeriesIDSet() (*tsdb.SeriesIDSet, error) // Reference counting. Retain() Release() // Size of file on disk Size() int64 // contains filtered or unexported methods }
File represents a log or index file.
type FileSet ¶
type FileSet struct {
// contains filtered or unexported fields
}
FileSet represents a collection of files.
func NewFileSet ¶
NewFileSet returns a new instance of FileSet.
func (*FileSet) HasTagValue ¶
HasTagValue returns true if the tag value exists.
func (*FileSet) LastContiguousIndexFilesByLevel ¶
LastContiguousIndexFilesByLevel returns the last contiguous files by level. These can be used by the compaction scheduler.
func (*FileSet) Measurement ¶
func (fs *FileSet) Measurement(name []byte) MeasurementElem
Measurement returns a measurement by name.
func (*FileSet) MeasurementIterator ¶
func (fs *FileSet) MeasurementIterator() MeasurementIterator
MeasurementIterator returns an iterator over all measurements in the index.
func (*FileSet) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (fs *FileSet) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
MeasurementSeriesIDIterator returns a series iterator for a measurement.
func (*FileSet) MeasurementTagKeysByExpr ¶
func (fs *FileSet) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
MeasurementTagKeysByExpr extracts the tag keys wanted by the expression.
func (*FileSet) MeasurementsSketches ¶
MeasurementsSketches returns the merged measurement sketches for the FileSet.
func (*FileSet) MustReplace ¶
MustReplace swaps a list of files for a single file and returns a new file set. The caller should always guarantee that the files exist and are contiguous.
func (*FileSet) PrependLogFile ¶ added in v1.4.0
PrependLogFile returns a new file set with f added at the beginning. Filters do not need to be rebuilt because log files have no bloom filter.
func (*FileSet) Release ¶
func (fs *FileSet) Release()
Release removes a reference count from all files.
func (*FileSet) SeriesSketches ¶
SeriesSketches returns the merged measurement sketches for the FileSet.
func (*FileSet) TagKeyIterator ¶
func (fs *FileSet) TagKeyIterator(name []byte) TagKeyIterator
TagKeyIterator returns an iterator over all tag keys for a measurement.
func (*FileSet) TagKeySeriesIDIterator ¶ added in v1.5.0
func (fs *FileSet) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
TagKeySeriesIDIterator returns a series iterator for all values across a single key.
func (*FileSet) TagValueIterator ¶
func (fs *FileSet) TagValueIterator(name, key []byte) TagValueIterator
TagValueIterator returns a value iterator for a tag key.
func (*FileSet) TagValueSeriesIDIterator ¶ added in v1.5.0
func (fs *FileSet) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
TagValueSeriesIDIterator returns a series iterator for a single tag value.
type Index ¶
type Index struct { // Number of partitions used by the index. PartitionN uint64 // contains filtered or unexported fields }
Index represents a collection of layered index files and WAL.
func NewIndex ¶
func NewIndex(sfile *tsdb.SeriesFile, database string, options ...IndexOption) *Index
NewIndex returns a new instance of Index.
func (*Index) CreateSeriesIfNotExists ¶
func (i *Index) CreateSeriesIfNotExists(key, name []byte, tags models.Tags, tracker tsdb.StatsTracker) error
CreateSeriesIfNotExists creates a series if it doesn't exist or is deleted.
func (*Index) CreateSeriesListIfNotExists ¶
func (i *Index) CreateSeriesListIfNotExists(keys, names [][]byte, tagsSlice []models.Tags, tracker tsdb.StatsTracker) error
CreateSeriesListIfNotExists creates a list of series if they doesn't exist in bulk.
func (*Index) DisableCompactions ¶ added in v1.5.0
func (i *Index) DisableCompactions()
func (*Index) DiskSizeBytes ¶ added in v1.5.0
DiskSizeBytes returns the size of the index on disk.
func (*Index) DropMeasurement ¶
DropMeasurement deletes a measurement from the index. It returns the first error encountered, if any.
func (*Index) DropMeasurementIfSeriesNotExist ¶ added in v1.5.0
DropMeasurementIfSeriesNotExist drops a measurement only if there are no more series for the measurment.
func (*Index) DropSeries ¶
DropSeries drops the provided series from the index. If cascade is true and this is the last series to the measurement, the measurment will also be dropped.
func (*Index) DropSeriesGlobal ¶ added in v1.5.5
DropSeriesGlobal is a no-op on the tsi1 index.
func (*Index) DropSeriesList ¶ added in v1.8.1
DropSeries drops the provided series from the index. If cascade is true and this is the last series to the measurement, the measurment will also be dropped.
func (*Index) EnableCompactions ¶ added in v1.5.0
func (i *Index) EnableCompactions()
func (*Index) FieldSet ¶ added in v1.5.0
func (i *Index) FieldSet() *tsdb.MeasurementFieldSet
FieldSet returns the assigned fieldset.
func (*Index) ForEachMeasurementName ¶
ForEachMeasurementName iterates over all measurement names in the index, applying fn. It returns the first error encountered, if any.
ForEachMeasurementName does not call fn on each partition concurrently so the call may provide a non-goroutine safe fn.
func (*Index) HasTagKey ¶
HasTagKey returns true if tag key exists. It returns the first error encountered if any.
func (*Index) HasTagValue ¶ added in v1.5.0
HasTagValue returns true if tag value exists.
func (*Index) InitializeSeries ¶
InitializeSeries is a no-op. This only applies to the in-memory index.
func (*Index) MeasurementExists ¶
MeasurementExists returns true if a measurement exists.
func (*Index) MeasurementHasSeries ¶ added in v1.5.0
MeasurementHasSeries returns true if a measurement has non-tombstoned series.
func (*Index) MeasurementIterator ¶ added in v1.5.0
func (i *Index) MeasurementIterator() (tsdb.MeasurementIterator, error)
MeasurementIterator returns an iterator over all measurements.
func (*Index) MeasurementNamesByRegex ¶
MeasurementNamesByRegex returns measurement names for the provided regex.
func (*Index) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (i *Index) MeasurementSeriesIDIterator(name []byte) (tsdb.SeriesIDIterator, error)
MeasurementSeriesIDIterator returns an iterator over all series in a measurement.
func (*Index) MeasurementTagKeysByExpr ¶
func (i *Index) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
MeasurementTagKeysByExpr extracts the tag keys wanted by the expression.
func (*Index) MeasurementsSketches ¶
MeasurementsSketches returns the two measurement sketches for the index.
func (*Index) PartitionAt ¶ added in v1.5.0
PartitionAt returns the partition by index.
func (*Index) Rebuild ¶ added in v1.4.0
func (i *Index) Rebuild()
Rebuild rebuilds an index. It's a no-op for this index.
func (*Index) RetainFileSet ¶
RetainFileSet returns the set of all files across all partitions. This is only needed when all files need to be retained for an operation.
func (*Index) SeriesFile ¶ added in v1.5.0
func (i *Index) SeriesFile() *tsdb.SeriesFile
SeriesFile returns the series file attached to the index.
func (*Index) SeriesIDSet ¶ added in v1.5.0
func (i *Index) SeriesIDSet() *tsdb.SeriesIDSet
SeriesIDSet returns the set of series ids associated with series in this index. Any series IDs for series no longer present in the index are filtered out.
func (*Index) SeriesN ¶
Since indexes are not shared across shards, the count returned by SeriesN cannot be combined with other shard's results. If you need to count series across indexes then use either the database-wide series file, or merge the index-level bitsets or sketches.
func (*Index) SeriesSketches ¶
SeriesSketches returns the two series sketches for the index.
func (*Index) SetFieldName ¶
SetFieldName is a no-op on this index.
func (*Index) SetFieldSet ¶
func (i *Index) SetFieldSet(fs *tsdb.MeasurementFieldSet)
SetFieldSet sets a shared field set from the engine.
func (*Index) TagKeyCardinality ¶
TagKeyCardinality always returns zero. It is not possible to determine cardinality of tags across index files, and thus it cannot be done across partitions.
func (*Index) TagKeyIterator ¶ added in v1.5.0
func (i *Index) TagKeyIterator(name []byte) (tsdb.TagKeyIterator, error)
TagKeyIterator returns an iterator for all keys across a single measurement.
func (*Index) TagKeySeriesIDIterator ¶ added in v1.5.0
func (i *Index) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
TagKeySeriesIDIterator returns a series iterator for all values across a single key.
func (*Index) TagValueIterator ¶ added in v1.5.0
func (i *Index) TagValueIterator(name, key []byte) (tsdb.TagValueIterator, error)
TagValueIterator returns an iterator for all values across a single key.
func (*Index) TagValueSeriesIDIterator ¶ added in v1.5.0
func (i *Index) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
TagValueSeriesIDIterator returns a series iterator for a single tag value.
func (*Index) UniqueReferenceID ¶ added in v1.6.0
func (*Index) Wait ¶ added in v1.3.8
func (i *Index) Wait()
Wait blocks until all outstanding compactions have completed.
func (*Index) WithLogger ¶
WithLogger sets the logger on the index after it's been created.
It's not safe to call WithLogger after the index has been opened, or before it has been closed.
type IndexFile ¶
type IndexFile struct {
// contains filtered or unexported fields
}
IndexFile represents a collection of measurement, tag, and series data.
func NewIndexFile ¶
func NewIndexFile(sfile *tsdb.SeriesFile) *IndexFile
NewIndexFile returns a new instance of IndexFile.
func (*IndexFile) Compacting ¶
Compacting returns true if the file is being compacted.
func (*IndexFile) HasSeries ¶
HasSeries returns flags indicating if the series exists and if it is tombstoned.
func (*IndexFile) Measurement ¶
func (f *IndexFile) Measurement(name []byte) MeasurementElem
Measurement returns a measurement element.
func (*IndexFile) MeasurementHasSeries ¶ added in v1.5.0
func (f *IndexFile) MeasurementHasSeries(ss *tsdb.SeriesIDSet, name []byte) (ok bool)
MeasurementHasSeries returns true if a measurement has any non-tombstoned series.
func (*IndexFile) MeasurementIterator ¶
func (f *IndexFile) MeasurementIterator() MeasurementIterator
MeasurementIterator returns an iterator over all measurements.
func (*IndexFile) MeasurementN ¶
MeasurementN returns the number of measurements in the file.
func (*IndexFile) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (f *IndexFile) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
MeasurementSeriesIDIterator returns an iterator over a measurement's series.
func (*IndexFile) MeasurementsSketches ¶ added in v1.6.3
MeasurementsSketches returns existence and tombstone sketches for measurements.
func (*IndexFile) Release ¶
func (f *IndexFile) Release()
Release removes a reference count from the file.
func (*IndexFile) SeriesIDSet ¶ added in v1.5.0
func (f *IndexFile) SeriesIDSet() (*tsdb.SeriesIDSet, error)
func (*IndexFile) SeriesSketches ¶ added in v1.6.3
SeriesSketches returns existence and tombstone sketches for series.
func (*IndexFile) TagKey ¶
func (f *IndexFile) TagKey(name, key []byte) TagKeyElem
TagKey returns a tag key.
func (*IndexFile) TagKeyIterator ¶
func (f *IndexFile) TagKeyIterator(name []byte) TagKeyIterator
TagKeyIterator returns an iterator over all tag keys for a measurement.
func (*IndexFile) TagKeySeriesIDIterator ¶ added in v1.5.0
func (f *IndexFile) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
TagKeySeriesIDIterator returns a series iterator for a tag key and a flag indicating if a tombstone exists on the measurement or key.
func (*IndexFile) TagValue ¶
func (f *IndexFile) TagValue(name, key, value []byte) TagValueElem
TagValue returns a tag value.
func (*IndexFile) TagValueElem ¶
func (f *IndexFile) TagValueElem(name, key, value []byte) TagValueElem
TagValueElem returns an element for a measurement/tag/value.
func (*IndexFile) TagValueIterator ¶
func (f *IndexFile) TagValueIterator(name, key []byte) TagValueIterator
TagValueIterator returns a value iterator for a tag key and a flag indicating if a tombstone exists on the measurement or key.
func (*IndexFile) TagValueSeriesIDSet ¶ added in v1.7.0
func (f *IndexFile) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
TagValueSeriesIDSet returns a series id set for a tag value.
func (*IndexFile) TombstoneSeriesIDSet ¶ added in v1.5.0
func (f *IndexFile) TombstoneSeriesIDSet() (*tsdb.SeriesIDSet, error)
func (*IndexFile) UnmarshalBinary ¶
UnmarshalBinary opens an index from data. The byte slice is retained so it must be kept open.
type IndexFileTrailer ¶
type IndexFileTrailer struct { Version int MeasurementBlock struct { Offset int64 Size int64 } SeriesIDSet struct { Offset int64 Size int64 } TombstoneSeriesIDSet struct { Offset int64 Size int64 } SeriesSketch struct { Offset int64 Size int64 } TombstoneSeriesSketch struct { Offset int64 Size int64 } }
IndexFileTrailer represents meta data written to the end of the index file.
func ReadIndexFileTrailer ¶
func ReadIndexFileTrailer(data []byte) (IndexFileTrailer, error)
ReadIndexFileTrailer returns the index file trailer from data.
type IndexFiles ¶
type IndexFiles []*IndexFile
IndexFiles represents a layered set of index files.
func (IndexFiles) CompactTo ¶
func (p IndexFiles) CompactTo(w io.Writer, sfile *tsdb.SeriesFile, m, k uint64, cancel <-chan struct{}) (n int64, err error)
CompactTo merges all index files and writes them to w.
func (IndexFiles) Files ¶
func (p IndexFiles) Files() []File
Files returns p as a list of File objects.
func (IndexFiles) MeasurementIterator ¶
func (p IndexFiles) MeasurementIterator() MeasurementIterator
MeasurementIterator returns an iterator that merges measurements across all files.
func (*IndexFiles) MeasurementNames ¶
func (p *IndexFiles) MeasurementNames() [][]byte
MeasurementNames returns a sorted list of all measurement names for all files.
func (IndexFiles) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (p IndexFiles) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
MeasurementSeriesIDIterator returns an iterator that merges series across all files.
func (IndexFiles) Release ¶
func (p IndexFiles) Release()
Release removes a reference count from all files.
func (IndexFiles) Stat ¶
func (p IndexFiles) Stat() (*IndexFilesInfo, error)
Stat returns the max index file size and the total file size for all index files.
func (*IndexFiles) TagKeyIterator ¶
func (p *IndexFiles) TagKeyIterator(name []byte) (TagKeyIterator, error)
TagKeyIterator returns an iterator that merges tag keys across all files.
func (IndexFiles) TagValueSeriesIDSet ¶ added in v1.7.0
func (p IndexFiles) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
TagValueSeriesIDSet returns an iterator that merges series across all files.
type IndexFilesInfo ¶
type IndexOption ¶ added in v1.5.0
type IndexOption func(i *Index)
An IndexOption is a functional option for changing the configuration of an Index.
type LogEntry ¶
type LogEntry struct { Flag byte // flag SeriesID uint64 // series id Name []byte // measurement name Key []byte // tag key Value []byte // tag value Checksum uint32 // checksum of flag/name/tags. Size int // total size of record, in bytes. // contains filtered or unexported fields }
LogEntry represents a single log entry in the write-ahead log.
func (*LogEntry) UnmarshalBinary ¶
UnmarshalBinary unmarshals data into e.
type LogFile ¶
type LogFile struct {
// contains filtered or unexported fields
}
LogFile represents an on-disk write-ahead log file.
func NewLogFile ¶
func NewLogFile(sfile *tsdb.SeriesFile, path string) *LogFile
NewLogFile returns a new instance of LogFile.
func (*LogFile) AddSeriesList ¶
func (f *LogFile) AddSeriesList(seriesSet *tsdb.SeriesIDSet, names [][]byte, tagsSlice []models.Tags, tracker tsdb.StatsTracker) ([]uint64, error)
AddSeriesList adds a list of series to the log file in bulk.
func (*LogFile) DeleteMeasurement ¶
DeleteMeasurement adds a tombstone for a measurement to the log file.
func (*LogFile) DeleteSeriesID ¶ added in v1.5.0
DeleteSeriesID adds a tombstone for a series id.
func (*LogFile) DeleteSeriesIDList ¶ added in v1.8.1
DeleteSeriesIDList adds a tombstone for seriesIDList
func (*LogFile) DeleteTagKey ¶
DeleteTagKey adds a tombstone for a tag key to the log file.
func (*LogFile) DeleteTagValue ¶
DeleteTagValue adds a tombstone for a tag value to the log file.
func (*LogFile) FlushAndSync ¶ added in v1.6.1
FlushAndSync flushes buffered data to disk and then fsyncs the underlying file. If the LogFile has disabled flushing and syncing then FlushAndSync is a no-op.
func (*LogFile) Measurement ¶
func (f *LogFile) Measurement(name []byte) MeasurementElem
Measurement returns a measurement element.
func (*LogFile) MeasurementHasSeries ¶ added in v1.5.0
func (f *LogFile) MeasurementHasSeries(ss *tsdb.SeriesIDSet, name []byte) bool
func (*LogFile) MeasurementIterator ¶
func (f *LogFile) MeasurementIterator() MeasurementIterator
MeasurementIterator returns an iterator over all the measurements in the file.
func (*LogFile) MeasurementN ¶
MeasurementN returns the total number of measurements.
func (*LogFile) MeasurementNames ¶
MeasurementNames returns an ordered list of measurement names.
func (*LogFile) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (f *LogFile) MeasurementSeriesIDIterator(name []byte) tsdb.SeriesIDIterator
MeasurementSeriesIDIterator returns an iterator over all series for a measurement.
func (*LogFile) MeasurementsSketches ¶ added in v1.6.3
MeasurementsSketches returns sketches for existing and tombstoned measurement names.
func (*LogFile) Release ¶
func (f *LogFile) Release()
Release removes a reference count from the file.
func (*LogFile) SeriesIDIterator ¶ added in v1.5.0
func (f *LogFile) SeriesIDIterator() tsdb.SeriesIDIterator
SeriesIDIterator returns an iterator over all series in the log file.
func (*LogFile) SeriesIDSet ¶ added in v1.5.0
func (f *LogFile) SeriesIDSet() (*tsdb.SeriesIDSet, error)
SeriesIDSet returns the series existence set.
func (*LogFile) SeriesSketches ¶ added in v1.6.3
SeriesSketches returns sketches for existing and tombstoned series.
func (*LogFile) TagKey ¶
func (f *LogFile) TagKey(name, key []byte) TagKeyElem
TagKey returns a tag key element.
func (*LogFile) TagKeyIterator ¶
func (f *LogFile) TagKeyIterator(name []byte) TagKeyIterator
TagKeyIterator returns a value iterator for a measurement.
func (*LogFile) TagKeySeriesIDIterator ¶ added in v1.5.0
func (f *LogFile) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
TagKeySeriesIDIterator returns a series iterator for a tag key.
func (*LogFile) TagValue ¶
func (f *LogFile) TagValue(name, key, value []byte) TagValueElem
TagValue returns a tag value element.
func (*LogFile) TagValueIterator ¶
func (f *LogFile) TagValueIterator(name, key []byte) TagValueIterator
TagValueIterator returns a value iterator for a tag key.
func (*LogFile) TagValueSeriesIDSet ¶ added in v1.7.0
func (f *LogFile) TagValueSeriesIDSet(name, key, value []byte) (*tsdb.SeriesIDSet, error)
TagValueSeriesIDSet returns a series iterator for a tag value.
func (*LogFile) TombstoneSeriesIDSet ¶ added in v1.5.0
func (f *LogFile) TombstoneSeriesIDSet() (*tsdb.SeriesIDSet, error)
TombstoneSeriesIDSet returns the series tombstone set.
type Manifest ¶
type Manifest struct { Levels []CompactionLevel `json:"levels,omitempty"` Files []string `json:"files,omitempty"` // Version should be updated whenever the TSI format has changed. Version int `json:"version,omitempty"` // contains filtered or unexported fields }
Manifest represents the list of log & index files that make up the index. The files are listed in time order, not necessarily ID order.
func NewManifest ¶
NewManifest returns a new instance of Manifest with default compaction levels.
func ReadManifestFile ¶
ReadManifestFile reads a manifest from a file path and returns the Manifest, the size of the manifest on disk, and any error if appropriate.
type MeasurementBlock ¶
type MeasurementBlock struct {
// contains filtered or unexported fields
}
MeasurementBlock represents a collection of all measurements in an index.
func (*MeasurementBlock) Elem ¶
func (blk *MeasurementBlock) Elem(name []byte) (e MeasurementBlockElem, ok bool)
Elem returns an element for a measurement.
func (*MeasurementBlock) Iterator ¶
func (blk *MeasurementBlock) Iterator() MeasurementIterator
Iterator returns an iterator over all measurements.
func (*MeasurementBlock) SeriesIDIterator ¶ added in v1.5.0
func (blk *MeasurementBlock) SeriesIDIterator(name []byte) tsdb.SeriesIDIterator
SeriesIDIterator returns an iterator for all series ids in a measurement.
func (*MeasurementBlock) Sketches ¶ added in v1.6.3
func (blk *MeasurementBlock) Sketches() (sketch, tSketch estimator.Sketch, err error)
Sketches returns existence and tombstone measurement sketches.
func (*MeasurementBlock) UnmarshalBinary ¶
func (blk *MeasurementBlock) UnmarshalBinary(data []byte) error
UnmarshalBinary unpacks data into the block. Block is not copied so data should be retained and unchanged after being passed into this function.
func (*MeasurementBlock) Version ¶
func (blk *MeasurementBlock) Version() int
Version returns the encoding version parsed from the data. Only valid after UnmarshalBinary() has been successfully invoked.
type MeasurementBlockElem ¶
type MeasurementBlockElem struct {
// contains filtered or unexported fields
}
MeasurementBlockElem represents an internal measurement element.
func (*MeasurementBlockElem) Deleted ¶
func (e *MeasurementBlockElem) Deleted() bool
Deleted returns true if the tombstone flag is set.
func (*MeasurementBlockElem) ForEachSeriesID ¶ added in v1.5.0
func (e *MeasurementBlockElem) ForEachSeriesID(fn func(uint64) error) error
func (*MeasurementBlockElem) HasSeries ¶ added in v1.5.0
func (e *MeasurementBlockElem) HasSeries() bool
func (*MeasurementBlockElem) Name ¶
func (e *MeasurementBlockElem) Name() []byte
Name returns the measurement name.
func (*MeasurementBlockElem) SeriesData ¶
func (e *MeasurementBlockElem) SeriesData() []byte
SeriesData returns the raw series data.
func (*MeasurementBlockElem) SeriesID ¶
func (e *MeasurementBlockElem) SeriesID(i int) uint64
SeriesID returns series ID at an index.
func (*MeasurementBlockElem) SeriesIDs ¶
func (e *MeasurementBlockElem) SeriesIDs() []uint64
SeriesIDs returns a list of decoded series ids.
NOTE: This should be used for testing and diagnostics purposes only. It requires loading the entire list of series in-memory.
func (*MeasurementBlockElem) SeriesN ¶
func (e *MeasurementBlockElem) SeriesN() uint64
SeriesN returns the number of series associated with the measurement.
func (*MeasurementBlockElem) Size ¶
func (e *MeasurementBlockElem) Size() int
Size returns the size of the element.
func (*MeasurementBlockElem) TagBlockOffset ¶
func (e *MeasurementBlockElem) TagBlockOffset() int64
TagBlockOffset returns the offset of the measurement's tag block.
func (*MeasurementBlockElem) TagBlockSize ¶
func (e *MeasurementBlockElem) TagBlockSize() int64
TagBlockSize returns the size of the measurement's tag block.
func (*MeasurementBlockElem) UnmarshalBinary ¶
func (e *MeasurementBlockElem) UnmarshalBinary(data []byte) error
UnmarshalBinary unmarshals data into e.
type MeasurementBlockTrailer ¶
type MeasurementBlockTrailer struct { Version int // Encoding version // Offset & size of data section. Data struct { Offset int64 Size int64 } // Offset & size of hash map section. HashIndex struct { Offset int64 Size int64 } // Offset and size of cardinality sketch for measurements. Sketch struct { Offset int64 Size int64 } // Offset and size of cardinality sketch for tombstoned measurements. TSketch struct { Offset int64 Size int64 } }
MeasurementBlockTrailer represents meta data at the end of a MeasurementBlock.
func ReadMeasurementBlockTrailer ¶
func ReadMeasurementBlockTrailer(data []byte) (MeasurementBlockTrailer, error)
ReadMeasurementBlockTrailer returns the block trailer from data.
type MeasurementBlockWriter ¶
type MeasurementBlockWriter struct {
// contains filtered or unexported fields
}
MeasurementBlockWriter writes a measurement block.
func NewMeasurementBlockWriter ¶
func NewMeasurementBlockWriter() *MeasurementBlockWriter
NewMeasurementBlockWriter returns a new MeasurementBlockWriter.
type MeasurementElem ¶
MeasurementElem represents a generic measurement element.
type MeasurementElems ¶
type MeasurementElems []MeasurementElem
MeasurementElems represents a list of MeasurementElem.
func (MeasurementElems) Len ¶
func (a MeasurementElems) Len() int
func (MeasurementElems) Less ¶
func (a MeasurementElems) Less(i, j int) bool
func (MeasurementElems) Swap ¶
func (a MeasurementElems) Swap(i, j int)
type MeasurementIterator ¶
type MeasurementIterator interface {
Next() MeasurementElem
}
MeasurementIterator represents a iterator over a list of measurements.
func MergeMeasurementIterators ¶
func MergeMeasurementIterators(itrs ...MeasurementIterator) MeasurementIterator
MergeMeasurementIterators returns an iterator that merges a set of iterators. Iterators that are first in the list take precedence and a deletion by those early iterators will invalidate elements by later iterators.
type Partition ¶ added in v1.5.0
type Partition struct {
// contains filtered or unexported fields
}
Partition represents a collection of layered index files and WAL.
func NewPartition ¶ added in v1.5.0
func NewPartition(sfile *tsdb.SeriesFile, path string) *Partition
NewPartition returns a new instance of Partition.
func (*Partition) AssignShard ¶ added in v1.5.0
func (*Partition) CheckLogFile ¶ added in v1.5.0
func (*Partition) Compact ¶ added in v1.5.0
func (p *Partition) Compact()
Compact requests a compaction of log files.
func (*Partition) CurrentCompactionN ¶ added in v1.7.9
CurrentCompactionN returns the number of compactions currently running.
func (*Partition) DisableCompactions ¶ added in v1.5.0
func (p *Partition) DisableCompactions()
func (*Partition) DropMeasurement ¶ added in v1.5.0
DropMeasurement deletes a measurement from the index. DropMeasurement does not remove any series from the index directly.
func (*Partition) DropSeries ¶ added in v1.5.0
func (*Partition) DropSeriesList ¶ added in v1.8.1
func (*Partition) EnableCompactions ¶ added in v1.5.0
func (p *Partition) EnableCompactions()
func (*Partition) FieldSet ¶ added in v1.5.0
func (p *Partition) FieldSet() *tsdb.MeasurementFieldSet
FieldSet returns the fieldset.
func (*Partition) ForEachMeasurementName ¶ added in v1.5.0
ForEachMeasurementName iterates over all measurement names in the index.
func (*Partition) ForEachMeasurementTagKey ¶ added in v1.5.0
ForEachMeasurementTagKey iterates over all tag keys in a measurement.
func (*Partition) HasTagValue ¶ added in v1.5.0
HasTagValue returns true if tag value exists.
func (*Partition) ManifestPath ¶ added in v1.5.0
func (*Partition) MeasurementExists ¶ added in v1.5.0
MeasurementExists returns true if a measurement exists.
func (*Partition) MeasurementHasSeries ¶ added in v1.5.0
MeasurementHasSeries returns true if a measurement has at least one non-tombstoned series.
func (*Partition) MeasurementIterator ¶ added in v1.5.0
func (p *Partition) MeasurementIterator() (tsdb.MeasurementIterator, error)
MeasurementIterator returns an iterator over all measurement names.
func (*Partition) MeasurementNamesByRegex ¶ added in v1.5.0
func (*Partition) MeasurementSeriesIDIterator ¶ added in v1.5.0
func (p *Partition) MeasurementSeriesIDIterator(name []byte) (tsdb.SeriesIDIterator, error)
func (*Partition) MeasurementTagKeysByExpr ¶ added in v1.5.0
func (p *Partition) MeasurementTagKeysByExpr(name []byte, expr influxql.Expr) (map[string]struct{}, error)
MeasurementTagKeysByExpr extracts the tag keys wanted by the expression.
func (*Partition) MeasurementsSketches ¶ added in v1.5.0
MeasurementsSketches returns the two sketches for the partition by merging all instances of the type sketch types in all the index files.
func (*Partition) NeedsCompaction ¶ added in v1.9.4
NeedsCompaction only requires a read lock and checks if there are files that could be compacted.
If compact() is updated we should also update needsCompaction If checkRunning = true, only count as needing a compaction if there is not a compaction already in progress for the level that would be compacted
func (*Partition) NextSequence ¶ added in v1.5.0
NextSequence returns the next file identifier.
func (*Partition) RemoveShard ¶ added in v1.5.0
func (*Partition) RetainFileSet ¶ added in v1.5.0
RetainFileSet returns the current fileset and adds a reference count.
func (*Partition) SeriesFile ¶ added in v1.5.0
func (p *Partition) SeriesFile() *tsdb.SeriesFile
SeriesFile returns the attached series file.
func (*Partition) SeriesSketches ¶ added in v1.5.0
SeriesSketches returns the two sketches for the partition by merging all instances of the type sketch types in all the index files.
func (*Partition) SetFieldName ¶ added in v1.5.0
func (*Partition) SetFieldSet ¶ added in v1.5.0
func (p *Partition) SetFieldSet(fs *tsdb.MeasurementFieldSet)
SetFieldSet sets a shared field set from the engine.
func (*Partition) SetManifestPathForTest ¶ added in v1.10.0
SetManifestPathForTest is only to force a bad path in testing
func (*Partition) SetMaxLogFileSize ¶ added in v1.11.7
SetMaxLogFileSize provides a setter for the partition setting of maxLogFileSize that is otherwise only available at creation time. Returns the previous value. Only for tests!
func (*Partition) TagKeyCardinality ¶ added in v1.5.0
TagKeyCardinality always returns zero. It is not possible to determine cardinality of tags across index files.
func (*Partition) TagKeyIterator ¶ added in v1.5.0
func (p *Partition) TagKeyIterator(name []byte) tsdb.TagKeyIterator
TagKeyIterator returns an iterator for all keys across a single measurement.
func (*Partition) TagKeySeriesIDIterator ¶ added in v1.5.0
func (p *Partition) TagKeySeriesIDIterator(name, key []byte) (tsdb.SeriesIDIterator, error)
TagKeySeriesIDIterator returns a series iterator for all values across a single key.
func (*Partition) TagValueIterator ¶ added in v1.5.0
func (p *Partition) TagValueIterator(name, key []byte) tsdb.TagValueIterator
TagValueIterator returns an iterator for all values across a single key.
func (*Partition) TagValueSeriesIDIterator ¶ added in v1.5.0
func (p *Partition) TagValueSeriesIDIterator(name, key, value []byte) (tsdb.SeriesIDIterator, error)
TagValueSeriesIDIterator returns a series iterator for a single key value.
func (*Partition) Wait ¶ added in v1.5.0
func (p *Partition) Wait()
Wait will block until all compactions are finished. Must only be called while they are disabled.
func (*Partition) WithLogger ¶ added in v1.5.0
WithLogger sets the logger for the index.
type TagBlock ¶
type TagBlock struct {
// contains filtered or unexported fields
}
TagBlock represents tag key/value block for a single measurement.
func (*TagBlock) DecodeTagKeyElem ¶ added in v1.5.0
func (blk *TagBlock) DecodeTagKeyElem(key []byte, elem *TagBlockKeyElem) bool
func (*TagBlock) DecodeTagValueElem ¶ added in v1.5.0
func (blk *TagBlock) DecodeTagValueElem(key, value []byte, valueElem *TagBlockValueElem) bool
DecodeTagValueElem returns an element for a tag value.
func (*TagBlock) TagKeyElem ¶
func (blk *TagBlock) TagKeyElem(key []byte) TagKeyElem
TagKeyElem returns an element for a tag key. Returns an element with a nil key if not found.
func (*TagBlock) TagKeyIterator ¶
func (blk *TagBlock) TagKeyIterator() TagKeyIterator
TagKeyIterator returns an iterator over all the keys in the block.
func (*TagBlock) TagValueElem ¶
func (blk *TagBlock) TagValueElem(key, value []byte) TagValueElem
TagValueElem returns an element for a tag value.
func (*TagBlock) UnmarshalBinary ¶
UnmarshalBinary unpacks data into the tag block. Tag block is not copied so data should be retained and unchanged after being passed into this function.
type TagBlockEncoder ¶
type TagBlockEncoder struct {
// contains filtered or unexported fields
}
TagBlockEncoder encodes a tags to a TagBlock section.
func NewTagBlockEncoder ¶
func NewTagBlockEncoder(w io.Writer) *TagBlockEncoder
NewTagBlockEncoder returns a new TagBlockEncoder.
func (*TagBlockEncoder) Close ¶
func (enc *TagBlockEncoder) Close() error
Close flushes the trailer of the encoder to the writer.
func (*TagBlockEncoder) EncodeKey ¶
func (enc *TagBlockEncoder) EncodeKey(key []byte, deleted bool) error
EncodeKey writes a tag key to the underlying writer.
func (*TagBlockEncoder) EncodeValue ¶
func (enc *TagBlockEncoder) EncodeValue(value []byte, deleted bool, ss *tsdb.SeriesIDSet) error
EncodeValue writes a tag value to the underlying writer. The tag key must be lexicographical sorted after the previous encoded tag key.
func (*TagBlockEncoder) N ¶
func (enc *TagBlockEncoder) N() int64
N returns the number of bytes written.
type TagBlockKeyElem ¶
type TagBlockKeyElem struct {
// contains filtered or unexported fields
}
TagBlockKeyElem represents a tag key element in a TagBlock.
func (*TagBlockKeyElem) Deleted ¶
func (e *TagBlockKeyElem) Deleted() bool
Deleted returns true if the key has been tombstoned.
func (*TagBlockKeyElem) Key ¶
func (e *TagBlockKeyElem) Key() []byte
Key returns the key name of the element.
func (*TagBlockKeyElem) TagValueIterator ¶
func (e *TagBlockKeyElem) TagValueIterator() TagValueIterator
TagValueIterator returns an iterator over the key's values.
type TagBlockTrailer ¶
type TagBlockTrailer struct { Version int // Encoding version Size int64 // Total size w/ trailer // Offset & size of value data section. ValueData struct { Offset int64 Size int64 } // Offset & size of key data section. KeyData struct { Offset int64 Size int64 } // Offset & size of hash map section. HashIndex struct { Offset int64 Size int64 } }
TagBlockTrailer represents meta data at the end of a TagBlock.
func ReadTagBlockTrailer ¶
func ReadTagBlockTrailer(data []byte) (TagBlockTrailer, error)
ReadTagBlockTrailer returns the tag block trailer from data.
type TagBlockValueElem ¶
type TagBlockValueElem struct {
// contains filtered or unexported fields
}
TagBlockValueElem represents a tag value element.
func (*TagBlockValueElem) Deleted ¶
func (e *TagBlockValueElem) Deleted() bool
Deleted returns true if the element has been tombstoned.
func (*TagBlockValueElem) SeriesData ¶
func (e *TagBlockValueElem) SeriesData() []byte
SeriesData returns the raw series data.
func (*TagBlockValueElem) SeriesID ¶
func (e *TagBlockValueElem) SeriesID(i int) uint64
SeriesID returns series ID at an index.
func (*TagBlockValueElem) SeriesIDSet ¶ added in v1.7.0
func (e *TagBlockValueElem) SeriesIDSet() (*tsdb.SeriesIDSet, error)
SeriesIDSet returns a set of series ids.
func (*TagBlockValueElem) SeriesIDs ¶
func (e *TagBlockValueElem) SeriesIDs() ([]uint64, error)
SeriesIDs returns a list decoded series ids.
func (*TagBlockValueElem) SeriesN ¶
func (e *TagBlockValueElem) SeriesN() uint64
SeriesN returns the series count.
func (*TagBlockValueElem) Size ¶
func (e *TagBlockValueElem) Size() int
Size returns the size of the element.
func (*TagBlockValueElem) Value ¶
func (e *TagBlockValueElem) Value() []byte
Value returns the value for the element.
type TagKeyElem ¶
type TagKeyElem interface { Key() []byte Deleted() bool TagValueIterator() TagValueIterator }
TagKeyElem represents a generic tag key element.
type TagKeyIterator ¶
type TagKeyIterator interface {
Next() TagKeyElem
}
TagKeyIterator represents a iterator over a list of tag keys.
func MergeTagKeyIterators ¶
func MergeTagKeyIterators(itrs ...TagKeyIterator) TagKeyIterator
MergeTagKeyIterators returns an iterator that merges a set of iterators. Iterators that are first in the list take precedence and a deletion by those early iterators will invalidate elements by later iterators.
type TagValueElem ¶
TagValueElem represents a generic tag value element.
type TagValueIterator ¶
type TagValueIterator interface {
Next() TagValueElem
}
TagValueIterator represents a iterator over a list of tag values.
func MergeTagValueIterators ¶
func MergeTagValueIterators(itrs ...TagValueIterator) TagValueIterator
MergeTagValueIterators returns an iterator that merges a set of iterators. Iterators that are first in the list take precedence and a deletion by those early iterators will invalidate elements by later iterators.
type TagValueSeriesIDCache ¶ added in v1.7.0
TagValueSeriesIDCache is an LRU cache for series id sets associated with name -> key -> value mappings. The purpose of the cache is to provide efficient means to get sets of series ids that would otherwise involve merging many individual bitmaps at query time.
When initialising a TagValueSeriesIDCache a capacity must be provided. When more than c items are added to the cache, the least recently used item is evicted from the cache.
A TagValueSeriesIDCache comprises a linked list implementation to track the order by which items should be evicted from the cache, and a hashmap implementation to provide constant time retrievals of items from the cache.
func NewTagValueSeriesIDCache ¶ added in v1.7.0
func NewTagValueSeriesIDCache(c int) *TagValueSeriesIDCache
NewTagValueSeriesIDCache returns a TagValueSeriesIDCache with capacity c.
func (*TagValueSeriesIDCache) Delete ¶ added in v1.7.0
func (c *TagValueSeriesIDCache) Delete(name, key, value []byte, x uint64)
Delete removes x from the tuple {name, key, value} if it exists. This method takes a lock on the underlying SeriesIDSet.
func (*TagValueSeriesIDCache) Get ¶ added in v1.7.0
func (c *TagValueSeriesIDCache) Get(name, key, value []byte) *tsdb.SeriesIDSet
Get returns the SeriesIDSet associated with the {name, key, value} tuple if it exists.
func (*TagValueSeriesIDCache) Put ¶ added in v1.7.0
func (c *TagValueSeriesIDCache) Put(name, key, value []byte, ss *tsdb.SeriesIDSet)
Put adds the SeriesIDSet to the cache under the tuple {name, key, value}. If the cache is at its limit, then the least recently used item is evicted.