Package com.apple.foundationdb.record.lucene

Class LuceneGetMetadataInfo

java.lang.Object

com.apple.foundationdb.record.provider.foundationdb.IndexOperation

com.apple.foundationdb.record.lucene.LuceneGetMetadataInfo

@API(INTERNAL)
public class LuceneGetMetadataInfo
extends IndexOperation

Get metadata information about a given lucene index.

This is currently intended to be used for debugging purposes.

Constructor Summary

Constructors

Constructor	Description
LuceneGetMetadataInfo(Tuple groupingKey, Integer partitionId, boolean justPartitionInfo)	Create a new operation to get metadata about the lucene index.

Method Summary

Modifier and Type	Method	Description
Tuple	getGroupingKey()	The grouping key to inspect.
Integer	getPartitionId()	The partition id to inpsect.
boolean	isJustPartitionInfo()	Just fetch the partition info, and not the information for each partition.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

LuceneGetMetadataInfo

public LuceneGetMetadataInfo(@Nonnull
 Tuple groupingKey,
 @Nullable
 Integer partitionId,
 boolean justPartitionInfo)

Create a new operation to get metadata about the lucene index.

The parameters can be used to limit the scope of information gathered so that it can fit in a single transaction.

Parameters:

groupingKey - the grouping key, or an empty Tuple if this index is not grouped

partitionId - if null, this will return information for all partitions, otherwise just the given partition

justPartitionInfo - if true then only the partition info will be fetched, otherwise information from lucene itself will be fetched

Method Details

getGroupingKey

@Nonnull
public Tuple getGroupingKey()

The grouping key to inspect.

Returns:

the grouping key or an empty Tuple if this index is not grouped

getPartitionId

@Nullable
public Integer getPartitionId()

The partition id to inpsect.

Returns:

the partition id to inspect or null to inspect all partitions.

isJustPartitionInfo

public boolean isJustPartitionInfo()

Just fetch the partition info, and not the information for each partition.

Returns:

if true only the partition info will be fetched, otherwise it will fetch the information for the lucene indexes

toString

public String toString()

Overrides:

toString in class Object