org.neo4j.backup.check
Class ConsistencyCheck

java.lang.Object
  org.neo4j.kernel.impl.nioneo.store.RecordStore.Processor
      org.neo4j.backup.check.ConsistencyCheck

All Implemented Interfaces:

Iterable<RecordStore<?>>, Runnable

public abstract class ConsistencyCheck
extends RecordStore.Processor
implements Runnable, Iterable<RecordStore<?>>

Finds inconsistency in a Neo4j store. Warning: will not find "dangling" records, i.e. records that are correct but not referenced. Warning: will only find multiple references to the same property chain or dynamic record chain for incremental checks (if the stores are diff stores). Also, this checking is very incomplete.

Constructor Summary

ConsistencyCheck(StoreAccess stores)
Creates a standard checker.

ConsistencyCheck(StoreAccess stores, boolean checkPropertyOwners)
Creates a standard checker or a checker that validates property owners.

Method Summary

void	checkResult() Check if any inconsistencies was found by the checker.
Iterator<RecordStore<?>>	iterator()
static void	main(String... args) Run a full consistency check on the specified store.
void	processArray(RecordStore<DynamicRecord> store, DynamicRecord array)
void	processNode(RecordStore<NodeRecord> store, NodeRecord node)
void	processProperty(RecordStore<PropertyRecord> store, PropertyRecord property)
void	processPropertyIndex(RecordStore<PropertyIndexRecord> store, PropertyIndexRecord index)
void	processRelationship(RecordStore<RelationshipRecord> store, RelationshipRecord rel)
void	processRelationshipType(RecordStore<RelationshipTypeRecord> store, RelationshipTypeRecord type)
void	processString(RecordStore<DynamicRecord> store, DynamicRecord string)
protected abstract <R extends AbstractBaseRecord> void	report(RecordStore<R> recordStore, R record, InconsistencyType inconsistency) Report an internal inconsistency in a single record.
protected abstract <R1 extends AbstractBaseRecord,R2 extends AbstractBaseRecord> void	report(RecordStore<R1> recordStore, R1 record, RecordStore<? extends R2> referredStore, R2 referred, InconsistencyType inconsistency) Report an inconsistency between two records.
void	run()
static void	run(StoreAccess stores, boolean propowner)

Methods inherited from class org.neo4j.kernel.impl.nioneo.store.RecordStore.Processor

applyById, applyFiltered, applyFiltered, processDynamic, processRecord, progressInit, scan, scanById

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsistencyCheck

public ConsistencyCheck(StoreAccess stores)

Creates a standard checker.

Parameters:

stores - the stores to check.

ConsistencyCheck

public ConsistencyCheck(StoreAccess stores,
                        boolean checkPropertyOwners)

Creates a standard checker or a checker that validates property owners. Property ownership validation validates that each property record is only referenced once. This check has a bit of memory overhead.

Parameters:

stores - the stores to check.

checkPropertyOwners - if true ownership validation will be performed.

Method Detail

main

public static void main(String... args)

Run a full consistency check on the specified store.

Parameters:

args - The arguments to the checker, the first is taken as the path to the store to check.

run

public static void run(StoreAccess stores,
                       boolean propowner)

iterator

public Iterator<RecordStore<?>> iterator()

Specified by:

iterator in interface Iterable<RecordStore<?>>

run

public void run()

Specified by:

run in interface Runnable

checkResult

public void checkResult()
                 throws AssertionError

Check if any inconsistencies was found by the checker. This method should be invoked at the end of the check. If inconsistencies were found an AssertionError summarizing the number of inconsistencies will be thrown.

Throws:

AssertionError - if any inconsistencies were found.

processNode

public void processNode(RecordStore<NodeRecord> store,
                        NodeRecord node)

Overrides:

processNode in class RecordStore.Processor

processRelationship

public void processRelationship(RecordStore<RelationshipRecord> store,
                                RelationshipRecord rel)

Overrides:

processRelationship in class RecordStore.Processor

processProperty

public void processProperty(RecordStore<PropertyRecord> store,
                            PropertyRecord property)

Overrides:

processProperty in class RecordStore.Processor

processString

public void processString(RecordStore<DynamicRecord> store,
                          DynamicRecord string)

Overrides:

processString in class RecordStore.Processor

processArray

public void processArray(RecordStore<DynamicRecord> store,
                         DynamicRecord array)

Overrides:

processArray in class RecordStore.Processor

processRelationshipType

public void processRelationshipType(RecordStore<RelationshipTypeRecord> store,
                                    RelationshipTypeRecord type)

Overrides:

processRelationshipType in class RecordStore.Processor

processPropertyIndex

public void processPropertyIndex(RecordStore<PropertyIndexRecord> store,
                                 PropertyIndexRecord index)

Overrides:

processPropertyIndex in class RecordStore.Processor

report

protected abstract <R1 extends AbstractBaseRecord,R2 extends AbstractBaseRecord> void report(RecordStore<R1> recordStore,
                                                                                             R1 record,
                                                                                             RecordStore<? extends R2> referredStore,
                                                                                             R2 referred,
                                                                                             InconsistencyType inconsistency)

Report an inconsistency between two records.

Parameters:

recordStore - the store containing the record found to be inconsistent.

record - the record found to be inconsistent.

referredStore - the store containing the record the inconsistent record references.

referred - the record the inconsistent record references.

inconsistency - a description of the inconsistency.

report

protected abstract <R extends AbstractBaseRecord> void report(RecordStore<R> recordStore,
                                                              R record,
                                                              InconsistencyType inconsistency)

Report an internal inconsistency in a single record.

Parameters:

recordStore - the store the inconsistent record is stored in.

record - the inconsistent record.

inconsistency - a description of the inconsistency.