Package org.elasticsearch.common.lucene
Class Lucene
org.elasticsearch.common.lucene.Lucene
public class Lucene
extends
-
Field Summary
Modifier and TypeFieldDescriptionstatic org.apache.lucene.search.ScoreDoc[]
static org.apache.lucene.search.TopDocs
static NamedAnalyzer
static
static
static NamedAnalyzer
static NamedAnalyzer
-
Method Summary
Modifier and TypeMethodDescriptionstatic org.apache.lucene.util.Bits
asSequentialAccessBits(int maxDoc, org.apache.lucene.search.ScorerSupplier scorerSupplier)
Return aBits
view of the provided scorer.static org.apache.lucene.util.Bits
asSequentialAccessBits(int maxDoc, org.apache.lucene.search.ScorerSupplier scorerSupplier, long estimatedGetCount)
Given aScorerSupplier
, return aBits
instance that will match all documents contained in the set.static boolean
canEarlyTerminate(org.apache.lucene.search.Sort searchSort, org.apache.lucene.search.Sort indexSort)
Whether a query sorted bysearchSort
can be early-terminated if the index is sorted byindexSort
.static void
checkSegmentInfoIntegrity(org.apache.lucene.store.Directory directory)
static void
cleanLuceneIndex(org.apache.lucene.store.Directory directory)
This method removes all lucene files from the given directory.static org.apache.lucene.index.LeafReader
emptyReader(int maxDoc)
Returns an empty leaf reader with the given max docs.static boolean
exists(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.Query query)
Check whether there is one or more documents matching the provided query.static <>
files(org.apache.lucene.index.SegmentInfos infos)
Returns an iterable that allows to iterate over all files in this segments infostatic org.apache.lucene.index.IndexCommit
getIndexCommit(org.apache.lucene.index.SegmentInfos si, org.apache.lucene.store.Directory directory)
Returns an index commit for the givenSegmentInfos
in the given directory.static int
getNumDocs(org.apache.lucene.index.SegmentInfos info)
Returns the number of documents in the index referenced by thisSegmentInfos
static boolean
indexExists(org.apache.lucene.store.Directory directory)
static org.apache.lucene.index.IndexWriterConfig
indexWriterConfigWithNoMerging(org.apache.lucene.analysis.Analyzer analyzer)
Prepares a newIndexWriterConfig
that does not do any merges, by setting both the merge policy and the merge scheduler.static boolean
t)
Returnstrue
iff the given exception or one of it's causes is an instance ofCorruptIndexException
,IndexFormatTooOldException
, orIndexFormatTooNewException
otherwisefalse
.static org.apache.lucene.document.NumericDocValuesField
Returns a numeric docvalues which can be used to soft-delete documents.static org.apache.lucene.util.Version
version, org.apache.lucene.util.Version defaultVersion, org.apache.logging.log4j.Logger logger)
static org.apache.lucene.util.Version
toParse, org.apache.lucene.util.Version defaultValue)
Parses the version string lenient and returns the default value if the given string is null or emptystatic org.apache.lucene.index.SegmentInfos
segmentsFileName, org.apache.lucene.store.Directory directory)
This method removes all files from the given directory that are not referenced by the given segments file.static org.apache.lucene.search.Explanation
static org.apache.lucene.search.FieldDoc
readFieldDoc(StreamInput in)
static org.apache.lucene.search.ScoreDoc
readScoreDoc(StreamInput in)
static org.apache.lucene.index.SegmentInfos
readSegmentInfos(org.apache.lucene.index.IndexCommit commit)
Reads the segments infos from the given commit, failing if it fails to loadstatic org.apache.lucene.index.SegmentInfos
readSegmentInfos(org.apache.lucene.store.Directory directory)
Reads the segments infos, failing if it fails to loadstatic org.apache.lucene.search.SortField
readSortField(StreamInput in)
static org.apache.lucene.search.SortField.Type
readSortType(StreamInput in)
static
readSortValue(StreamInput in)
static TopDocsAndMaxScore
readTopDocs(StreamInput in)
static org.apache.lucene.search.TotalHits
readTotalHits(StreamInput in)
static org.apache.lucene.index.SegmentReader
segmentReader(org.apache.lucene.index.LeafReader reader)
Tries to extract a segment reader from the given index reader.static boolean
waitForIndex(org.apache.lucene.store.Directory directory, long timeLimitMillis)
Wait for an index to exist for up totimeLimitMillis
.static org.apache.lucene.index.DirectoryReader
wrapAllDocsLive(org.apache.lucene.index.DirectoryReader in)
Wraps a directory reader to make all documents live except those were rolled back or hard-deleted due to non-aborting exceptions during indexing.static void
writeExplanation(StreamOutput out, org.apache.lucene.search.Explanation explanation)
static void
writeFieldDoc(StreamOutput out, org.apache.lucene.search.FieldDoc fieldDoc)
static void
writeScoreDoc(StreamOutput out, org.apache.lucene.search.ScoreDoc scoreDoc)
static void
writeSortField(StreamOutput out, org.apache.lucene.search.SortField sortField)
static void
writeSortType(StreamOutput out, org.apache.lucene.search.SortField.Type sortType)
static void
writeSortValue(StreamOutput out, field)
static void
writeTopDocs(StreamOutput out, TopDocsAndMaxScore topDocs)
static void
writeTotalHits(StreamOutput out, org.apache.lucene.search.TotalHits totalHits)
Methods inherited from class java.lang.
, , , , , , , , , ,
-
Field Details
-
LATEST_CODEC
public static final LATEST_CODEC- See Also:
- Constant Field Values
-
SOFT_DELETES_FIELD
public static final SOFT_DELETES_FIELD- See Also:
- Constant Field Values
-
STANDARD_ANALYZER
-
KEYWORD_ANALYZER
-
WHITESPACE_ANALYZER
-
EMPTY_SCORE_DOCS
public static final org.apache.lucene.search.ScoreDoc[] EMPTY_SCORE_DOCS -
EMPTY_TOP_DOCS
public static final org.apache.lucene.search.TopDocs EMPTY_TOP_DOCS
-
-
Method Details
-
parseVersion
public static org.apache.lucene.util.Version parseVersion(@Nullable version, org.apache.lucene.util.Version defaultVersion, org.apache.logging.log4j.Logger logger) -
readSegmentInfos
public static org.apache.lucene.index.SegmentInfos readSegmentInfos(org.apache.lucene.store.Directory directory) throwsReads the segments infos, failing if it fails to load- Throws:
-
files
public static <> files(org.apache.lucene.index.SegmentInfos infos) throwsReturns an iterable that allows to iterate over all files in this segments info- Throws:
-
getNumDocs
public static int getNumDocs(org.apache.lucene.index.SegmentInfos info)Returns the number of documents in the index referenced by thisSegmentInfos
-
readSegmentInfos
public static org.apache.lucene.index.SegmentInfos readSegmentInfos(org.apache.lucene.index.IndexCommit commit) throwsReads the segments infos from the given commit, failing if it fails to load- Throws:
-
pruneUnreferencedFiles
public static org.apache.lucene.index.SegmentInfos pruneUnreferencedFiles( segmentsFileName, org.apache.lucene.store.Directory directory) throwsThis method removes all files from the given directory that are not referenced by the given segments file. This method will open an IndexWriter and relies on index file deleter to remove all unreferenced files. Segment files that are newer than the given segments file are removed forcefully to prevent problems with IndexWriter opening a potentially broken commit point / leftover. Note: this method will fail if there is another IndexWriter open on the given directory. This method will also acquire a write lock from the directory while pruning unused files. This method expects an existing index in the given directory that has the given segments file.- Throws:
-
getIndexCommit
public static org.apache.lucene.index.IndexCommit getIndexCommit(org.apache.lucene.index.SegmentInfos si, org.apache.lucene.store.Directory directory) throwsReturns an index commit for the givenSegmentInfos
in the given directory.- Throws:
-
cleanLuceneIndex
public static void cleanLuceneIndex(org.apache.lucene.store.Directory directory) throwsThis method removes all lucene files from the given directory. It will first try to delete all commit points / segments files to ensure broken commits or corrupted indices will not be opened in the future. If any of the segment files can't be deleted this operation fails.- Throws:
-
checkSegmentInfoIntegrity
public static void checkSegmentInfoIntegrity(org.apache.lucene.store.Directory directory) throws- Throws:
-
exists
public static boolean exists(org.apache.lucene.search.IndexSearcher searcher, org.apache.lucene.search.Query query) throwsCheck whether there is one or more documents matching the provided query.- Throws:
-
readTotalHits
- Throws:
-
readTopDocs
- Throws:
-
readFieldDoc
- Throws:
-
readSortValue
- Throws:
-
readScoreDoc
- Throws:
-
writeTotalHits
public static void writeTotalHits(StreamOutput out, org.apache.lucene.search.TotalHits totalHits) throws- Throws:
-
writeTopDocs
- Throws:
-
writeSortValue
- Throws:
-
writeFieldDoc
public static void writeFieldDoc(StreamOutput out, org.apache.lucene.search.FieldDoc fieldDoc) throws- Throws:
-
writeScoreDoc
public static void writeScoreDoc(StreamOutput out, org.apache.lucene.search.ScoreDoc scoreDoc) throws- Throws:
-
readSortType
- Throws:
-
readSortField
- Throws:
-
writeSortType
public static void writeSortType(StreamOutput out, org.apache.lucene.search.SortField.Type sortType) throws- Throws:
-
writeSortField
public static void writeSortField(StreamOutput out, org.apache.lucene.search.SortField sortField) throws- Throws:
-
readExplanation
- Throws:
-
writeExplanation
public static void writeExplanation(StreamOutput out, org.apache.lucene.search.Explanation explanation) throws- Throws:
-
indexExists
public static boolean indexExists(org.apache.lucene.store.Directory directory) throws- Throws:
-
waitForIndex
public static boolean waitForIndex(org.apache.lucene.store.Directory directory, long timeLimitMillis) throwsWait for an index to exist for up totimeLimitMillis
. Returns true if the index eventually exists, false if not. Will retry the directory every second for at leasttimeLimitMillis
- Throws:
-
isCorruptionException
public static boolean isCorruptionException( t)Returnstrue
iff the given exception or one of it's causes is an instance ofCorruptIndexException
,IndexFormatTooOldException
, orIndexFormatTooNewException
otherwisefalse
. -
parseVersionLenient
public static org.apache.lucene.util.Version parseVersionLenient( toParse, org.apache.lucene.util.Version defaultValue)Parses the version string lenient and returns the default value if the given string is null or empty -
segmentReader
public static org.apache.lucene.index.SegmentReader segmentReader(org.apache.lucene.index.LeafReader reader)Tries to extract a segment reader from the given index reader. If no SegmentReader can be extracted an is thrown. -
asSequentialAccessBits
public static org.apache.lucene.util.Bits asSequentialAccessBits(int maxDoc, @Nullable org.apache.lucene.search.ScorerSupplier scorerSupplier) throwsReturn aBits
view of the provided scorer. NOTE: that the returnedBits
instance MUST be consumed in order.- Throws:
- See Also:
asSequentialAccessBits(int, ScorerSupplier, long)
-
asSequentialAccessBits
public static org.apache.lucene.util.Bits asSequentialAccessBits(int maxDoc, @Nullable org.apache.lucene.search.ScorerSupplier scorerSupplier, long estimatedGetCount) throwsGiven aScorerSupplier
, return aBits
instance that will match all documents contained in the set. NOTE: that the returnedBits
instance MUST be consumed in order.- Parameters:
estimatedGetCount
- an estimation of the number of times thatBits.get(int)
will get called- Throws:
-
canEarlyTerminate
public static boolean canEarlyTerminate(org.apache.lucene.search.Sort searchSort, org.apache.lucene.search.Sort indexSort)Whether a query sorted bysearchSort
can be early-terminated if the index is sorted byindexSort
. -
wrapAllDocsLive
public static org.apache.lucene.index.DirectoryReader wrapAllDocsLive(org.apache.lucene.index.DirectoryReader in) throwsWraps a directory reader to make all documents live except those were rolled back or hard-deleted due to non-aborting exceptions during indexing. The wrapped reader can be used to query all documents.- Parameters:
in
- the input directory reader- Returns:
- the wrapped reader
- Throws:
-
newSoftDeletesField
public static org.apache.lucene.document.NumericDocValuesField newSoftDeletesField()Returns a numeric docvalues which can be used to soft-delete documents. -
emptyReader
public static org.apache.lucene.index.LeafReader emptyReader(int maxDoc)Returns an empty leaf reader with the given max docs. The reader will be fully deleted. -
indexWriterConfigWithNoMerging
public static org.apache.lucene.index.IndexWriterConfig indexWriterConfigWithNoMerging(org.apache.lucene.analysis.Analyzer analyzer)Prepares a newIndexWriterConfig
that does not do any merges, by setting both the merge policy and the merge scheduler. Setting just the merge policy means that constructing the index writer will create aConcurrentMergeScheduler
by default, which is quite heavyweight and in particular it can unnecessarily block onIOUtils.spins(org.apache.lucene.store.Directory)
.
-