Package com.atlassian.jira.issue.index

Class IndexConsistencyUtils

java.lang.Object

com.atlassian.jira.issue.index.IndexConsistencyUtils

public class IndexConsistencyUtils
extends Object

Utility methods related to performing consistency checks on indexes.

Since:

v5.2

Method Summary

Modifier and Type	Method	Description
static int	getIndexConsistencyTolerancePercentage()
static boolean	isIndexConsistent(String name, int expectedCount, int actualCount)	Performs a simple consistency check by comparing the actual document count to an expected value.

Methods inherited from class java.lang.Object

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

Method Details

isIndexConsistent

public static boolean isIndexConsistent(String name,
 int expectedCount,
 int actualCount)

Performs a simple consistency check by comparing the actual document count to an expected value. If the expected document count cannot be determined reliably and efficiently, then -1 may be specified to skip that part of the check. If an expected count is given, the actual count must be within the allowed tolerance defined as a percentage of the expected value (set by INDEX_CONSISTENCY_TOLERANCE_PERCENTAGE_SYSTEM_PROPERTY, default INDEX_CONSISTENCY_TOLERANCE_PERCENTAGE_DEFAULT_VALUE) or MINIMUM_ABSOLUTE_TOLERANCE documents, whichever value is larger.

Parameters:

name - a name to identify the index

expectedCount - the expected count of documents in the index, or -1 to skip this check

actualCount - the actual count of documents in the index

Returns:

true if the actual count is reasonably close to the expected number of documents; false if the index document count is excessively different from the expected count

getIndexConsistencyTolerancePercentage

public static int getIndexConsistencyTolerancePercentage()