-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ReadableTransactionState.java
194 lines (142 loc) · 8.01 KB
/
ReadableTransactionState.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.storageengine.api.txstate;
import java.util.Iterator;
import org.neo4j.collection.primitive.PrimitiveIntSet;
import org.neo4j.collection.primitive.PrimitiveLongIterator;
import org.neo4j.collection.primitive.PrimitiveLongResourceIterator;
import org.neo4j.cursor.Cursor;
import org.neo4j.internal.kernel.api.IndexQuery;
import org.neo4j.internal.kernel.api.exceptions.schema.ConstraintValidationException;
import org.neo4j.internal.kernel.api.schema.SchemaDescriptor;
import org.neo4j.internal.kernel.api.schema.constraints.ConstraintDescriptor;
import org.neo4j.kernel.api.exceptions.schema.CreateConstraintFailureException;
import org.neo4j.kernel.api.schema.index.IndexDescriptor;
import org.neo4j.kernel.impl.api.RelationshipVisitor;
import org.neo4j.kernel.impl.api.store.RelationshipIterator;
import org.neo4j.storageengine.api.Direction;
import org.neo4j.storageengine.api.NodeItem;
import org.neo4j.storageengine.api.PropertyItem;
import org.neo4j.storageengine.api.RelationshipItem;
import org.neo4j.storageengine.api.StorageProperty;
import org.neo4j.values.storable.PointValue;
import org.neo4j.values.storable.ValueTuple;
/**
* 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).
*/
public interface ReadableTransactionState
{
void accept( TxStateVisitor visitor ) throws ConstraintValidationException, CreateConstraintFailureException;
boolean hasChanges();
// ENTITY RELATED
/**
* Returns all nodes that, in this tx, have had the labels changed.
*/
ReadableDiffSets<Long> nodesWithLabelChanged( int label );
/**
* Returns all nodes that, in this tx, have had any of the labels changed.
*/
ReadableDiffSets<Long> nodesWithAnyOfLabelsChanged( int... labels );
/**
* Returns all nodes that, in this tx, have had all the labels changed.
*/
ReadableDiffSets<Long> nodesWithAllLabelsChanged( int... labels );
/**
* Returns nodes that have been added and removed in this tx.
*/
ReadableDiffSets<Long> addedAndRemovedNodes();
/**
* Returns rels that have been added and removed in this tx.
*/
ReadableRelationshipDiffSets<Long> addedAndRemovedRelationships();
/**
* Nodes that have had labels, relationships, or properties modified in this tx.
*/
Iterable<NodeState> modifiedNodes();
/**
* Rels that have properties modified in this tx.
*/
Iterable<RelationshipState> modifiedRelationships();
boolean relationshipIsAddedInThisTx( long relationshipId );
boolean relationshipIsDeletedInThisTx( long relationshipId );
ReadableDiffSets<Integer> nodeStateLabelDiffSets( long nodeId );
Iterator<StorageProperty> augmentGraphProperties( Iterator<StorageProperty> original );
boolean nodeIsAddedInThisTx( long nodeId );
boolean nodeIsDeletedInThisTx( long nodeId );
boolean nodeModifiedInThisTx( long nodeId );
PrimitiveIntSet nodeRelationshipTypes( long nodeId );
int augmentNodeDegree( long node, int committedDegree, Direction direction );
int augmentNodeDegree( long node, int committedDegree, Direction direction, int relType );
PrimitiveLongResourceIterator augmentNodesGetAll( PrimitiveLongIterator committed );
RelationshipIterator augmentRelationshipsGetAll( RelationshipIterator committed );
/**
* @return {@code true} if the relationship was visited in this state, i.e. if it was created
* by this current transaction, otherwise {@code false} where the relationship might need to be
* visited from the store.
*/
<EX extends Exception> boolean relationshipVisit( long relId, RelationshipVisitor<EX> visitor ) throws EX;
// SCHEMA RELATED
ReadableDiffSets<IndexDescriptor> indexDiffSetsByLabel( int labelId );
ReadableDiffSets<IndexDescriptor> indexChanges();
Iterable<IndexDescriptor> constraintIndexesCreatedInTx();
ReadableDiffSets<ConstraintDescriptor> constraintsChanges();
ReadableDiffSets<ConstraintDescriptor> constraintsChangesForLabel( int labelId );
ReadableDiffSets<ConstraintDescriptor> constraintsChangesForSchema( SchemaDescriptor descriptor );
ReadableDiffSets<ConstraintDescriptor> constraintsChangesForRelationshipType( int relTypeId );
Long indexCreatedForConstraint( ConstraintDescriptor constraint );
PrimitiveLongReadableDiffSets indexUpdatesForScan( IndexDescriptor index );
PrimitiveLongReadableDiffSets indexUpdatesForSeek( IndexDescriptor index, ValueTuple values );
PrimitiveLongReadableDiffSets indexUpdatesForRangeSeekByNumber( IndexDescriptor index,
Number lower, boolean includeLower,
Number upper, boolean includeUpper );
PrimitiveLongReadableDiffSets indexUpdatesForRangeSeekByGeometry( IndexDescriptor index,
PointValue lower, boolean includeLower,
PointValue upper, boolean includeUpper );
PrimitiveLongReadableDiffSets indexUpdatesForRangeSeekByString( IndexDescriptor index,
String lower, boolean includeLower,
String upper, boolean includeUpper );
PrimitiveLongReadableDiffSets indexUpdatesForRangeSeekByPrefix( IndexDescriptor index, String prefix );
NodeState getNodeState( long id );
RelationshipState getRelationshipState( long id );
Cursor<NodeItem> augmentSingleNodeCursor( Cursor<NodeItem> cursor, long nodeId );
Cursor<PropertyItem> augmentPropertyCursor( Cursor<PropertyItem> cursor,
PropertyContainerState propertyContainerState );
Cursor<PropertyItem> augmentSinglePropertyCursor( Cursor<PropertyItem> cursor,
PropertyContainerState propertyContainerState,
int propertyKeyId );
PrimitiveIntSet augmentLabels( PrimitiveIntSet cursor, NodeState nodeState );
Cursor<RelationshipItem> augmentSingleRelationshipCursor( Cursor<RelationshipItem> cursor, long relationshipId );
Cursor<RelationshipItem> augmentNodeRelationshipCursor( Cursor<RelationshipItem> cursor, NodeState nodeState,
Direction direction );
Cursor<RelationshipItem> augmentNodeRelationshipCursor( Cursor<RelationshipItem> cursor, NodeState nodeState,
Direction direction, int[] relTypes );
Cursor<RelationshipItem> augmentRelationshipsGetAllCursor( Cursor<RelationshipItem> cursor );
/**
* 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.
*/
boolean hasDataChanges();
}