org.neo4j.kernel.api.impl.index.partition

Class IndexPartition

java.lang.Object

org.neo4j.kernel.api.impl.index.partition.IndexPartition

All Implemented Interfaces:

Closeable, AutoCloseable

public class IndexPartition
extends Object
implements Closeable

Represents a single partition of a partitioned lucene index. Each partition is a separate Lucene index. Contains and manages lifecycle of the corresponding Directory, writer and SearcherManager.

Constructor Summary

Constructors

Constructor and Description
IndexPartition(File partitionFolder, org.apache.lucene.store.Directory directory, org.apache.lucene.index.IndexWriterConfig writerConfig)

Method Summary

Modifier and Type	Method and Description
PartitionSearcher	acquireSearcher() Return searcher for requested partition.
void	close()
org.apache.lucene.store.Directory	getDirectory()
org.apache.lucene.index.IndexWriter	getIndexWriter()
void	maybeRefreshBlocking() Refresh partition to make newly inserted data visible for readers.
org.neo4j.graphdb.ResourceIterator<File>	snapshot() Retrieve list of consistent Lucene index files for this partition.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexPartition

public IndexPartition(File partitionFolder,
                      org.apache.lucene.store.Directory directory,
                      org.apache.lucene.index.IndexWriterConfig writerConfig)
               throws IOException

Throws:

IOException

Method Detail

getIndexWriter

public org.apache.lucene.index.IndexWriter getIndexWriter()

getDirectory

public org.apache.lucene.store.Directory getDirectory()

acquireSearcher

public PartitionSearcher acquireSearcher()
                                  throws IOException

Return searcher for requested partition. There is no tracking of acquired searchers, so the expectation is that callers will call close on acquired searchers to release resources.

Returns:

partition searcher

Throws:

IOException - if exception happened during searcher acquisition

maybeRefreshBlocking

public void maybeRefreshBlocking()
                          throws IOException

Refresh partition to make newly inserted data visible for readers.

Throws:

IOException - if refreshing fails.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

snapshot

public org.neo4j.graphdb.ResourceIterator<File> snapshot()
                                                  throws IOException

Retrieve list of consistent Lucene index files for this partition.

Returns:

the iterator over index files.

Throws:

IOException - if any IO operation fails.