org.neo4j.kernel.api.impl.schema

Interface SchemaIndex

All Superinterfaces:

AutoCloseable, Closeable, DatabaseIndex

All Known Implementing Classes:

ReadOnlyDatabaseSchemaIndex, WritableDatabaseSchemaIndex

public interface SchemaIndex
extends DatabaseIndex

Partitioned lucene schema index.

Method Summary

Modifier and Type	Method and Description
org.neo4j.kernel.api.schema.index.IndexDescriptor	getDescriptor()
org.neo4j.storageengine.api.schema.IndexReader	getIndexReader()
LuceneIndexWriter	getIndexWriter()
boolean	isOnline() Check if this index is marked as online.
void	markAsFailed(String failure) Writes the given failure message to the failure storage.
void	markAsOnline() Marks index as online by including "status" -> "online" map into commit metadata of the first partition.
void	verifyUniqueness(org.neo4j.kernel.api.index.PropertyAccessor accessor, int[] propertyKeyIds) Verifies uniqueness of property values present in this index.
void	verifyUniqueness(org.neo4j.kernel.api.index.PropertyAccessor accessor, int[] propertyKeyIds, List<org.neo4j.values.storable.Value[]> updatedValueTuples) Verifies uniqueness of updated property values.

Methods inherited from interface org.neo4j.kernel.api.impl.index.DatabaseIndex

allDocumentsReader, create, drop, exists, flush, getPartitions, isOpen, isReadOnly, isValid, maybeRefreshBlocking, open, snapshot

Methods inherited from interface java.io.Closeable

close

Method Detail

getIndexWriter

LuceneIndexWriter getIndexWriter()
                          throws IOException

Throws:

IOException

getIndexReader

org.neo4j.storageengine.api.schema.IndexReader getIndexReader()
                                                       throws IOException

Throws:

IOException

getDescriptor

org.neo4j.kernel.api.schema.index.IndexDescriptor getDescriptor()

verifyUniqueness

void verifyUniqueness(org.neo4j.kernel.api.index.PropertyAccessor accessor,
                      int[] propertyKeyIds)
               throws IOException,
                      org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException

Verifies uniqueness of property values present in this index.

Parameters:

accessor - the accessor to retrieve actual property values from the store.

propertyKeyIds - the ids of the properties to verify.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException - if there are duplicates.

IOException

See Also:

UniquenessVerifier.verify(PropertyAccessor, int[])

verifyUniqueness

void verifyUniqueness(org.neo4j.kernel.api.index.PropertyAccessor accessor,
                      int[] propertyKeyIds,
                      List<org.neo4j.values.storable.Value[]> updatedValueTuples)
               throws IOException,
                      org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException

Verifies uniqueness of updated property values.

Parameters:

accessor - the accessor to retrieve actual property values from the store.

propertyKeyIds - the ids of the properties to verify.

updatedValueTuples - the values to check uniqueness for.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException - if there are duplicates.

IOException

See Also:

UniquenessVerifier.verify(PropertyAccessor, int[], List)

isOnline

boolean isOnline()
          throws IOException

Check if this index is marked as online.

Returns:

true if index is online, false otherwise

Throws:

IOException

markAsOnline

void markAsOnline()
           throws IOException

Marks index as online by including "status" -> "online" map into commit metadata of the first partition.

Throws:

IOException

markAsFailed

void markAsFailed(String failure)
           throws IOException

Writes the given failure message to the failure storage.

Parameters:

failure - the failure message.

Throws:

IOException