org.neo4j.kernel.api.impl.index

Interface DatabaseIndex

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

LabelScanIndex, SchemaIndex

All Known Implementing Classes:

ReadOnlyAbstractDatabaseIndex, ReadOnlyDatabaseLabelScanIndex, ReadOnlyDatabaseSchemaIndex, WritableAbstractDatabaseIndex, WritableDatabaseLabelScanIndex, WritableDatabaseSchemaIndex

public interface DatabaseIndex
extends Closeable

Lucene index that may consist of one or multiple separate lucene indexes that are represented as independent partitions.

Method Summary

Modifier and Type	Method and Description
LuceneAllDocumentsReader	allDocumentsReader() Creates an iterable over all documents in all partitions.
void	create() Creates new index.
void	drop() Close index and deletes all it's partitions.
boolean	exists() Check lucene index existence within all allocated partitions.
void	flush() Commits all index partitions.
List<AbstractIndexPartition>	getPartitions() Get index partitions
boolean	isOpen() Check if index is open or not
boolean	isReadOnly() Check if index is opened in read only mode
boolean	isValid() Verify state of the index.
void	maybeRefreshBlocking() Refresh all partitions to make newly inserted data visible for readers.
void	open() Open index with all allocated partitions.
org.neo4j.graphdb.ResourceIterator<File>	snapshot() Snapshot of all file in all index partitions.

Methods inherited from interface java.io.Closeable

close

Method Detail

create

void create()
     throws IOException

Creates new index. As part of creation process index will allocate all required folders, index failure storage and will create its first partition.

Index creation do not automatically open it. To be able to use index please open it first.

Throws:

IOException

open

void open()
   throws IOException

Open index with all allocated partitions.

Throws:

IOException

isOpen

boolean isOpen()

Check if index is open or not

Returns:

true if index is open

isReadOnly

boolean isReadOnly()

Check if index is opened in read only mode

Returns:

true if index open in rad only mode

exists

boolean exists()
        throws IOException

Check lucene index existence within all allocated partitions.

Returns:

true if index exist in all partitions, false when index is empty or does not exist

Throws:

IOException

isValid

boolean isValid()

Verify state of the index. If index is already open and in use method assume that index is valid since lucene already operating with it, otherwise necessary checks perform.

Returns:

true if lucene confirm that index is in valid clean state or index is already open.

drop

void drop()
   throws IOException

Close index and deletes all it's partitions.

Throws:

IOException

flush

void flush()
    throws IOException

Commits all index partitions.

Throws:

IOException

allDocumentsReader

LuceneAllDocumentsReader allDocumentsReader()

Creates an iterable over all documents in all partitions.

Returns:

LuceneAllDocumentsReader over all documents

snapshot

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

Snapshot of all file in all index partitions.

Returns:

iterator over all index files.

Throws:

IOException

See Also:

WritableIndexSnapshotFileIterator

maybeRefreshBlocking

void maybeRefreshBlocking()
                   throws IOException

Refresh all partitions to make newly inserted data visible for readers.

Throws:

IOException

getPartitions

List<AbstractIndexPartition> getPartitions()

Get index partitions

Returns:

list of index partition