/
DmlBatch.java
219 lines (190 loc) · 7.13 KB
/
DmlBatch.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.spanner.connection;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutureCallback;
import com.google.api.core.ApiFutures;
import com.google.api.core.SettableApiFuture;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.CommitResponse;
import com.google.cloud.spanner.ErrorCode;
import com.google.cloud.spanner.Mutation;
import com.google.cloud.spanner.Options.QueryOption;
import com.google.cloud.spanner.ResultSet;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.connection.StatementParser.ParsedStatement;
import com.google.cloud.spanner.connection.StatementParser.StatementType;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.MoreExecutors;
import java.util.ArrayList;
import java.util.List;
/**
* {@link UnitOfWork} that is used when a DML batch is started. These batches only accept DML
* statements. All DML statements are buffered locally and sent to Spanner when runBatch() is
* called.
*/
class DmlBatch extends AbstractBaseUnitOfWork {
private final UnitOfWork transaction;
private final List<ParsedStatement> statements = new ArrayList<>();
private UnitOfWorkState state = UnitOfWorkState.STARTED;
static class Builder extends AbstractBaseUnitOfWork.Builder<Builder, DmlBatch> {
private UnitOfWork transaction;
private Builder() {}
Builder setTransaction(UnitOfWork transaction) {
Preconditions.checkNotNull(transaction);
this.transaction = transaction;
return this;
}
@Override
DmlBatch build() {
Preconditions.checkState(transaction != null, "No transaction specified");
return new DmlBatch(this);
}
}
static Builder newBuilder() {
return new Builder();
}
private DmlBatch(Builder builder) {
super(builder);
this.transaction = builder.transaction;
}
@Override
public Type getType() {
return Type.BATCH;
}
@Override
public UnitOfWorkState getState() {
return this.state;
}
@Override
public boolean isActive() {
return getState().isActive();
}
@Override
public boolean isReadOnly() {
return false;
}
@Override
public ApiFuture<ResultSet> executeQueryAsync(
ParsedStatement statement, AnalyzeMode analyzeMode, QueryOption... options) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing queries is not allowed for DML batches.");
}
@Override
public Timestamp getReadTimestamp() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no read timestamp available for DML batches.");
}
@Override
public Timestamp getReadTimestampOrNull() {
return null;
}
@Override
public Timestamp getCommitTimestamp() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no commit timestamp available for DML batches.");
}
@Override
public Timestamp getCommitTimestampOrNull() {
return null;
}
@Override
public CommitResponse getCommitResponse() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no commit response available for DML batches.");
}
@Override
public CommitResponse getCommitResponseOrNull() {
return null;
}
@Override
public ApiFuture<Void> executeDdlAsync(ParsedStatement ddl) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing DDL statements is not allowed for DML batches.");
}
@Override
public ApiFuture<Long> executeUpdateAsync(ParsedStatement update) {
ConnectionPreconditions.checkState(
state == UnitOfWorkState.STARTED,
"The batch is no longer active and cannot be used for further statements");
Preconditions.checkArgument(
update.getType() == StatementType.UPDATE,
"Only DML statements are allowed. \""
+ update.getSqlWithoutComments()
+ "\" is not a DML-statement.");
statements.add(update);
return ApiFutures.immediateFuture(-1L);
}
@Override
public ApiFuture<long[]> executeBatchUpdateAsync(Iterable<ParsedStatement> updates) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing batch updates is not allowed for DML batches.");
}
@Override
public ApiFuture<Void> writeAsync(Iterable<Mutation> mutations) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Writing mutations is not allowed for DML batches.");
}
@Override
public ApiFuture<long[]> runBatchAsync() {
ConnectionPreconditions.checkState(
state == UnitOfWorkState.STARTED, "The batch is no longer active and cannot be ran");
if (statements.isEmpty()) {
this.state = UnitOfWorkState.RAN;
return ApiFutures.immediateFuture(new long[0]);
}
this.state = UnitOfWorkState.RUNNING;
// Use a SettableApiFuture to return the result, instead of directly returning the future that
// is returned by the executeBatchUpdateAsync method. This is needed because the state of the
// batch is set after the update has finished, and this happens in a listener. A listener is
// executed AFTER a Future is done, which means that a user could read the state of the Batch
// before it has been changed.
final SettableApiFuture<long[]> res = SettableApiFuture.create();
ApiFuture<long[]> updateCounts = transaction.executeBatchUpdateAsync(statements);
ApiFutures.addCallback(
updateCounts,
new ApiFutureCallback<long[]>() {
@Override
public void onFailure(Throwable t) {
state = UnitOfWorkState.RUN_FAILED;
res.setException(t);
}
@Override
public void onSuccess(long[] result) {
state = UnitOfWorkState.RAN;
res.set(result);
}
},
MoreExecutors.directExecutor());
return res;
}
@Override
public void abortBatch() {
ConnectionPreconditions.checkState(
state == UnitOfWorkState.STARTED, "The batch is no longer active and cannot be aborted.");
this.state = UnitOfWorkState.ABORTED;
}
@Override
public ApiFuture<Void> commitAsync() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Commit is not allowed for DML batches.");
}
@Override
public ApiFuture<Void> rollbackAsync() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Rollback is not allowed for DML batches.");
}
}