rabosh-catalog/app.oreshkov.rabosh.catalog/IndexKind

IndexKind

What kind of sidecar a path is worth.

The catalog's own vocabulary, not the index module's: rabosh-index sits above this one, so naming its types here would be an upward dependency. It is a recommendation, and the layer that builds indexes decides what to make of it.

Entries

INVERTED

A value -> bitmap inverted index. Equality, IN, and existence, answered by intersecting bitmaps before any document is touched.

SHREDDED_COLUMN

A shredded typed column, per the Variant shredding specification: the path's values lifted out of the documents into a typed run with min/max statistics, so a scan of that one field does not touch the documents at all.

COMPOSITE_TERM

A composite term over one array element: the values of several fields of the same element, keyed together.

Properties

entries

val entries: EnumEntries<IndexKind>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): IndexKind

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<IndexKind>

Returns an array containing the constants of this enum type, in the order they're declared.