org.neo4j.kernel

Class SchemaImpl

java.lang.Object

org.neo4j.kernel.SchemaImpl

All Implemented Interfaces:

Schema

public class SchemaImpl
extends Object
implements Schema

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.graphdb.schema.Schema

Schema.IndexState

Constructor Summary

Constructors

Constructor and Description
SchemaImpl(ThreadToStatementContextBridge ctxProvider)

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitIndexesOnline(long duration, TimeUnit unit) Wait until all indices comes online
void	awaitIndexOnline(IndexDefinition index, long duration, TimeUnit unit) Wait until an index comes online
ConstraintCreator	constraintFor(Label label) Returns a ConstraintCreator where details about the constraint can be specified.
Iterable<ConstraintDefinition>	getConstraints()
Iterable<ConstraintDefinition>	getConstraints(Label label)
Iterable<IndexDefinition>	getIndexes()
Iterable<IndexDefinition>	getIndexes(Label label)
String	getIndexFailure(IndexDefinition index) If Schema.getIndexState(IndexDefinition) return Schema.IndexState.FAILED this method will return the failure description.
Schema.IndexState	getIndexState(IndexDefinition index) Poll the database for the state of a given index.
IndexCreator	indexFor(Label label) Returns an IndexCreator where details about the index to create can be specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaImpl

public SchemaImpl(ThreadToStatementContextBridge ctxProvider)

Method Detail

indexFor

public IndexCreator indexFor(Label label)

Description copied from interface: Schema

Returns an IndexCreator where details about the index to create can be specified. When all details have been entered create must be called for it to actually be created. Creating an index enables indexing for nodes with the specified label. The index will have the details supplied to the returned index creator. All existing and all future nodes matching the index definition will be indexed, speeding up future operations.

Specified by:

indexFor in interface Schema

Parameters:

label - label on nodes to be indexed

Returns:

an IndexCreator capable of providing details for, as well as creating an index for the given label.

getIndexes

public Iterable<IndexDefinition> getIndexes(Label label)

Specified by:

getIndexes in interface Schema

Parameters:

label - the Label to get indexes for.

Returns:

all indexes attached to the given label.

getIndexes

public Iterable<IndexDefinition> getIndexes()

Specified by:

getIndexes in interface Schema

Returns:

all indexes in this database.

awaitIndexOnline

public void awaitIndexOnline(IndexDefinition index,
                    long duration,
                    TimeUnit unit)

Description copied from interface: Schema

Wait until an index comes online

Specified by:

awaitIndexOnline in interface Schema

Parameters:

index - the index that we want to wait for

duration - duration to wait for the index to come online

unit - TimeUnit of duration

awaitIndexesOnline

public void awaitIndexesOnline(long duration,
                      TimeUnit unit)

Description copied from interface: Schema

Wait until all indices comes online

Specified by:

awaitIndexesOnline in interface Schema

Parameters:

duration - duration to wait for all indexes to come online

unit - TimeUnit of duration

getIndexState

public Schema.IndexState getIndexState(IndexDefinition index)

Description copied from interface: Schema

Poll the database for the state of a given index. This can be used to track when, during creation of a new index, an index is done populating itself and comes online to serve requests.

Specified by:

getIndexState in interface Schema

Parameters:

index - the index that we want to poll state for

Returns:

the current Schema.IndexState of the index

getIndexFailure

public String getIndexFailure(IndexDefinition index)

Description copied from interface: Schema

If Schema.getIndexState(IndexDefinition) return Schema.IndexState.FAILED this method will return the failure description.

Specified by:

getIndexFailure in interface Schema

Parameters:

index - the IndexDescriptor to get failure from.

Returns:

the failure description.

constraintFor

public ConstraintCreator constraintFor(Label label)

Description copied from interface: Schema

Returns a ConstraintCreator where details about the constraint can be specified. When all details have been entered ConstraintCreator.create() must be called for it to actually be created. Creating a constraint will have the transaction creating it block on commit until all existing data has been verified for compliance. If any existing data doesn't comply with the constraint the transaction will not be able to commit, but fail in Transaction.finish().

Specified by:

constraintFor in interface Schema

Parameters:

label - the label this constraint is for.

Returns:

a ConstraintCreator capable of providing details for, as well as creating a constraint for the given label.

getConstraints

public Iterable<ConstraintDefinition> getConstraints()

Specified by:

getConstraints in interface Schema

Returns:

all constraints

getConstraints

public Iterable<ConstraintDefinition> getConstraints(Label label)

Specified by:

getConstraints in interface Schema

Parameters:

label - the label to get constraints for.

Returns:

all constraints for the given label.