Package com.apple.foundationdb.record.lucene.directory

Class FDBDirectoryManager

java.lang.Object

com.apple.foundationdb.record.lucene.directory.FDBDirectoryManager

All Implemented Interfaces:

AutoCloseable

@API(INTERNAL)
public class FDBDirectoryManager
extends Object
implements AutoCloseable

A transaction-scoped manager of FDBDirectory objects. For a single transaction, all FDBDirectory objects should be created through this manager. This allows for cached data (like the block cache or file list cache) for a single directory to persist across different operations (e.g., different queries) conducted in the same transaction.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Exception	exceptionAtCreation
protected final LuceneAnalyzerWrapper	writerAnalyzer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FDBDirectoryManager(IndexMaintainerState state)

Method Summary

Modifier and Type	Method	Description
void	close()
protected FDBDirectoryWrapper	createNewDirectoryWrapper(IndexMaintainerState state, Tuple key, int mergeDirectoryCount, AgilityContext agilityContext, int blockCacheMaximumSize)
LuceneAnalyzerCombinationProvider	getAnalyzerSelector()
FDBDirectory	getDirectory(Tuple groupingKey, Integer partitionId)
org.apache.lucene.index.IndexReader	getIndexReader(Tuple groupingKey, Integer partitionId)
org.apache.lucene.index.IndexWriter	getIndexWriter(Tuple groupingKey, Integer partitionId)
static FDBDirectoryManager	getManager(IndexMaintainerState state)
protected static FDBDirectoryManager	getOrCreateManager(IndexMaintainerState state, Supplier<FDBDirectoryManager> managerSupplier)
org.apache.lucene.index.DirectoryReader	getWriterReader(Tuple groupingKey, Integer partititonId)
void	invalidatePrefix(Tuple prefix)	Invalidate directories from the cache if their grouping key begins with a specified prefix.
CompletableFuture<Void>	mergeIndex(LucenePartitioner partitioner)
void	mergeIndexWithContext(Tuple groupingKey, Integer partitionId, AgilityContext agilityContext)
static CompletableFuture<Optional<Tuple>>	nextTuple(FDBRecordContext context, Subspace subspace, KeyRange range, Optional<Tuple> lastTuple, ScanProperties scanProperties, int groupingCount)

Methods inherited from class java.lang.Object

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

Field Details

writerAnalyzer

@Nonnull
protected final LuceneAnalyzerWrapper writerAnalyzer

exceptionAtCreation

@Nullable
protected final Exception exceptionAtCreation

Constructor Details

FDBDirectoryManager

protected FDBDirectoryManager(@Nonnull
 IndexMaintainerState state)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getAnalyzerSelector

@Nonnull
public LuceneAnalyzerCombinationProvider getAnalyzerSelector()

mergeIndex

public CompletableFuture<Void> mergeIndex(@Nonnull
 LucenePartitioner partitioner)

mergeIndexWithContext

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

nextTuple

public static CompletableFuture<Optional<Tuple>> nextTuple(@Nonnull
 FDBRecordContext context,
 @Nonnull
 Subspace subspace,
 @Nonnull
 KeyRange range,
 @Nonnull
 Optional<Tuple> lastTuple,
 @Nonnull
 ScanProperties scanProperties,
 int groupingCount)

invalidatePrefix

public void invalidatePrefix(@Nonnull
 Tuple prefix)

Invalidate directories from the cache if their grouping key begins with a specified prefix.

Parameters:

prefix - the prefix of grouping keys to remove from the cache

createNewDirectoryWrapper

@Nonnull
protected FDBDirectoryWrapper createNewDirectoryWrapper(IndexMaintainerState state,
 Tuple key,
 int mergeDirectoryCount,
 AgilityContext agilityContext,
 int blockCacheMaximumSize)

getDirectory

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

getIndexReader

public org.apache.lucene.index.IndexReader getIndexReader(@Nullable
 Tuple groupingKey,
 @Nullable
 Integer partitionId)
                                                   throws IOException

Throws:

IOException

getIndexWriter

@Nonnull
public org.apache.lucene.index.IndexWriter getIndexWriter(@Nullable
 Tuple groupingKey,
 @Nullable
 Integer partitionId)
                                                   throws IOException

Throws:

IOException

getWriterReader

public org.apache.lucene.index.DirectoryReader getWriterReader(@Nullable
 Tuple groupingKey,
 @Nullable
 Integer partititonId)
                                                        throws IOException

Throws:

IOException

getManager

@Nonnull
public static FDBDirectoryManager getManager(@Nonnull
 IndexMaintainerState state)

getOrCreateManager

@Nonnull
protected static FDBDirectoryManager getOrCreateManager(@Nonnull
 IndexMaintainerState state,
 Supplier<FDBDirectoryManager> managerSupplier)