-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
KernelTransactionHandle.java
99 lines (88 loc) · 3.33 KB
/
KernelTransactionHandle.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
/*
* Copyright (c) 2002-2016 "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.kernel.api;
import java.util.Optional;
import java.util.stream.Stream;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.api.security.AccessMode;
import org.neo4j.kernel.impl.api.Kernel;
/**
* View of a {@link KernelTransaction} that provides a limited set of actions against the transaction.
*/
public interface KernelTransactionHandle
{
/**
* The id of the last transaction that was committed to the store when the underlying transaction started.
*
* @return the committed transaction id.
*/
long lastTransactionIdWhenStarted();
/**
* The timestamp of the last transaction that was committed to the store when the underlying transaction started.
*
* @return the timestamp value obtained with {@link System#currentTimeMillis()}.
*/
long lastTransactionTimestampWhenStarted();
/**
* The start time of the underlying transaction. I.e. basically {@link System#currentTimeMillis()} when user
* called {@link Kernel#newTransaction(KernelTransaction.Type, AccessMode)}.
*
* @return the transaction start time.
*/
long startTime();
/**
* Check if the underlying transaction is open.
*
* @return {@code true} if the underlying transaction ({@link KernelTransaction#close()} was not called),
* {@code false} otherwise.
*/
boolean isOpen();
/**
* Mark the underlying transaction for termination.
*
* @param reason the reason for termination.
* @return {@code true} if the underlying transaction was marked for termination, {@code false} otherwise
* (when this handle represents an old transaction that has been closed).
*/
boolean markForTermination( Status reason );
/**
* Access mode of underlying transaction that transaction has when handle was created.
*
* @return underlying transaction access mode
*/
AccessMode mode();
/**
* Transaction termination reason that transaction had when handle was created.
*
* @return transaction termination reason.
*/
Optional<Status> terminationReason();
/**
* Check if this handle points to the same underlying transaction as the given one.
*
* @param tx the expected transaction.
* @return {@code true} if this handle represents {@code tx}, {@code false} otherwise.
*/
boolean isUnderlyingTransaction( KernelTransaction tx );
/**
* @return a list of all queries currently executing that use the underlying transaction
*/
Stream<ExecutingQuery> executingQueries();
}