Package com.apple.foundationdb.record.provider.foundationdb.indexes

Class VersionIndexMaintainer

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.IndexMaintainer

com.apple.foundationdb.record.provider.foundationdb.indexes.StandardIndexMaintainer

com.apple.foundationdb.record.provider.foundationdb.indexes.VersionIndexMaintainer

@API(EXPERIMENTAL)
public class VersionIndexMaintainer
extends StandardIndexMaintainer

Implementation of IndexMaintainer for the "version" index type. Here, the keys of the index are required to have exactly one column that is of type Version. If records are added to this index with a complete FDBRecordVersion associated with it, then the given version is used. If it is associated with an incomplete RecordVersion, then it will set the key in such a way that the global version is filled in when the record is committed. If one only ever serializes records with incomplete RecordVersions, then this index guarantees that the version column is strictly monotonically increasing with time.

Field Summary

Fields inherited from class com.apple.foundationdb.record.provider.foundationdb.indexes.StandardIndexMaintainer

TOO_LARGE_VALUE_MESSAGE_LIMIT

Fields inherited from class com.apple.foundationdb.record.provider.foundationdb.IndexMaintainer

state

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VersionIndexMaintainer(IndexMaintainerState state)

Method Summary

Modifier and Type	Method	Description
RecordCursor<IndexEntry>	scan(IndexScanType scanType, TupleRange range, byte[] continuation, ScanProperties scanProperties)	Scan entries in the index.
protected <M extends Message> CompletableFuture<Void>	updateOneKeyAsync(FDBIndexableRecord<M> savedRecord, boolean remove, IndexEntry indexEntry)	Store a single key in the index.

Methods inherited from class com.apple.foundationdb.record.provider.foundationdb.indexes.StandardIndexMaintainer

addedRangeWithKey, addUniquenessViolation, canDeleteWhere, canDeleteWhere, canEvaluateAggregateFunction, canEvaluateRecordFunction, checkKeyValueSizes, checkUniqueness, commonKeys, decodeValue, deleteWhere, evaluateAggregateFunction, evaluateIndex, evaluateRecordFunction, filteredIndexEntries, getExecutor, getGroupedCount, getGroupingCount, getTimer, indexEntryKey, isIdempotent, makeMutable, performOperation, removeUniquenessViolationsAsync, saveIndexEntryAsKeyValue, scan, scanUniquenessViolations, skipUpdateForUnchangedKeys, trimTooLargeTuple, unpackKeyValue, unpackKeyValue, update, updateIndexKeys, updateIndexKeysFunction, validateEntries, validateMissingEntries, validateOrphanEntries

Methods inherited from class com.apple.foundationdb.record.provider.foundationdb.IndexMaintainer

getIndexSubspace, getSecondarySubspace, unsupportedAggregateFunction, unsupportedRecordFunction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersionIndexMaintainer

protected VersionIndexMaintainer(IndexMaintainerState state)

Method Detail

scan

@Nonnull
public RecordCursor<IndexEntry> scan(@Nonnull
                                     IndexScanType scanType,
                                     @Nonnull
                                     TupleRange range,
                                     @Nullable
                                     byte[] continuation,
                                     @Nonnull
                                     ScanProperties scanProperties)

Description copied from class: IndexMaintainer

Scan entries in the index.

Specified by:

scan in class IndexMaintainer

Parameters:

scanType - the type of scan to perform

range - the range to scan

continuation - any continuation from a previous scan invocation

scanProperties - skip, limit and other properties of the scan

Returns:

a cursor over index entries in the given range

updateOneKeyAsync

protected <M extends Message> CompletableFuture<Void> updateOneKeyAsync(@Nonnull
                                                                        FDBIndexableRecord<M> savedRecord,
                                                                        boolean remove,
                                                                        @Nonnull
                                                                        IndexEntry indexEntry)

Description copied from class: StandardIndexMaintainer

Store a single key in the index.

Overrides:

updateOneKeyAsync in class StandardIndexMaintainer

Type Parameters:

M - the message type of the record

Parameters:

savedRecord - the record being indexed

remove - true if removing from index

indexEntry - the entry for the index to be updated

Returns:

a future completed when the key is updated