-
Notifications
You must be signed in to change notification settings - Fork 101
/
DdlBatch.java
299 lines (266 loc) · 10.8 KB
/
DdlBatch.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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
/*
* 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 static com.google.cloud.spanner.connection.AbstractStatementParser.RUN_BATCH_STATEMENT;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.Timestamp;
import com.google.cloud.spanner.CommitResponse;
import com.google.cloud.spanner.DatabaseClient;
import com.google.cloud.spanner.ErrorCode;
import com.google.cloud.spanner.Mutation;
import com.google.cloud.spanner.Options.QueryOption;
import com.google.cloud.spanner.Options.UpdateOption;
import com.google.cloud.spanner.ResultSet;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.connection.AbstractStatementParser.ParsedStatement;
import com.google.cloud.spanner.connection.AbstractStatementParser.StatementType;
import com.google.cloud.spanner.connection.Connection.InternalMetadataQuery;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.spanner.admin.database.v1.DatabaseAdminGrpc;
import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
import com.google.spanner.v1.SpannerGrpc;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Callable;
/**
* {@link UnitOfWork} that is used when a DDL batch is started. These batches only accept DDL
* statements. All DDL statements are buffered locally and sent to Spanner when runBatch() is
* called. Running a {@link DdlBatch} is not an atomic operation. If the execution fails, then some
* (possibly empty) prefix of the statements in the batch have been successfully applied to the
* database, and the others have not. Note that the statements that succeed may not all happen at
* the same time, but they will always happen in order.
*/
class DdlBatch extends AbstractBaseUnitOfWork {
private final DdlClient ddlClient;
private final DatabaseClient dbClient;
private final List<String> statements = new ArrayList<>();
private UnitOfWorkState state = UnitOfWorkState.STARTED;
static class Builder extends AbstractBaseUnitOfWork.Builder<Builder, DdlBatch> {
private DdlClient ddlClient;
private DatabaseClient dbClient;
private Builder() {}
Builder setDdlClient(DdlClient client) {
Preconditions.checkNotNull(client);
this.ddlClient = client;
return this;
}
Builder setDatabaseClient(DatabaseClient client) {
Preconditions.checkNotNull(client);
this.dbClient = client;
return this;
}
@Override
DdlBatch build() {
Preconditions.checkState(ddlClient != null, "No DdlClient specified");
Preconditions.checkState(dbClient != null, "No DbClient specified");
return new DdlBatch(this);
}
}
static Builder newBuilder() {
return new Builder();
}
private DdlBatch(Builder builder) {
super(builder);
this.ddlClient = builder.ddlClient;
this.dbClient = builder.dbClient;
}
@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;
}
public ApiFuture<ResultSet> executeQueryAsync(
final ParsedStatement statement, AnalyzeMode analyzeMode, QueryOption... options) {
if (options != null) {
for (int i = 0; i < options.length; i++) {
if (options[i] instanceof InternalMetadataQuery) {
Preconditions.checkNotNull(statement);
Preconditions.checkArgument(statement.isQuery(), "Statement is not a query");
Preconditions.checkArgument(
analyzeMode == AnalyzeMode.NONE, "Analyze is not allowed for DDL batch");
// Queries marked with internal metadata queries are allowed during a DDL batch.
// These can only be generated by library internal methods and may be used to check
// whether a database object such as table or an index exists.
List<QueryOption> temp = new ArrayList<>();
Collections.addAll(temp, options);
temp.remove(i);
final QueryOption[] internalOptions = temp.toArray(new QueryOption[0]);
Callable<ResultSet> callable =
() ->
DirectExecuteResultSet.ofResultSet(
dbClient.singleUse().executeQuery(statement.getStatement(), internalOptions));
return executeStatementAsync(
statement, callable, SpannerGrpc.getExecuteStreamingSqlMethod());
}
}
}
// Queries are by default not allowed on DDL batches.
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing queries is not allowed for DDL batches.");
}
@Override
public Timestamp getReadTimestamp() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no read timestamp available for DDL batches.");
}
@Override
public Timestamp getReadTimestampOrNull() {
return null;
}
@Override
public Timestamp getCommitTimestamp() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no commit timestamp available for DDL batches.");
}
@Override
public Timestamp getCommitTimestampOrNull() {
return null;
}
@Override
public CommitResponse getCommitResponse() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "There is no commit response available for DDL batches.");
}
@Override
public CommitResponse getCommitResponseOrNull() {
return null;
}
@Override
public ApiFuture<Void> executeDdlAsync(ParsedStatement ddl) {
ConnectionPreconditions.checkState(
state == UnitOfWorkState.STARTED,
"The batch is no longer active and cannot be used for further statements");
Preconditions.checkArgument(
ddl.getType() == StatementType.DDL,
"Only DDL statements are allowed. \""
+ ddl.getSqlWithoutComments()
+ "\" is not a DDL-statement.");
Preconditions.checkArgument(
!DdlClient.isCreateDatabaseStatement(ddl.getSqlWithoutComments()),
"CREATE DATABASE is not supported in DDL batches.");
statements.add(ddl.getSqlWithoutComments());
return ApiFutures.immediateFuture(null);
}
@Override
public ApiFuture<Long> executeUpdateAsync(ParsedStatement update, UpdateOption... options) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing updates is not allowed for DDL batches.");
}
@Override
public ApiFuture<ResultSet> analyzeUpdateAsync(
ParsedStatement update, AnalyzeMode analyzeMode, UpdateOption... options) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Analyzing updates is not allowed for DDL batches.");
}
@Override
public ApiFuture<long[]> executeBatchUpdateAsync(
Iterable<ParsedStatement> updates, UpdateOption... options) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Executing batch updates is not allowed for DDL batches.");
}
@Override
public ApiFuture<Void> writeAsync(Iterable<Mutation> mutations) {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Writing mutations is not allowed for DDL 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]);
}
// create a statement that can be passed in to the execute method
Callable<long[]> callable =
() -> {
try {
OperationFuture<Void, UpdateDatabaseDdlMetadata> operation =
ddlClient.executeDdl(statements);
try {
// Wait until the operation has finished.
getWithStatementTimeout(operation, RUN_BATCH_STATEMENT);
long[] updateCounts = new long[statements.size()];
Arrays.fill(updateCounts, 1L);
state = UnitOfWorkState.RAN;
return updateCounts;
} catch (SpannerException e) {
long[] updateCounts = extractUpdateCounts(operation);
throw SpannerExceptionFactory.newSpannerBatchUpdateException(
e.getErrorCode(), e.getMessage(), updateCounts);
}
} catch (Throwable t) {
state = UnitOfWorkState.RUN_FAILED;
throw t;
}
};
this.state = UnitOfWorkState.RUNNING;
return executeStatementAsync(
RUN_BATCH_STATEMENT, callable, DatabaseAdminGrpc.getUpdateDatabaseDdlMethod());
}
long[] extractUpdateCounts(OperationFuture<Void, UpdateDatabaseDdlMetadata> operation) {
try {
return extractUpdateCounts(operation.getMetadata().get());
} catch (Throwable t) {
return new long[0];
}
}
@VisibleForTesting
long[] extractUpdateCounts(UpdateDatabaseDdlMetadata metadata) {
long[] updateCounts = new long[metadata.getStatementsCount()];
for (int i = 0; i < updateCounts.length; i++) {
if (metadata.getCommitTimestampsCount() > i && metadata.getCommitTimestamps(i) != null) {
updateCounts[i] = 1L;
} else {
updateCounts[i] = 0L;
}
}
return updateCounts;
}
@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 DDL batches.");
}
@Override
public ApiFuture<Void> rollbackAsync() {
throw SpannerExceptionFactory.newSpannerException(
ErrorCode.FAILED_PRECONDITION, "Rollback is not allowed for DDL batches.");
}
}