Uses of Class
org.apache.lucene.store.Directory
Package
Description
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.0 file format.
Lucene 9.0 compressing format.
Code to maintain and access indices.
Code to search indices.
Binary i/o API, used for all index data.
Some utility classes.
Block KD-tree, implementing the generic spatial data structure described in this paper.
-
Uses of Directory in org.apache.lucene.codecs
Modifier and TypeClassDescriptionclass
A read-onlyDirectory
that consists of a view over a compound file.Modifier and TypeMethodDescriptionabstract StoredFieldsReader
StoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Returns aStoredFieldsReader
to load stored fields.abstract StoredFieldsWriter
StoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) Returns aStoredFieldsWriter
to write stored fields.abstract CompoundDirectory
CompoundFormat.getCompoundReader
(Directory dir, SegmentInfo si, IOContext context) Returns a Directory view (read-only) for the compound files in this segmentabstract FieldInfos
FieldInfosFormat.read
(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext iocontext) abstract SegmentInfo
SegmentInfoFormat.read
(Directory directory, String segmentName, byte[] segmentID, IOContext context) ReadSegmentInfo
data from a directory.abstract Bits
LiveDocsFormat.readLiveDocs
(Directory dir, SegmentCommitInfo info, IOContext context) Read live docs bits.abstract TermVectorsReader
TermVectorsFormat.vectorsReader
(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) Returns aTermVectorsReader
to read term vectors.abstract TermVectorsWriter
TermVectorsFormat.vectorsWriter
(Directory directory, SegmentInfo segmentInfo, IOContext context) Returns aTermVectorsWriter
to write term vectors.abstract void
CompoundFormat.write
(Directory dir, SegmentInfo si, IOContext context) Packs the provided segment's files into a compound format.abstract void
FieldInfosFormat.write
(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) Writes the providedFieldInfos
to the directory.abstract void
SegmentInfoFormat.write
(Directory dir, SegmentInfo info, IOContext ioContext) WriteSegmentInfo
data.abstract void
LiveDocsFormat.writeLiveDocs
(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Persist live docs bits. -
Uses of Directory in org.apache.lucene.codecs.lucene90
Modifier and TypeMethodDescriptionLucene90StoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene90StoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) Lucene90CompoundFormat.getCompoundReader
(Directory dir, SegmentInfo si, IOContext context) Lucene90FieldInfosFormat.read
(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, IOContext context) Lucene90LiveDocsFormat.readLiveDocs
(Directory dir, SegmentCommitInfo info, IOContext context) void
Lucene90CompoundFormat.write
(Directory dir, SegmentInfo si, IOContext context) void
Lucene90FieldInfosFormat.write
(Directory directory, SegmentInfo segmentInfo, String segmentSuffix, FieldInfos infos, IOContext context) void
Lucene90SegmentInfoFormat.write
(Directory dir, SegmentInfo si, IOContext ioContext) void
Lucene90LiveDocsFormat.writeLiveDocs
(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) -
Uses of Directory in org.apache.lucene.codecs.lucene90.compressing
Modifier and TypeMethodDescriptionLucene90CompressingStoredFieldsFormat.fieldsReader
(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) Lucene90CompressingStoredFieldsFormat.fieldsWriter
(Directory directory, SegmentInfo si, IOContext context) final TermVectorsReader
Lucene90CompressingTermVectorsFormat.vectorsReader
(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) final TermVectorsWriter
Lucene90CompressingTermVectorsFormat.vectorsWriter
(Directory directory, SegmentInfo segmentInfo, IOContext context) ModifierConstructorDescriptionLucene90CompressingStoredFieldsReader
(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor.Lucene90CompressingTermVectorsReader
(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode) Sole constructor. -
Uses of Directory in org.apache.lucene.index
Modifier and TypeFieldDescriptionCheckIndex.Status.dir
Directory index is in.final Directory
SegmentInfo.dir
Where this segment resides.protected final Directory
DirectoryReader.directory
The index directory.final Directory
SegmentReadState.directory
Directory
where this segment is read from.final Directory
SegmentWriteState.directory
Directory
where this segment will be written to.Modifier and TypeMethodDescriptionfinal Directory
DirectoryReader.directory()
Returns the directory this index resides in.SegmentReader.directory()
Returns the directory this index resides in.abstract Directory
IndexCommit.getDirectory()
Returns theDirectory
for the index.IndexWriter.getDirectory()
Returns the Directory used by this index.ConcurrentMergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) MergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) Wraps the incomingDirectory
so that we can merge-throttle it usingRateLimitedIndexOutput
.NoMergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) Modifier and TypeMethodDescriptionlong
IndexWriter.addIndexes
(Directory... dirs) Adds all segments from an array of indexes into this index.final void
Writes and syncs to the Directory dir, taking care to remove the segments file on exceptionstatic long
SegmentInfos.getLastCommitGeneration
(Directory directory) Get the generation of the most recent commit to the index in this directory (N in the segments_N file).static String
SegmentInfos.getLastCommitSegmentsFileName
(Directory directory) Get the filename of the segments_N file for the most recent commit to the index in this Directory.static boolean
DirectoryReader.indexExists
(Directory directory) Returnstrue
if an index likely exists at the specified directory.static List<IndexCommit>
DirectoryReader.listCommits
(Directory dir) Returns all commit points that exist in the Directory.static DirectoryReader
Returns a IndexReader reading the index in the given Directorystatic DirectoryReader
DirectoryReader.open
(Directory directory, Comparator<LeafReader> leafSorter) Returns a IndexReader for the the index in the given Directorystatic DirectoryReader
StandardDirectoryReader.open
(Directory directory, SegmentInfos infos, List<? extends LeafReader> oldReaders, Comparator<LeafReader> leafSorter) This constructor is only used forStandardDirectoryReader.doOpenIfChanged(SegmentInfos)
, as well as NRT replication.static final SegmentInfos
SegmentInfos.readCommit
(Directory directory, String segmentFileName) Read a particular segmentFileName.static final SegmentInfos
SegmentInfos.readCommit
(Directory directory, ChecksumIndexInput input, long generation) Read the commit from the providedChecksumIndexInput
.static final SegmentInfos
SegmentInfos.readLatestCommit
(Directory directory) Find the latest commit (segments_N file
) and load allSegmentCommitInfo
s.Returns a description of the merges in this specification.ConcurrentMergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) MergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) Wraps the incomingDirectory
so that we can merge-throttle it usingRateLimitedIndexOutput
.NoMergeScheduler.wrapForMerge
(MergePolicy.OneMerge merge, Directory in) ModifierConstructorDescriptionCheckIndex
(Directory dir) Create a new CheckIndex on the directory.CheckIndex
(Directory dir, Lock writeLock) Expert: create a directory with the specified lock.protected
DirectoryReader
(Directory directory, LeafReader[] segmentReaders, Comparator<LeafReader> leafSorter) Expert: Constructs aDirectoryReader
on the given subReaders.protected
FindSegmentsFile
(Directory directory) Sole constructor.IndexUpgrader
(Directory dir) Creates index upgrader on the given directory, using anIndexWriter
using the givenmatchVersion
.IndexUpgrader
(Directory dir, IndexWriterConfig iwc, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriter
using the given config.IndexUpgrader
(Directory dir, InfoStream infoStream, boolean deletePriorCommits) Creates index upgrader on the given directory, using anIndexWriter
using the givenmatchVersion
.IndexWriter
(Directory d, IndexWriterConfig conf) Constructs a new IndexWriter per the settings given inconf
.PersistentSnapshotDeletionPolicy
(IndexDeletionPolicy primary, Directory dir) PersistentSnapshotDeletionPolicy
wraps anotherIndexDeletionPolicy
to enable flexible snapshotting, passingIndexWriterConfig.OpenMode.CREATE_OR_APPEND
by default.PersistentSnapshotDeletionPolicy
(IndexDeletionPolicy primary, Directory dir, IndexWriterConfig.OpenMode mode) PersistentSnapshotDeletionPolicy
wraps anotherIndexDeletionPolicy
to enable flexible snapshotting.ReaderManager
(Directory dir) Creates and returns a new ReaderManager from the givenDirectory
.SegmentInfo
(Directory dir, Version version, Version minVersion, String name, int maxDoc, boolean isCompoundFile, Codec codec, Map<String, String> diagnostics, byte[] id, Map<String, String> attributes, Sort indexSort) Construct a new complete SegmentInfo instance from input.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context) Create aSegmentReadState
.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, String segmentSuffix) Create aSegmentReadState
.SegmentWriteState
(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context) Sole constructor.SegmentWriteState
(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix) Constructor which takes segment suffix. -
Uses of Directory in org.apache.lucene.search
ModifierConstructorDescriptionSearcherManager
(Directory dir, SearcherFactory searcherFactory) Creates and returns a new SearcherManager from the givenDirectory
. -
Uses of Directory in org.apache.lucene.store
Modifier and TypeClassDescriptionclass
Base implementation for a concreteDirectory
that uses aLockFactory
for locking.final class
AByteBuffer
-basedDirectory
implementation that can be used to store index files on the heap.class
Expert: A Directory instance that switches files between two other Directory instances.class
Directory implementation that delegates calls to another directory.class
Base class for Directory implementations that store index files in the file system.final class
This class makes a best-effort check that a providedLock
is valid before any destructive filesystem operation.class
File-basedDirectory
implementation that uses mmap for reading, andFSDirectory.FSIndexOutput
for writing.class
AnFSDirectory
implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.class
Wraps a RAM-resident directory around any provided delegate directory, to be used during NRT search.final class
Directory that wraps another, and that sleeps and retries if obtaining the lock fails.final class
A delegating Directory that records which files were written to and deleted.Modifier and TypeMethodDescriptionfinal Directory
FilterDirectory.getDelegate()
Return the wrappedDirectory
.FileSwitchDirectory.getPrimaryDir()
Return the primary directoryFileSwitchDirectory.getSecondaryDir()
Return the secondary directorystatic Directory
Get the wrapped instance bydir
as long as this reader is an instance ofFilterDirectory
.Modifier and TypeMethodDescriptionvoid
Copies an existingsrc
file from directoryfrom
to a non-existent filedest
in this directory.void
void
final Lock
FSLockFactory.obtainLock
(Directory dir, String lockName) abstract Lock
LockFactory.obtainLock
(Directory dir, String lockName) Return a new obtained Lock instance identified by lockName.NoLockFactory.obtainLock
(Directory dir, String lockName) SingleInstanceLockFactory.obtainLock
(Directory dir, String lockName) VerifyingLockFactory.obtainLock
(Directory dir, String lockName) static Directory
Get the wrapped instance bydir
as long as this reader is an instance ofFilterDirectory
.ModifierConstructorDescriptionFileSwitchDirectory
(Set<String> primaryExtensions, Directory primaryDir, Directory secondaryDir, boolean doClose) protected
Sole constructor, typically called from sub-classes.LockValidatingDirectoryWrapper
(Directory in, Lock writeLock) NRTCachingDirectory
(Directory delegate, double maxMergeSizeMB, double maxCachedMB) We will cache a newly created output if 1) it's a flush or a merge and the estimated size of the merged segment is<= maxMergeSizeMB
, and 2) the total cached bytes is<= maxCachedMB
SleepingLockWrapper
(Directory delegate, long lockWaitTimeout) Create a new SleepingLockFactorySleepingLockWrapper
(Directory delegate, long lockWaitTimeout, long pollInterval) Create a new SleepingLockFactory -
Uses of Directory in org.apache.lucene.util
Modifier and TypeMethodDescriptionOfflineSorter.getDirectory()
Returns theDirectory
we use to create temp files.Modifier and TypeMethodDescriptionCommandLineUtil.loadDirectoryClass
(String clazzName) Loads a specific Directory implementationModifier and TypeMethodDescriptionstatic void
IOUtils.deleteFiles
(Directory dir, Collection<String> names) Deletes all given file names.static void
IOUtils.deleteFilesIgnoringExceptions
(Directory dir, String... files) static void
IOUtils.deleteFilesIgnoringExceptions
(Directory dir, Collection<String> files) Deletes all given files, suppressing all thrown IOExceptions.ModifierConstructorDescriptionOfflineSorter
(Directory dir, String tempFileNamePrefix) Defaults constructor.OfflineSorter
(Directory dir, String tempFileNamePrefix, Comparator<BytesRef> comparator) Defaults constructor with a custom comparator.OfflineSorter
(Directory dir, String tempFileNamePrefix, Comparator<BytesRef> comparator, OfflineSorter.BufferSize ramBufferSize, int maxTempfiles, int valueLength, ExecutorService exec, int maxPartitionsInRAM) All-details constructor. -
Uses of Directory in org.apache.lucene.util.bkd
ModifierConstructorDescriptionBKDRadixSelector
(BKDConfig config, int maxPointsSortInHeap, Directory tempDir, String tempFileNamePrefix) Sole constructor.BKDWriter
(int maxDoc, Directory tempDir, String tempFileNamePrefix, BKDConfig config, double maxMBSortInHeap, long totalPointCount) OfflinePointReader
(BKDConfig config, Directory tempDir, String tempFileName, long start, long length, byte[] reusableBuffer) OfflinePointWriter
(BKDConfig config, Directory tempDir, String tempFileNamePrefix, String desc, long expectedCount) Create a new writer with an unknown number of incoming points