Package com.apple.foundationdb.record.lucene

Class LuceneIndexMaintainer

java.lang.Object

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

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

com.apple.foundationdb.record.lucene.LuceneIndexMaintainer

@API(EXPERIMENTAL)
public class LuceneIndexMaintainer
extends StandardIndexMaintainer

Index maintainer for Lucene Indexes backed by FDB. The insert, update, and delete functionality coupled with the scan functionality is implemented here.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	PRIMARY_KEY_BINARY_POINT_NAME
static final String	PRIMARY_KEY_FIELD_NAME
static final String	PRIMARY_KEY_SEARCH_NAME

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

Constructor	Description
LuceneIndexMaintainer(IndexMaintainerState state, Executor executor)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	addedRangeWithKey(Tuple primaryKey)
boolean	canDeleteWhere(QueryToKeyMatcher matcher, Key.Evaluated evaluated)
boolean	canEvaluateAggregateFunction(IndexAggregateFunction function)
boolean	canEvaluateRecordFunction(IndexRecordFunction<?> function)
protected FDBDirectoryManager	createDirectoryManager(IndexMaintainerState state)
int	deleteDocumentBypassQueue(Tuple groupingKey, Integer partitionId, Tuple primaryKey)
CompletableFuture<Void>	deleteWhere(Transaction tr, Tuple prefix)
CompletableFuture<Tuple>	evaluateAggregateFunction(IndexAggregateFunction function, TupleRange range, IsolationLevel isolationLevel)
<T, M extends Message> CompletableFuture<T>	evaluateRecordFunction(EvaluationContext context, IndexRecordFunction<T> function, FDBRecord<M> record)
LuceneAnalyzerCombinationProvider	getAutoCompleteAnalyzerSelector()
protected FDBDirectory	getDirectory(Tuple groupingKey, Integer partitionId)
FDBDirectoryManager	getDirectoryManager()
IndexScrubbingTools<?>	getIndexScrubbingTools(IndexScrubbingTools.ScrubbingType type)
LucenePartitioner	getPartitioner()
boolean	isIdempotent()
<M extends Message> FDBIndexableRecord<M>	maybeFilterRecord(FDBIndexableRecord<M> rec)
CompletableFuture<Void>	mergeIndex()
void	mergeIndexForTesting(Tuple groupingKey, Integer partitionId, AgilityContext agilityContext)
CompletableFuture<IndexOperationResult>	performOperation(IndexOperation operation)
CompletableFuture<Integer>	postDeleteUpdatePartitionCounter(Tuple groupingKey, int partitionId, int countDeleted)
CompletableFuture<Void>	rebalancePartitions()
RecordCursor<IndexEntry>	scan(IndexScanType scanType, TupleRange range, byte[] continuation, ScanProperties scanProperties)
RecordCursor<IndexEntry>	scan(IndexScanBounds scanBounds, byte[] continuation, ScanProperties scanProperties)	The scan takes Lucene a Query as scan bounds.
CompletableFuture<Boolean>	shouldUseQueueAsync(Tuple groupingKey, Integer partitionId)
<M extends Message> CompletableFuture<Void>	update(FDBIndexableRecord<M> oldRecord, FDBIndexableRecord<M> newRecord)
RecordCursor<InvalidIndexEntry>	validateEntries(byte[] continuation, ScanProperties scanProperties)
void	writeDocumentBypassQueue(Tuple groupingKey, Integer partitionId, Tuple primaryKey, List<LuceneDocumentFromRecord.DocumentField> fields)

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

addUniquenessViolation, canDeleteGroup, canDeleteWhere, checkKeyValueSizes, checkUniqueness, clearUniquenessViolations, commonKeys, decodeValue, evaluateIndex, filteredIndexEntries, getExecutor, getFilterTypeForRecord, getGroupedCount, getGroupingCount, getTimer, indexEntryKey, makeMutable, removeUniquenessViolationsAsync, saveIndexEntryAsKeyValue, scan, scanRemoteFetchByValue, scanUniquenessViolations, skipUpdateForUnchangedKeys, trimTooLargeTuple, unpackKeyValue, unpackKeyValue, unpackRemoteFetchRecord, updateIndexKeys, updateIndexKeysFunction, updateOneKeyAsync, updateWhileWriteOnly, validateMissingEntries, validateOrphanEntries

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

getIndexSubspace, getSecondarySubspace, scanRemoteFetch, unsupportedAggregateFunction, unsupportedRecordFunction

Methods inherited from class java.lang.Object

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

Field Details

PRIMARY_KEY_FIELD_NAME

public static final String PRIMARY_KEY_FIELD_NAME

See Also:

• Constant Field Values

PRIMARY_KEY_SEARCH_NAME

public static final String PRIMARY_KEY_SEARCH_NAME

See Also:

• Constant Field Values

PRIMARY_KEY_BINARY_POINT_NAME

protected static final String PRIMARY_KEY_BINARY_POINT_NAME

See Also:

• Constant Field Values

Constructor Details

LuceneIndexMaintainer

public LuceneIndexMaintainer(@Nonnull
 IndexMaintainerState state,
 @Nonnull
 Executor executor)

Method Details

getAutoCompleteAnalyzerSelector

public LuceneAnalyzerCombinationProvider getAutoCompleteAnalyzerSelector()

scan

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

Specified by:

scan in class IndexMaintainer

scan

@Nonnull
public RecordCursor<IndexEntry> scan(@Nonnull
 IndexScanBounds scanBounds,
 @Nullable
 byte[] continuation,
 @Nonnull
 ScanProperties scanProperties)

The scan takes Lucene a Query as scan bounds.

Overrides:

scan in class IndexMaintainer

Parameters:

scanBounds - the type of Lucene scan and associated Query

continuation - any continuation from a previous scan invocation

scanProperties - skip, limit and other properties of the scan

Returns:

RecordCursor of index entries reconstituted from Lucene documents

writeDocumentBypassQueue

public void writeDocumentBypassQueue(Tuple groupingKey,
 Integer partitionId,
 Tuple primaryKey,
 @Nonnull
 List<LuceneDocumentFromRecord.DocumentField> fields)
                              throws IOException

Throws:

IOException

deleteDocumentBypassQueue

public int deleteDocumentBypassQueue(Tuple groupingKey,
 @Nullable
 Integer partitionId,
 Tuple primaryKey)
                              throws IOException

Throws:

IOException

mergeIndex

public CompletableFuture<Void> mergeIndex()

Overrides:

mergeIndex in class StandardIndexMaintainer

mergeIndexForTesting

public void mergeIndexForTesting(@Nonnull
 Tuple groupingKey,
 @Nullable
 Integer partitionId,
 @Nonnull
 AgilityContext agilityContext)

getPartitioner

@Nonnull
public LucenePartitioner getPartitioner()

rebalancePartitions

public CompletableFuture<Void> rebalancePartitions()

update

@Nonnull
public <M extends Message> CompletableFuture<Void> update(@Nullable
 FDBIndexableRecord<M> oldRecord,
 @Nullable
 FDBIndexableRecord<M> newRecord)

Overrides:

update in class StandardIndexMaintainer

maybeFilterRecord

@Nullable
public <M extends Message> FDBIndexableRecord<M> maybeFilterRecord(FDBIndexableRecord<M> rec)

postDeleteUpdatePartitionCounter

@Nonnull
public CompletableFuture<Integer> postDeleteUpdatePartitionCounter(@Nonnull
 Tuple groupingKey,
 int partitionId,
 int countDeleted)

validateEntries

@Nonnull
public RecordCursor<InvalidIndexEntry> validateEntries(@Nullable
 byte[] continuation,
 @Nullable
 ScanProperties scanProperties)

Overrides:

validateEntries in class StandardIndexMaintainer

canEvaluateRecordFunction

public boolean canEvaluateRecordFunction(@Nonnull
 IndexRecordFunction<?> function)

Overrides:

canEvaluateRecordFunction in class StandardIndexMaintainer

evaluateRecordFunction

@Nonnull
public <T,
M extends Message> CompletableFuture<T> evaluateRecordFunction(@Nonnull
 EvaluationContext context,
 @Nonnull
 IndexRecordFunction<T> function,
 @Nonnull
 FDBRecord<M> record)

Overrides:

evaluateRecordFunction in class StandardIndexMaintainer

canEvaluateAggregateFunction

public boolean canEvaluateAggregateFunction(@Nonnull
 IndexAggregateFunction function)

Overrides:

canEvaluateAggregateFunction in class StandardIndexMaintainer

evaluateAggregateFunction

@Nonnull
public CompletableFuture<Tuple> evaluateAggregateFunction(@Nonnull
 IndexAggregateFunction function,
 @Nonnull
 TupleRange range,
 @Nonnull
 IsolationLevel isolationLevel)

Overrides:

evaluateAggregateFunction in class StandardIndexMaintainer

isIdempotent

public boolean isIdempotent()

Overrides:

isIdempotent in class StandardIndexMaintainer

addedRangeWithKey

@Nonnull
public CompletableFuture<Boolean> addedRangeWithKey(@Nonnull
 Tuple primaryKey)

Overrides:

addedRangeWithKey in class StandardIndexMaintainer

canDeleteWhere

public boolean canDeleteWhere(@Nonnull
 QueryToKeyMatcher matcher,
 @Nonnull
 Key.Evaluated evaluated)

Overrides:

canDeleteWhere in class StandardIndexMaintainer

deleteWhere

@Nonnull
public CompletableFuture<Void> deleteWhere(Transaction tr,
 @Nonnull
 Tuple prefix)

Overrides:

deleteWhere in class StandardIndexMaintainer

performOperation

@Nonnull
public CompletableFuture<IndexOperationResult> performOperation(@Nonnull
 IndexOperation operation)

Overrides:

performOperation in class StandardIndexMaintainer

getDirectory

protected FDBDirectory getDirectory(@Nonnull
 Tuple groupingKey,
 @Nullable
 Integer partitionId)

getDirectoryManager

public FDBDirectoryManager getDirectoryManager()

createDirectoryManager

@Nonnull
protected FDBDirectoryManager createDirectoryManager(@Nonnull
 IndexMaintainerState state)

shouldUseQueueAsync

public CompletableFuture<Boolean> shouldUseQueueAsync(Tuple groupingKey,
 @Nullable
 Integer partitionId)

getIndexScrubbingTools

@Nullable
public IndexScrubbingTools<?> getIndexScrubbingTools(IndexScrubbingTools.ScrubbingType type)

Overrides:

getIndexScrubbingTools in class IndexMaintainer