rabosh-catalog/app.oreshkov.rabosh.catalog/IndexCandidate

IndexCandidate

A path the catalog thinks is worth an index, and why.

The reason is not decoration. An automatic recommendation that cannot say what it is based on is one nobody can argue with, and the numbers behind these are estimates — a caller who knows the workload should be able to see that a path was recommended because it is in 98% of documents with one type and reject it because nothing ever filters on it.

Properties

field

val field: InferredField

The statistics it was derived from.

kind

val kind: IndexKind

What kind of index.

path

val path: CatalogPath

The path an index would be built for.

reason

val reason: String

What the recommendation is based on, in words.

score

val score: Double

A relative ranking in 0.0..1.0. Comparable between candidates of the same kind and only loosely between kinds — they are answering different questions.

Functions

toString

open override fun toString(): String