Package org.apache.jackrabbit.oak.plugins.index.lucene

Interface LuceneIndexMBean

All Superinterfaces:

org.apache.jackrabbit.oak.plugins.index.search.IndexMBean

All Known Implementing Classes:

LuceneIndexMBeanImpl

public interface LuceneIndexMBean
extends org.apache.jackrabbit.oak.plugins.index.search.IndexMBean

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Method Summary

Modifier and Type	Method	Description
String[]	checkAndReportConsistencyOfAllIndexes(boolean fullCheck)
String	checkConsistency(String indexPath, boolean fullCheck)
boolean	checkConsistencyOfAllIndexes(boolean fullCheck)
String	diffStoredIndexDefinition(String indexPath)
TabularData	getBadIndexStats()
TabularData	getBadPersistedIndexStats()
String[]	getFieldInfo(String indexPath)
String[]	getFieldTermInfo(String indexPath, String field, String term)
String[]	getFieldTermsInfo(String indexPath, String field, int max)
String[]	getFieldTermsInfo(String indexPath, String field, String fieldType, int max)
String	getHybridIndexInfo(String indexPath)
String[]	getIndexedPaths(String indexPath, int maxLevel, int maxPathCount)
String	getStoredIndexDefinition(String indexPath)
boolean	isFailing()
String	performPropertyIndexCleanup()
String	performPropertyIndexCleanup(String paths, int batchSize, int sleepPerBatch, int maxRemoveCount)

Methods inherited from interface org.apache.jackrabbit.oak.plugins.index.search.IndexMBean

getDocCount, getIndexStats, getSize

Field Details

TYPE

static final String TYPE

See Also:

• Constant Field Values

Method Details

getBadIndexStats

TabularData getBadIndexStats()

getBadPersistedIndexStats

TabularData getBadPersistedIndexStats()

isFailing

boolean isFailing()

getIndexedPaths

@Description("Determines the set of index paths up to given maxLevel. This can be used to determine the value for[includedPaths]. For this to work you should have [evaluatePathRestrictions] set to true in your index definition")
String[] getIndexedPaths(@Description("Index path for which stats are to be determined") @Name("indexPath")
 String indexPath,
 @Name("maxLevel") @Description("Maximum depth to examine. E.g. 5. Stats calculation would break out after this limit")
 int maxLevel,
 @Description("Maximum number of unique paths to examine. E.g. 100. Stats calculation would break out after this limit") @Name("maxPathCount")
 int maxPathCount)
                  throws IOException

Throws:

IOException

getFieldInfo

@Description("Retrieves the fields, and number of documents for each field, for an index. This allows to investigate what is stored in the index.")
String[] getFieldInfo(@Name("indexPath") @Description("The index path (empty for all indexes)")
 String indexPath)
               throws IOException

Throws:

IOException

getFieldTermsInfo

@Description("Retrieves the terms, and number of documents for each term, for an index. This allows to closely investigate what is stored in the index.")
String[] getFieldTermsInfo(@Name("indexPath") @Description("The index path (empty for all indexes)")
 String indexPath,
 @Name("field") @Description("The field name (empty for all fields)")
 String field,
 @Name("max") @Description("The maximum number of entries to return (e.g. 100)")
 int max)
                    throws IOException

Throws:

IOException

getFieldTermsInfo

@Description("Retrieves the terms, and number of documents for each term, for an index. This allows to closely investigate what is stored in the index.")
String[] getFieldTermsInfo(@Name("indexPath") @Description("The index path (empty for all indexes)")
 String indexPath,
 @Name("field") @Description("The field name (empty for all fields)")
 String field,
 @Name("fieldType") @Description("The type of the field (empty for string)")
 String fieldType,
 @Name("max") @Description("The maximum number of entries to return (e.g. 100)")
 int max)
                    throws IOException

Throws:

IOException

getFieldTermInfo

@Description("Retrieves the number of documents for a specific term, for an index. This allows to closely investigate what is stored in the index.")
String[] getFieldTermInfo(@Name("indexPath") @Description("The index path (empty for all indexes)")
 String indexPath,
 @Name("field") @Description("The field name (empty for all fields)")
 String field,
 @Name("term") @Description("The term")
 String term)
                   throws IOException

Throws:

IOException

getStoredIndexDefinition

@Description("Returns the stored index definition for index at given path in string form")
String getStoredIndexDefinition(@Name("indexPath")
 String indexPath)

diffStoredIndexDefinition

@Description("Returns the diff of index definition for index at given path from the stored index definition in string form")
String diffStoredIndexDefinition(@Name("indexPath")
 String indexPath)

checkConsistency

@Description("Performs consistency check on given index")
String checkConsistency(@Name("indexPath")
 String indexPath,
 @Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
 boolean fullCheck)
                 throws IOException

Throws:

IOException

checkAndReportConsistencyOfAllIndexes

@Description("Performs consistency check for all Lucene indexes and reports in simple format")
String[] checkAndReportConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
 boolean fullCheck)
                                        throws IOException

Throws:

IOException

checkConsistencyOfAllIndexes

@Description("Performs consistency check for all Lucene indexes and reports true if all indexes are found to be valid. False if any one of them was not found to be valid")
boolean checkConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as it reads all index files. If set to false a quick check is performed to check if all blobs referred in index files are present in BlobStore")
 boolean fullCheck)
                              throws IOException

Throws:

IOException

performPropertyIndexCleanup

@Description("Performs any possible cleanup of the hybrid property indexes")
String performPropertyIndexCleanup()
                            throws CommitFailedException

Throws:

CommitFailedException

performPropertyIndexCleanup

@Description("Performs cleanup of property indexes")
String performPropertyIndexCleanup(@Name("paths") @Description("The list of paths (comma separated). Must be hidden nodes")
 String paths,
 @Name("batchSize") @Description("The batch size, e.g. 1024")
 int batchSize,
 @Name("sleepPerBatch") @Description("The number of milliseconds to sleep per batch")
 int sleepPerBatch,
 @Name("maxRemoveCount") @Description("The maximum number of nodes to remove per path, e.g. 1000000")
 int maxRemoveCount)
                            throws CommitFailedException

Throws:

CommitFailedException

getHybridIndexInfo

@Description("Fetches hybrid property index info as json for index at given path")
String getHybridIndexInfo(@Name("indexPath")
 String indexPath)