Package com.apple.foundationdb.record.provider.foundationdb.indexes
Index maintainer classes.
Secondary indexes are identified in the meta-data by a string type.
A IndexMaintainerRegistry
maps an index type to IndexMaintainerFactory
, allowing
for index types defined outside of the Record Layer core.
An IndexMaintainer
is responsible for storing index entries for records when they are saved and for scanning those entries to retrieve the records in a query.
In addition to B-tree indexes, which provide lexicographic ordering of one or more key fields in the record, the Record Layer core includes some special indexes.
AtomicMutationIndexMaintainer
for accumulating contention-free aggregates such asCOUNT
,SUM
,MIN
,MAX
.RankIndexMaintainer
supporting efficientrank
andselect
of a score-like key field using a persistent skip-list.TextIndexMaintainer
tokenizing full text into an inverted index.
-
Interface Summary Interface Description AtomicMutation The particular operation to be performed by anAtomicMutationIndexMaintainer
index.InvalidIndexEntry.Reason The reason why an index entry is invalid. -
Class Summary Class Description AtomicMutationIndexMaintainer An index that maintains an aggregate value in a low-contention way.AtomicMutationIndexMaintainerFactory A factory forAtomicMutationIndexMaintainer
indexes.BitmapValueIndexMaintainer An index maintainer for storing bitmaps of which records meet a specific condition.BitmapValueIndexMaintainerFactory A factory forBitmapValueIndexMaintainer
.InvalidIndexEntry An invalid index entry including the entry and the reason why it is invalid.NoOpIndexMaintainer An index maintainer that doesn't do anything.NoOpIndexMaintainerFactory A factory forNoOpIndexMaintainer
indexes.PermutedMinMaxIndexMaintainer An index that maintains an extremum value in a way that can be enumerated by that value rather than by group.PermutedMinMaxIndexMaintainerFactory A factory forPermutedMinMaxIndexMaintainer
indexes.RankedSetHashFunctions Known hash functions available as index options.RankedSetIndexHelper Helper functions for index maintainers that use aRankedSet
.RankedSetIndexHelper.InstrumentedRankedSet ARankedSet
that addsStoreTimer
instrumentation.RankIndexMaintainer An index maintainer for keeping aRankedSet
of record field values.RankIndexMaintainerFactory A factory forRankIndexMaintainer
indexes.StandardIndexMaintainer Base class forIndexMaintainer
implementation.TextIndexBunchedSerializer Serializer used by theTextIndexMaintainer
to write entries into aBunchedMap
.TextIndexMaintainer The index maintainer class for full-text indexes.TextIndexMaintainerFactory Supplier ofTextIndexMaintainer
s, that is, of index maintainers for the full text index type.ValueIndexMaintainer An index maintainer for an ordinary index by value, implementing ordered enumeration of records within a range of indexed values.ValueIndexMaintainerFactory A factory forValueIndexMaintainer
indexes.VersionIndexMaintainer Implementation ofIndexMaintainer
for the "version" index type.VersionIndexMaintainerFactory A factory forVersionIndexMaintainer
indexes. -
Enum Summary Enum Description AtomicMutation.Standard The atomic mutations implemented straightforwardly by the FDB API.InvalidIndexEntry.Reasons The reasons supported in the Record Layer.PermutedMinMaxIndexMaintainer.Type RankedSetIndexHelper.Events Instrumentation events specific to rank index maintenance.