org.neo4j.kernel.api.operations

Interface SchemaReadOperations

All Known Subinterfaces:

ReadOperations, SchemaOperations, StatementOperations

public interface SchemaReadOperations

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<UniquenessConstraint>	constraintsGetAll(StatementState state) Get all constraints.
Iterator<UniquenessConstraint>	constraintsGetForLabel(StatementState state, long labelId) Get all constraints applicable to label.
Iterator<UniquenessConstraint>	constraintsGetForLabelAndPropertyKey(StatementState state, long labelId, long propertyKeyId) Get all constraints applicable to label and propertyKey.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	indexesGetAll(StatementState state) Returns all indexes.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	indexesGetForLabel(StatementState state, long labelId) Get all indexes for a label.
org.neo4j.kernel.impl.api.index.IndexDescriptor	indexesGetForLabelAndPropertyKey(StatementState state, long labelId, long propertyKey) Returns the index rule for the given labelId and propertyKey.
long	indexGetCommittedId(StatementState state, org.neo4j.kernel.impl.api.index.IndexDescriptor index) Get the index id (the id or the schema rule record) for a committed index - throws exception for indexes that aren't committed.
String	indexGetFailure(StatementState state, org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor) Returns the failure description of a failed index.
Long	indexGetOwningUniquenessConstraintId(StatementState state, org.neo4j.kernel.impl.api.index.IndexDescriptor index) Get the owning constraint for a constraint index.
InternalIndexState	indexGetState(StatementState state, org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor) Retrieve the state of an index.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	uniqueIndexesGetAll(StatementState state) Returns all constraint indexes.
Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor>	uniqueIndexesGetForLabel(StatementState state, long labelId) Get all constraint indexes for a label.

Method Detail

indexesGetForLabelAndPropertyKey

org.neo4j.kernel.impl.api.index.IndexDescriptor indexesGetForLabelAndPropertyKey(StatementState state,
                                                                               long labelId,
                                                                               long propertyKey)
                                                                                 throws SchemaRuleNotFoundException

Returns the index rule for the given labelId and propertyKey.

Throws:

SchemaRuleNotFoundException

indexesGetForLabel

Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> indexesGetForLabel(StatementState state,
                                                                           long labelId)

Get all indexes for a label.

indexesGetAll

Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> indexesGetAll(StatementState state)

Returns all indexes.

uniqueIndexesGetForLabel

Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> uniqueIndexesGetForLabel(StatementState state,
                                                                                 long labelId)

Get all constraint indexes for a label.

uniqueIndexesGetAll

Iterator<org.neo4j.kernel.impl.api.index.IndexDescriptor> uniqueIndexesGetAll(StatementState state)

Returns all constraint indexes.

indexGetState

InternalIndexState indexGetState(StatementState state,
                               org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor)
                                 throws IndexNotFoundKernelException

Retrieve the state of an index.

Throws:

IndexNotFoundKernelException

indexGetFailure

String indexGetFailure(StatementState state,
                     org.neo4j.kernel.impl.api.index.IndexDescriptor descriptor)
                       throws IndexNotFoundKernelException

Returns the failure description of a failed index.

Throws:

IndexNotFoundKernelException

constraintsGetForLabelAndPropertyKey

Iterator<UniquenessConstraint> constraintsGetForLabelAndPropertyKey(StatementState state,
                                                                  long labelId,
                                                                  long propertyKeyId)

Get all constraints applicable to label and propertyKey. There are only UniquenessConstraint for the time being.

constraintsGetForLabel

Iterator<UniquenessConstraint> constraintsGetForLabel(StatementState state,
                                                    long labelId)

Get all constraints applicable to label. There are only UniquenessConstraint for the time being.

constraintsGetAll

Iterator<UniquenessConstraint> constraintsGetAll(StatementState state)

Get all constraints. There are only UniquenessConstraint for the time being.

indexGetOwningUniquenessConstraintId

Long indexGetOwningUniquenessConstraintId(StatementState state,
                                        org.neo4j.kernel.impl.api.index.IndexDescriptor index)
                                          throws SchemaRuleNotFoundException

Get the owning constraint for a constraint index. Returns null if the index does not have an owning constraint.

Throws:

SchemaRuleNotFoundException

indexGetCommittedId

long indexGetCommittedId(StatementState state,
                       org.neo4j.kernel.impl.api.index.IndexDescriptor index)
                         throws SchemaRuleNotFoundException

Get the index id (the id or the schema rule record) for a committed index - throws exception for indexes that aren't committed.

Throws:

SchemaRuleNotFoundException