rabosh-index/app.oreshkov.rabosh.index

Package-level declarations

Types

class Bitmap : ReadableBitmap

A mutable set of document ordinals, held as one block per 65 536 ordinals.

class BitmapCursor

A walk over a bitmap's ordinals, ascending.

class BitmapView : ReadableBitmap

A serialized bitmap, read where it lies.

class ColumnMatch

What one segment's column said about a predicate, and what deciding it cost.

ColumnPredicate

class ColumnPredicate

A test a shredded column can answer without opening a document.

object ColumnQuery

Answers a predicate from a shredded column where it can and a scan where it cannot.

class ColumnReader : AutoCloseable

One shredded column, read at one snapshot, with every sidecar it may consult pinned.

class ColumnScan

What a column scan found, and what it cost.

CompositeSegmentObserver

class CompositeSegmentObserver(val observers: List<SegmentObserver>) : SegmentObserver

Feeds several observers from the one StoreOptions.segmentObserver slot.

object CompositeTerm

The key of a composite index: several fields of one element, spelled as one term.

CorruptBitmapException

class CorruptBitmapException(message: String, val file: String, val offset: Long = -1, cause: Throwable? = null) : IndexException

A serialized bitmap cannot be read as one this implementation wrote.

CorruptIndexException

class CorruptIndexException(message: String, val file: String, val offset: Long = -1, cause: Throwable? = null) : IndexException

An index sidecar or the index registry cannot be read as this implementation wrote it.

DamagedIndexPolicy

enum DamagedIndexPolicy : Enum<DamagedIndexPolicy>

What to do about a sidecar that will not decode.

ElementExtractor

class ElementExtractor(paths: List<CatalogPath>, options: IndexOptions)

Walks a document and emits the containers a set of paths stands for.

class IndexBuild

A sidecar build running on the index catalog's own thread.

IndexBuildProgress

class IndexBuildProgress

How far a background build has got.

IndexBuildState

enum IndexBuildState : Enum<IndexBuildState>

What a background index build is doing, or what it ended as.

class IndexCatalog(val directory: Path, val options: IndexOptions = IndexOptions.DEFAULT) : SegmentObserver, AutoCloseable

The indexes a store has, and the sidecars that carry them.

class IndexCoverage

How much of a store an index can answer for, at one snapshot.

IndexDefinition

class IndexDefinition(val path: CatalogPath, val kind: IndexKind = IndexKind.INVERTED, val fields: List<CatalogPath> = emptyList())

What an index is over.

sealed class IndexException : RuntimeException

Base class for every failure the indexing layer raises on its own account.

class IndexHandle

An index that has been defined, as the registry records it.

class IndexOptions(val maxTermsPerSegment: Int = 1 shl 20, val maxTermBytes: Int = 512, val maxDepth: Int = 32, val maxChildren: Int = 1024, val damagedSidecars: DamagedIndexPolicy = DamagedIndexPolicy.REPORT, val maxColumnValuesPerSegment: Int = 1 shl 24, val columnTextBoundBytes: Int = 64)

Tuning for IndexCatalog.

object IndexQuery

Answers a predicate using an index where it can and a scan where it cannot.

class IndexReader : AutoCloseable

One index, read at one snapshot, with every sidecar it may consult pinned for its lifetime.

IndexStateException

class IndexStateException(message: String) : IndexException

An index catalog was asked something it cannot answer in the state it is in.

class IndexTerm : Comparable<IndexTerm>

A value, as the index keys it.

class KeyCursor

Candidate keys, in segment order and ascending within each segment.

sealed interface ReadableBitmap

A set of document ordinals that can be read, whether it is being built on the heap or read straight out of a mapped file.

RoaringPortable

object RoaringPortable

Import and export in the RoaringBitmap portable serialization format.

class TermExtractor(paths: List<CatalogPath>, options: IndexOptions)

Walks a document and emits the values it contributes to a set of indexed paths.

UnsupportedBitmapFormatException

class UnsupportedBitmapFormatException(message: String) : IndexException

A bitmap was written at a format version, or with a container kind, this build does not know.

UnsupportedIndexFormatException

class UnsupportedIndexFormatException(message: String) : IndexException

A sidecar or registry was written at a format version, section kind or posting encoding this build does not know.