org.neo4j.storageengine.api

Interface StoreReadLayer

public interface StoreReadLayer

Abstraction for reading committed data from store.

Method Summary

Modifier and Type	Method and Description
Iterator<org.neo4j.kernel.api.constraints.PropertyConstraint>	constraintsGetAll()
Iterator<org.neo4j.kernel.api.constraints.NodePropertyConstraint>	constraintsGetForLabel(int labelId)
Iterator<org.neo4j.kernel.api.constraints.NodePropertyConstraint>	constraintsGetForLabelAndPropertyKey(int labelId, int propertyKeyId)
Iterator<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint>	constraintsGetForRelationshipType(int typeId)
Iterator<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint>	constraintsGetForRelationshipTypeAndPropertyKey(int typeId, int propertyKeyId)
long	countsForNode(int labelId) Returns number of stored nodes labeled with the label represented by labelId.
long	countsForRelationship(int startLabelId, int typeId, int endLabelId) Returns number of stored relationships of a certain typeId whose start/end nodes are labeled with the startLabelId and endLabelId respectively.
Iterator<StorageProperty>	graphGetAllProperties()
Object	graphGetProperty(int propertyKeyId)
org.neo4j.collection.primitive.PrimitiveIntIterator	graphGetPropertyKeys()
Iterator<org.neo4j.kernel.api.index.IndexDescriptor>	indexesGetAll()
Iterator<org.neo4j.kernel.api.index.IndexDescriptor>	indexesGetForLabel(int labelId)
long	indexGetCommittedId(org.neo4j.kernel.api.index.IndexDescriptor index, Predicate<SchemaRule.Kind> filter)
String	indexGetFailure(org.neo4j.kernel.api.index.IndexDescriptor index) Returns any failure that happened during population or operation of an index.
org.neo4j.kernel.api.index.IndexDescriptor	indexGetForLabelAndPropertyKey(int labelId, int propertyKeyId) Looks for a stored index by given labelId and propertyKey
Long	indexGetOwningUniquenessConstraintId(org.neo4j.kernel.api.index.IndexDescriptor index)
PopulationProgress	indexGetPopulationProgress(org.neo4j.kernel.api.index.IndexDescriptor index)
org.neo4j.kernel.api.index.InternalIndexState	indexGetState(org.neo4j.kernel.api.index.IndexDescriptor index) Returns state of a stored index.
IndexSchemaRule	indexRule(org.neo4j.kernel.api.index.IndexDescriptor index, Predicate<SchemaRule.Kind> filter)
org.neo4j.register.Register.DoubleLongRegister	indexSample(org.neo4j.kernel.api.index.IndexDescriptor index, org.neo4j.register.Register.DoubleLongRegister target)
long	indexSize(org.neo4j.kernel.api.index.IndexDescriptor index) Returns size of index, i.e.
double	indexUniqueValuesPercentage(org.neo4j.kernel.api.index.IndexDescriptor index) Returns percentage of values in the given index are unique.
org.neo4j.register.Register.DoubleLongRegister	indexUpdatesAndSize(org.neo4j.kernel.api.index.IndexDescriptor index, org.neo4j.register.Register.DoubleLongRegister target)
int	labelCount()
int	labelGetForName(String labelName)
String	labelGetName(int labelId)
int	labelGetOrCreateForName(String labelName) Gets label token id for the given labelName, or creates one if there is no existing label with the given name.
Iterator<Token>	labelsGetAllTokens()
StorageStatement	newStatement()
boolean	nodeExists(long id)
org.neo4j.collection.primitive.PrimitiveLongIterator	nodesGetAll()
long	nodesGetCount()
org.neo4j.collection.primitive.PrimitiveLongIterator	nodesGetForLabel(StorageStatement statement, int labelId)
int	propertyKeyCount()
Iterator<Token>	propertyKeyGetAllTokens()
int	propertyKeyGetForName(String propertyKeyName)
String	propertyKeyGetName(int propertyKeyId)
int	propertyKeyGetOrCreateForName(String propertyKeyName) Gets property key token id for the given propertyKeyName, or creates one if there is no existing property key with the given name.
org.neo4j.kernel.impl.api.store.RelationshipIterator	relationshipsGetAll()
long	relationshipsGetCount()
int	relationshipTypeCount()
Iterator<Token>	relationshipTypeGetAllTokens()
int	relationshipTypeGetForName(String relationshipTypeName)
String	relationshipTypeGetName(int relationshipTypeId)
int	relationshipTypeGetOrCreateForName(String relationshipTypeName) Gets relationship type token id for the given relationshipTypeName, or creates one if there is no existing relationship type with the given name.
<EXCEPTION extends Exception> void	relationshipVisit(long relationshipId, org.neo4j.kernel.impl.api.RelationshipVisitor<EXCEPTION> relationshipVisitor) Visits data about a relationship.
void	releaseNode(long id) Releases a previously reserved node id if it turns out to not actually being used, for example in the event of a transaction rolling back.
void	releaseRelationship(long id) Releases a previously reserved relationship id if it turns out to not actually being used, for example in the event of a transaction rolling back.
long	reserveNode() Reserves a node id for future use to store a node.
long	reserveRelationship() Reserves a relationship id for future use to store a relationship.
Iterator<org.neo4j.kernel.api.index.IndexDescriptor>	uniquenessIndexesGetAll()
Iterator<org.neo4j.kernel.api.index.IndexDescriptor>	uniquenessIndexesGetForLabel(int labelId)

Method Detail

newStatement

StorageStatement newStatement()

Returns:

new StorageStatement, which can be used after a call to StorageStatement.acquire().

indexesGetForLabel

Iterator<org.neo4j.kernel.api.index.IndexDescriptor> indexesGetForLabel(int labelId)

Parameters:

labelId - label to list indexes for.

Returns:

IndexDescriptor associated with the given labelId.

indexesGetAll

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

Returns:

all IndexDescriptor in storage.

uniquenessIndexesGetForLabel

Iterator<org.neo4j.kernel.api.index.IndexDescriptor> uniquenessIndexesGetForLabel(int labelId)

Parameters:

labelId - label to list indexes related to uniqueness constraints for.

Returns:

IndexDescriptor related to uniqueness constraints associated with the given labelId.

uniquenessIndexesGetAll

Iterator<org.neo4j.kernel.api.index.IndexDescriptor> uniquenessIndexesGetAll()

Returns:

all IndexDescriptor related to uniqueness constraints.

indexGetOwningUniquenessConstraintId

Long indexGetOwningUniquenessConstraintId(org.neo4j.kernel.api.index.IndexDescriptor index)
                                   throws org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException

Parameters:

index - IndexDescriptor to get related uniqueness constraint for.

Returns:

schema rule id of uniqueness constraint that owns the given index, or null if the given index isn't related to a uniqueness constraint.

Throws:

org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException - if there's no such index matching the given index in storage.

indexGetCommittedId

long indexGetCommittedId(org.neo4j.kernel.api.index.IndexDescriptor index,
                         Predicate<SchemaRule.Kind> filter)
                  throws org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException

Parameters:

index - IndexDescriptor to get schema rule id for.

filter - for type of index to match.

Returns:

schema rule id for matching index.

Throws:

org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException - if no such index exists in storage.

indexRule

IndexSchemaRule indexRule(org.neo4j.kernel.api.index.IndexDescriptor index,
                          Predicate<SchemaRule.Kind> filter)
                   throws org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException

Parameters:

index - IndexDescriptor to get index schema rule for.

filter - for type of index to match.

Returns:

index schema rule for matching index.

Throws:

org.neo4j.kernel.api.exceptions.schema.SchemaRuleNotFoundException - if no such index exists in storage.

graphGetPropertyKeys

org.neo4j.collection.primitive.PrimitiveIntIterator graphGetPropertyKeys()

Returns:

iterator with property keys of all stored graph properties.

graphGetProperty

Object graphGetProperty(int propertyKeyId)

Parameters:

propertyKeyId - property key id to get graph property for.

Returns:

property value of graph property with key propertyKeyId, or null if not found.

graphGetAllProperties

Iterator<StorageProperty> graphGetAllProperties()

Returns:

all stored graph properties.

constraintsGetForLabelAndPropertyKey

Iterator<org.neo4j.kernel.api.constraints.NodePropertyConstraint> constraintsGetForLabelAndPropertyKey(int labelId,
                                                                                                       int propertyKeyId)

Parameters:

labelId - label token id .

propertyKeyId - property key token id.

Returns:

node property constraints associated with the label and property key token ids.

constraintsGetForLabel

Iterator<org.neo4j.kernel.api.constraints.NodePropertyConstraint> constraintsGetForLabel(int labelId)

Parameters:

labelId - label token id .

Returns:

node property constraints associated with the label token id.

constraintsGetForRelationshipTypeAndPropertyKey

Iterator<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint> constraintsGetForRelationshipTypeAndPropertyKey(int typeId,
                                                                                                                          int propertyKeyId)

Parameters:

typeId - relationship type token id .

propertyKeyId - property key token id.

Returns:

relationship property constraints associated with the relationship type and property key token ids.

constraintsGetForRelationshipType

Iterator<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint> constraintsGetForRelationshipType(int typeId)

Parameters:

typeId - relationship type token id .

Returns:

relationship property constraints associated with the relationship type token id.

constraintsGetAll

Iterator<org.neo4j.kernel.api.constraints.PropertyConstraint> constraintsGetAll()

Returns:

all stored property constraints.

nodesGetForLabel

org.neo4j.collection.primitive.PrimitiveLongIterator nodesGetForLabel(StorageStatement statement,
                                                                      int labelId)

indexGetForLabelAndPropertyKey

org.neo4j.kernel.api.index.IndexDescriptor indexGetForLabelAndPropertyKey(int labelId,
                                                                          int propertyKeyId)

Looks for a stored index by given labelId and propertyKey

Parameters:

labelId - label id.

propertyKeyId - property key id.

Returns:

IndexDescriptor for matching index, or null if not found. TODO should throw exception.

indexGetState

org.neo4j.kernel.api.index.InternalIndexState indexGetState(org.neo4j.kernel.api.index.IndexDescriptor index)
                                                     throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException

Returns state of a stored index.

Parameters:

index - IndexDescriptor to get state for.

Returns:

InternalIndexState for index.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException - if index not found.

indexGetPopulationProgress

PopulationProgress indexGetPopulationProgress(org.neo4j.kernel.api.index.IndexDescriptor index)
                                       throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException

Parameters:

index - IndexDescriptor to get population progress for.

Returns:

progress of index population, which is the initial state of an index when it's created.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException - if index not found.

indexGetFailure

String indexGetFailure(org.neo4j.kernel.api.index.IndexDescriptor index)
                throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException

Returns any failure that happened during population or operation of an index. Such failures are persisted and can be accessed even after restart.

Parameters:

index - IndexDescriptor to get failure for.

Returns:

failure of an index, or null if index is working as it should.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException - if index not found.

labelGetForName

int labelGetForName(String labelName)

Parameters:

labelName - name of label.

Returns:

token id of label.

labelGetName

String labelGetName(int labelId)
             throws org.neo4j.kernel.api.exceptions.LabelNotFoundKernelException

Parameters:

labelId - label id to get name for.

Returns:

label name for given label id.

Throws:

org.neo4j.kernel.api.exceptions.LabelNotFoundKernelException - if no label by labelId was found.

propertyKeyGetForName

int propertyKeyGetForName(String propertyKeyName)

Parameters:

propertyKeyName - name of property key.

Returns:

token id of property key.

propertyKeyGetOrCreateForName

int propertyKeyGetOrCreateForName(String propertyKeyName)

Gets property key token id for the given propertyKeyName, or creates one if there is no existing property key with the given name.

Parameters:

propertyKeyName - name of property key.

Returns:

property key token id for the given name, created if need be.

propertyKeyGetName

String propertyKeyGetName(int propertyKeyId)
                   throws org.neo4j.kernel.api.exceptions.PropertyKeyIdNotFoundKernelException

Parameters:

propertyKeyId - property key to get name for.

Returns:

property key name for given property key id.

Throws:

org.neo4j.kernel.api.exceptions.PropertyKeyIdNotFoundKernelException - if no property key by propertyKeyId was found.

propertyKeyGetAllTokens

Iterator<Token> propertyKeyGetAllTokens()

Returns:

all stored property key tokens.

labelsGetAllTokens

Iterator<Token> labelsGetAllTokens()

Returns:

all stored label tokens.

relationshipTypeGetAllTokens

Iterator<Token> relationshipTypeGetAllTokens()

Returns:

all stored relationship type tokens.

relationshipTypeGetForName

int relationshipTypeGetForName(String relationshipTypeName)

Parameters:

relationshipTypeName - name of relationship type.

Returns:

token id of relationship type.

relationshipTypeGetName

String relationshipTypeGetName(int relationshipTypeId)
                        throws org.neo4j.kernel.api.exceptions.RelationshipTypeIdNotFoundKernelException

Parameters:

relationshipTypeId - relationship type id to get name for.

Returns:

relationship type name of given relationship type id.

Throws:

org.neo4j.kernel.api.exceptions.RelationshipTypeIdNotFoundKernelException - if no label by labelId was found.

labelGetOrCreateForName

int labelGetOrCreateForName(String labelName)
                     throws org.neo4j.kernel.api.exceptions.schema.TooManyLabelsException

Gets label token id for the given labelName, or creates one if there is no existing label with the given name.

Parameters:

labelName - name of label.

Returns:

label token id for the given name, created if need be.

Throws:

org.neo4j.kernel.api.exceptions.schema.TooManyLabelsException - if creating this label would have exceeded storage limitations for number of stored labels.

relationshipTypeGetOrCreateForName

int relationshipTypeGetOrCreateForName(String relationshipTypeName)

Gets relationship type token id for the given relationshipTypeName, or creates one if there is no existing relationship type with the given name.

Parameters:

relationshipTypeName - name of relationship type.

Returns:

relationship type token id for the given name, created if need be.

relationshipVisit

<EXCEPTION extends Exception> void relationshipVisit(long relationshipId,
                                                     org.neo4j.kernel.impl.api.RelationshipVisitor<EXCEPTION> relationshipVisitor)
                                              throws org.neo4j.kernel.api.exceptions.EntityNotFoundException,
                                                     EXCEPTION extends Exception

Visits data about a relationship. The given relationshipVisitor will be notified.

Parameters:

relationshipId - the id of the relationship to access.

relationshipVisitor - RelationshipVisitor which will see the relationship data.

Throws:

org.neo4j.kernel.api.exceptions.EntityNotFoundException - if no relationship exists by the given relationshipId.

EXCEPTION extends Exception

nodesGetAll

org.neo4j.collection.primitive.PrimitiveLongIterator nodesGetAll()

Returns:

ids of all stored nodes.

relationshipsGetAll

org.neo4j.kernel.impl.api.store.RelationshipIterator relationshipsGetAll()

Returns:

ids of all stored relationships. The returned iterator can optionally visit data about each relationship returned.

reserveNode

long reserveNode()

Reserves a node id for future use to store a node. The reason for it being exposed here is that internal ids of nodes and relationships are publicly accessible all the way out to the user. This will likely change in the future though.

Returns:

a reserved node id for future use.

reserveRelationship

long reserveRelationship()

Reserves a relationship id for future use to store a relationship. The reason for it being exposed here is that internal ids of nodes and relationships are publicly accessible all the way out to the user. This will likely change in the future though.

Returns:

a reserved relationship id for future use.

releaseNode

void releaseNode(long id)

Releases a previously reserved node id if it turns out to not actually being used, for example in the event of a transaction rolling back.

Parameters:

id - reserved node id to release.

releaseRelationship

void releaseRelationship(long id)

Releases a previously reserved relationship id if it turns out to not actually being used, for example in the event of a transaction rolling back.

Parameters:

id - reserved relationship id to release.

countsForNode

long countsForNode(int labelId)

Returns number of stored nodes labeled with the label represented by labelId.

Parameters:

labelId - label id to match.

Returns:

number of stored nodes with this label.

countsForRelationship

long countsForRelationship(int startLabelId,
                           int typeId,
                           int endLabelId)

Returns number of stored relationships of a certain typeId whose start/end nodes are labeled with the startLabelId and endLabelId respectively.

Parameters:

startLabelId - label id of start nodes to match.

typeId - relationship type id to match.

endLabelId - label id of end nodes to match.

Returns:

number of stored relationships matching these criteria.

indexSize

long indexSize(org.neo4j.kernel.api.index.IndexDescriptor index)
        throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException

Returns size of index, i.e. number of entities in that index.

Parameters:

index - IndexDescriptor to return size for.

Returns:

number of entities in the given index.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException - if no such index exists.

indexUniqueValuesPercentage

double indexUniqueValuesPercentage(org.neo4j.kernel.api.index.IndexDescriptor index)
                            throws org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException

Returns percentage of values in the given index are unique. A value of 1.0 means that all values in the index are unique, e.g. that there are no duplicate values. A value of, say 0.9 means that 10% of the values are duplicates.

Parameters:

index - IndexDescriptor to get uniqueness percentage for.

Returns:

percentage of values being unique in this index, max 1.0 for all unique.

Throws:

org.neo4j.kernel.api.exceptions.index.IndexNotFoundKernelException - if no such index exists.

nodesGetCount

long nodesGetCount()

relationshipsGetCount

long relationshipsGetCount()

labelCount

int labelCount()

propertyKeyCount

int propertyKeyCount()

relationshipTypeCount

int relationshipTypeCount()

indexUpdatesAndSize

org.neo4j.register.Register.DoubleLongRegister indexUpdatesAndSize(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                                   org.neo4j.register.Register.DoubleLongRegister target)

indexSample

org.neo4j.register.Register.DoubleLongRegister indexSample(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                           org.neo4j.register.Register.DoubleLongRegister target)

nodeExists

boolean nodeExists(long id)