org.neo4j.storageengine.api.txstate

Interface ReadableTransactionState

public interface ReadableTransactionState

This interface contains the methods for reading transaction state from the transaction state. The implementation of these methods should be free of any side effects (such as initialising lazy state).

Method Summary

Modifier and Type	Method and Description
void	accept(TxStateVisitor visitor)
ReadableDiffSets<Long>	addedAndRemovedNodes() Returns nodes that have been added and removed in this tx.
ReadableRelationshipDiffSets<Long>	addedAndRemovedRelationships() Returns rels that have been added and removed in this tx.
Iterator<StorageProperty>	augmentGraphProperties(Iterator<StorageProperty> original)
org.neo4j.cursor.Cursor<RelationshipItem>	augmentIteratorRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor, org.neo4j.kernel.impl.api.store.RelationshipIterator iterator)
org.neo4j.cursor.Cursor<LabelItem>	augmentLabelCursor(org.neo4j.cursor.Cursor<LabelItem> cursor, NodeState nodeState)
int	augmentNodeDegree(long node, int committedDegree, Direction direction)
int	augmentNodeDegree(long node, int committedDegree, Direction direction, int relType)
org.neo4j.cursor.Cursor<RelationshipItem>	augmentNodeRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor, NodeState nodeState, Direction direction, int[] relTypes)
org.neo4j.collection.primitive.PrimitiveLongIterator	augmentNodesGetAll(org.neo4j.collection.primitive.PrimitiveLongIterator committed)
org.neo4j.cursor.Cursor<NodeItem>	augmentNodesGetAllCursor(org.neo4j.cursor.Cursor<NodeItem> cursor)
org.neo4j.cursor.Cursor<PropertyItem>	augmentPropertyCursor(org.neo4j.cursor.Cursor<PropertyItem> cursor, PropertyContainerState propertyContainerState)
org.neo4j.kernel.impl.api.store.RelationshipIterator	augmentRelationshipsGetAll(org.neo4j.kernel.impl.api.store.RelationshipIterator committed)
org.neo4j.cursor.Cursor<RelationshipItem>	augmentRelationshipsGetAllCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor)
org.neo4j.cursor.Cursor<LabelItem>	augmentSingleLabelCursor(org.neo4j.cursor.Cursor<LabelItem> cursor, NodeState nodeState, int labelId)
org.neo4j.cursor.Cursor<NodeItem>	augmentSingleNodeCursor(org.neo4j.cursor.Cursor<NodeItem> cursor, long nodeId)
org.neo4j.cursor.Cursor<PropertyItem>	augmentSinglePropertyCursor(org.neo4j.cursor.Cursor<PropertyItem> cursor, PropertyContainerState propertyContainerState, int propertyKeyId)
org.neo4j.cursor.Cursor<RelationshipItem>	augmentSingleRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor, long relationshipId)
ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor>	constraintIndexChanges()
ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor>	constraintIndexDiffSetsByLabel(int labelId)
Iterable<org.neo4j.kernel.api.index.IndexDescriptor>	constraintIndexesCreatedInTx()
ReadableDiffSets<org.neo4j.kernel.api.constraints.PropertyConstraint>	constraintsChanges()
ReadableDiffSets<org.neo4j.kernel.api.constraints.NodePropertyConstraint>	constraintsChangesForLabel(int labelId)
ReadableDiffSets<org.neo4j.kernel.api.constraints.NodePropertyConstraint>	constraintsChangesForLabelAndProperty(int labelId, int propertyKey)
ReadableDiffSets<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint>	constraintsChangesForRelationshipType(int relTypeId)
ReadableDiffSets<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint>	constraintsChangesForRelationshipTypeAndProperty(int relTypeId, int propertyKey)
NodeState	getNodeState(long id)
RelationshipState	getRelationshipState(long id)
boolean	hasChanges()
boolean	hasDataChanges() The way tokens are created is that the first time a token is needed it gets created in its own little token mini-transaction, separate from the surrounding transaction that creates or modifies data that need it.
ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor>	indexChanges()
Long	indexCreatedForConstraint(org.neo4j.kernel.api.constraints.UniquenessConstraint constraint)
ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor>	indexDiffSetsByLabel(int labelId)
ReadableDiffSets<Long>	indexUpdatesForRangeSeekByNumber(org.neo4j.kernel.api.index.IndexDescriptor index, Number lower, boolean includeLower, Number upper, boolean includeUpper)
ReadableDiffSets<Long>	indexUpdatesForRangeSeekByPrefix(org.neo4j.kernel.api.index.IndexDescriptor index, String prefix)
ReadableDiffSets<Long>	indexUpdatesForRangeSeekByString(org.neo4j.kernel.api.index.IndexDescriptor index, String lower, boolean includeLower, String upper, boolean includeUpper)
ReadableDiffSets<Long>	indexUpdatesForScanOrSeek(org.neo4j.kernel.api.index.IndexDescriptor index, Object value)
Iterable<NodeState>	modifiedNodes() Nodes that have had labels, relationships, or properties modified in this tx.
Iterable<RelationshipState>	modifiedRelationships() Rels that have properties modified in this tx.
boolean	nodeIsAddedInThisTx(long nodeId)
boolean	nodeIsDeletedInThisTx(long nodeId)
boolean	nodeModifiedInThisTx(long nodeId)
org.neo4j.collection.primitive.PrimitiveIntIterator	nodeRelationshipTypes(long nodeId)
ReadableDiffSets<Integer>	nodeStateLabelDiffSets(long nodeId)
ReadableDiffSets<Long>	nodesWithLabelChanged(int labelId) Returns all nodes that, in this tx, have had labelId removed.
boolean	relationshipIsAddedInThisTx(long relationshipId)
boolean	relationshipIsDeletedInThisTx(long relationshipId)
<EX extends Exception> boolean	relationshipVisit(long relId, org.neo4j.kernel.impl.api.RelationshipVisitor<EX> visitor)

Method Detail

accept

void accept(TxStateVisitor visitor)
     throws org.neo4j.kernel.api.exceptions.schema.ConstraintValidationKernelException,
            org.neo4j.kernel.api.exceptions.schema.CreateConstraintFailureException

Throws:

org.neo4j.kernel.api.exceptions.schema.ConstraintValidationKernelException

org.neo4j.kernel.api.exceptions.schema.CreateConstraintFailureException

hasChanges

boolean hasChanges()

nodesWithLabelChanged

ReadableDiffSets<Long> nodesWithLabelChanged(int labelId)

Returns all nodes that, in this tx, have had labelId removed.

addedAndRemovedNodes

ReadableDiffSets<Long> addedAndRemovedNodes()

Returns nodes that have been added and removed in this tx.

addedAndRemovedRelationships

ReadableRelationshipDiffSets<Long> addedAndRemovedRelationships()

Returns rels that have been added and removed in this tx.

modifiedNodes

Iterable<NodeState> modifiedNodes()

Nodes that have had labels, relationships, or properties modified in this tx.

modifiedRelationships

Iterable<RelationshipState> modifiedRelationships()

Rels that have properties modified in this tx.

relationshipIsAddedInThisTx

boolean relationshipIsAddedInThisTx(long relationshipId)

relationshipIsDeletedInThisTx

boolean relationshipIsDeletedInThisTx(long relationshipId)

nodeStateLabelDiffSets

ReadableDiffSets<Integer> nodeStateLabelDiffSets(long nodeId)

augmentGraphProperties

Iterator<StorageProperty> augmentGraphProperties(Iterator<StorageProperty> original)

nodeIsAddedInThisTx

boolean nodeIsAddedInThisTx(long nodeId)

nodeIsDeletedInThisTx

boolean nodeIsDeletedInThisTx(long nodeId)

nodeModifiedInThisTx

boolean nodeModifiedInThisTx(long nodeId)

nodeRelationshipTypes

org.neo4j.collection.primitive.PrimitiveIntIterator nodeRelationshipTypes(long nodeId)

augmentNodeDegree

int augmentNodeDegree(long node,
                      int committedDegree,
                      Direction direction)

augmentNodeDegree

int augmentNodeDegree(long node,
                      int committedDegree,
                      Direction direction,
                      int relType)

augmentNodesGetAll

org.neo4j.collection.primitive.PrimitiveLongIterator augmentNodesGetAll(org.neo4j.collection.primitive.PrimitiveLongIterator committed)

augmentRelationshipsGetAll

org.neo4j.kernel.impl.api.store.RelationshipIterator augmentRelationshipsGetAll(org.neo4j.kernel.impl.api.store.RelationshipIterator committed)

relationshipVisit

<EX extends Exception> boolean relationshipVisit(long relId,
                                                 org.neo4j.kernel.impl.api.RelationshipVisitor<EX> visitor)
                                          throws EX extends Exception

Returns:

true if the relationship was visited in this state, i.e. if it was created by this current transaction, otherwise false where the relationship might need to be visited from the store.

Throws:

EX extends Exception

indexDiffSetsByLabel

ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor> indexDiffSetsByLabel(int labelId)

constraintIndexDiffSetsByLabel

ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor> constraintIndexDiffSetsByLabel(int labelId)

indexChanges

ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor> indexChanges()

constraintIndexChanges

ReadableDiffSets<org.neo4j.kernel.api.index.IndexDescriptor> constraintIndexChanges()

constraintIndexesCreatedInTx

Iterable<org.neo4j.kernel.api.index.IndexDescriptor> constraintIndexesCreatedInTx()

constraintsChanges

ReadableDiffSets<org.neo4j.kernel.api.constraints.PropertyConstraint> constraintsChanges()

constraintsChangesForLabel

ReadableDiffSets<org.neo4j.kernel.api.constraints.NodePropertyConstraint> constraintsChangesForLabel(int labelId)

constraintsChangesForLabelAndProperty

ReadableDiffSets<org.neo4j.kernel.api.constraints.NodePropertyConstraint> constraintsChangesForLabelAndProperty(int labelId,
                                                                                                                int propertyKey)

constraintsChangesForRelationshipType

ReadableDiffSets<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint> constraintsChangesForRelationshipType(int relTypeId)

constraintsChangesForRelationshipTypeAndProperty

ReadableDiffSets<org.neo4j.kernel.api.constraints.RelationshipPropertyConstraint> constraintsChangesForRelationshipTypeAndProperty(int relTypeId,
                                                                                                                                   int propertyKey)

indexCreatedForConstraint

Long indexCreatedForConstraint(org.neo4j.kernel.api.constraints.UniquenessConstraint constraint)

indexUpdatesForScanOrSeek

ReadableDiffSets<Long> indexUpdatesForScanOrSeek(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                 Object value)

indexUpdatesForRangeSeekByNumber

ReadableDiffSets<Long> indexUpdatesForRangeSeekByNumber(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                        Number lower,
                                                        boolean includeLower,
                                                        Number upper,
                                                        boolean includeUpper)

indexUpdatesForRangeSeekByString

ReadableDiffSets<Long> indexUpdatesForRangeSeekByString(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                        String lower,
                                                        boolean includeLower,
                                                        String upper,
                                                        boolean includeUpper)

indexUpdatesForRangeSeekByPrefix

ReadableDiffSets<Long> indexUpdatesForRangeSeekByPrefix(org.neo4j.kernel.api.index.IndexDescriptor index,
                                                        String prefix)

getNodeState

NodeState getNodeState(long id)

getRelationshipState

RelationshipState getRelationshipState(long id)

augmentSingleNodeCursor

org.neo4j.cursor.Cursor<NodeItem> augmentSingleNodeCursor(org.neo4j.cursor.Cursor<NodeItem> cursor,
                                                          long nodeId)

augmentPropertyCursor

org.neo4j.cursor.Cursor<PropertyItem> augmentPropertyCursor(org.neo4j.cursor.Cursor<PropertyItem> cursor,
                                                            PropertyContainerState propertyContainerState)

augmentSinglePropertyCursor

org.neo4j.cursor.Cursor<PropertyItem> augmentSinglePropertyCursor(org.neo4j.cursor.Cursor<PropertyItem> cursor,
                                                                  PropertyContainerState propertyContainerState,
                                                                  int propertyKeyId)

augmentLabelCursor

org.neo4j.cursor.Cursor<LabelItem> augmentLabelCursor(org.neo4j.cursor.Cursor<LabelItem> cursor,
                                                      NodeState nodeState)

augmentSingleLabelCursor

org.neo4j.cursor.Cursor<LabelItem> augmentSingleLabelCursor(org.neo4j.cursor.Cursor<LabelItem> cursor,
                                                            NodeState nodeState,
                                                            int labelId)

augmentSingleRelationshipCursor

org.neo4j.cursor.Cursor<RelationshipItem> augmentSingleRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor,
                                                                          long relationshipId)

augmentIteratorRelationshipCursor

org.neo4j.cursor.Cursor<RelationshipItem> augmentIteratorRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor,
                                                                            org.neo4j.kernel.impl.api.store.RelationshipIterator iterator)

augmentNodeRelationshipCursor

org.neo4j.cursor.Cursor<RelationshipItem> augmentNodeRelationshipCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor,
                                                                        NodeState nodeState,
                                                                        Direction direction,
                                                                        int[] relTypes)

augmentNodesGetAllCursor

org.neo4j.cursor.Cursor<NodeItem> augmentNodesGetAllCursor(org.neo4j.cursor.Cursor<NodeItem> cursor)

augmentRelationshipsGetAllCursor

org.neo4j.cursor.Cursor<RelationshipItem> augmentRelationshipsGetAllCursor(org.neo4j.cursor.Cursor<RelationshipItem> cursor)

hasDataChanges

boolean hasDataChanges()

The way tokens are created is that the first time a token is needed it gets created in its own little token mini-transaction, separate from the surrounding transaction that creates or modifies data that need it. From the kernel POV it's interesting to know whether or not any tokens have been created in this tx state, because then we know it's a mini-transaction like this and won't have to let transaction event handlers know about it, for example. The same applies to schema changes, such as creating and dropping indexes and constraints.