/
JdbcConnection.java
554 lines (489 loc) · 16.8 KB
/
JdbcConnection.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
/*
* 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.jdbc;
import com.google.api.client.util.Preconditions;
import com.google.cloud.spanner.Mutation;
import com.google.cloud.spanner.SpannerException;
import com.google.cloud.spanner.TimestampBound;
import com.google.cloud.spanner.connection.AutocommitDmlMode;
import com.google.cloud.spanner.connection.ConnectionOptions;
import com.google.cloud.spanner.connection.StatementParser;
import com.google.cloud.spanner.connection.TransactionMode;
import com.google.common.base.Function;
import com.google.common.collect.Iterators;
import java.sql.Array;
import java.sql.Blob;
import java.sql.Clob;
import java.sql.DatabaseMetaData;
import java.sql.NClob;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Timestamp;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
/** Jdbc Connection class for Google Cloud Spanner */
class JdbcConnection extends AbstractJdbcConnection {
private static final String ONLY_RS_FORWARD_ONLY =
"Only result sets of type TYPE_FORWARD_ONLY are supported";
private static final String ONLY_CONCUR_READ_ONLY =
"Only result sets with concurrency CONCUR_READ_ONLY are supported";
private static final String ONLY_CLOSE_CURSORS_AT_COMMIT =
"Only result sets with holdability CLOSE_CURSORS_AT_COMMIT are supported";
static final String ONLY_NO_GENERATED_KEYS = "Only NO_GENERATED_KEYS are supported";
static final String IS_VALID_QUERY = "SELECT 1";
private Map<String, Class<?>> typeMap = new HashMap<>();
JdbcConnection(String connectionUrl, ConnectionOptions options) {
super(connectionUrl, options);
}
@Override
public Statement createStatement() throws SQLException {
checkClosed();
return new JdbcStatement(this);
}
@Override
public JdbcPreparedStatement prepareStatement(String sql) throws SQLException {
checkClosed();
return new JdbcPreparedStatement(this, sql);
}
@Override
public String nativeSQL(String sql) throws SQLException {
checkClosed();
return JdbcParameterStore.convertPositionalParametersToNamedParameters(
StatementParser.removeCommentsAndTrim(sql))
.sqlWithNamedParameters;
}
@Override
public void setTransactionMode(TransactionMode mode) throws SQLException {
checkClosed();
getSpannerConnection().setTransactionMode(mode);
}
@Override
public TransactionMode getTransactionMode() throws SQLException {
checkClosed();
return getSpannerConnection().getTransactionMode();
}
@Override
public void setAutocommitDmlMode(AutocommitDmlMode mode) throws SQLException {
checkClosed();
getSpannerConnection().setAutocommitDmlMode(mode);
}
@Override
public AutocommitDmlMode getAutocommitDmlMode() throws SQLException {
checkClosed();
return getSpannerConnection().getAutocommitDmlMode();
}
@Override
public void setReadOnlyStaleness(TimestampBound staleness) throws SQLException {
checkClosed();
getSpannerConnection().setReadOnlyStaleness(staleness);
}
@Override
public TimestampBound getReadOnlyStaleness() throws SQLException {
checkClosed();
return getSpannerConnection().getReadOnlyStaleness();
}
@Override
public void setOptimizerVersion(String optimizerVersion) throws SQLException {
checkClosed();
getSpannerConnection().setOptimizerVersion(optimizerVersion);
}
@Override
public String getOptimizerVersion() throws SQLException {
checkClosed();
return getSpannerConnection().getOptimizerVersion();
}
@Override
public boolean isInTransaction() throws SQLException {
checkClosed();
return getSpannerConnection().isInTransaction();
}
@Override
public boolean isTransactionStarted() throws SQLException {
checkClosed();
return getSpannerConnection().isTransactionStarted();
}
@Override
public void setAutoCommit(boolean autoCommit) throws SQLException {
checkClosed();
try {
// According to the JDBC spec's we need to commit the current transaction when changing
// autocommit mode.
if (getSpannerConnection().isAutocommit() != autoCommit
&& getSpannerConnection().isTransactionStarted()) {
commit();
}
getSpannerConnection().setAutocommit(autoCommit);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public boolean getAutoCommit() throws SQLException {
checkClosed();
return getSpannerConnection().isAutocommit();
}
@Override
public void commit() throws SQLException {
checkClosed();
try {
getSpannerConnection().commit();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void rollback() throws SQLException {
checkClosed();
try {
getSpannerConnection().rollback();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void close() throws SQLException {
try {
getSpannerConnection().close();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public boolean isClosed() throws SQLException {
return getSpannerConnection().isClosed();
}
@Override
public DatabaseMetaData getMetaData() throws SQLException {
checkClosed();
return new JdbcDatabaseMetaData(this);
}
@Override
public void setReadOnly(boolean readOnly) throws SQLException {
checkClosed();
try {
getSpannerConnection().setReadOnly(readOnly);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public boolean isReadOnly() throws SQLException {
checkClosed();
return getSpannerConnection().isReadOnly();
}
@Override
public Statement createStatement(int resultSetType, int resultSetConcurrency)
throws SQLException {
checkClosed();
JdbcPreconditions.checkSqlFeatureSupported(
resultSetType == ResultSet.TYPE_FORWARD_ONLY, ONLY_RS_FORWARD_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetConcurrency == ResultSet.CONCUR_READ_ONLY, ONLY_CONCUR_READ_ONLY);
return createStatement();
}
@Override
public Statement createStatement(
int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException {
checkClosed();
JdbcPreconditions.checkSqlFeatureSupported(
resultSetType == ResultSet.TYPE_FORWARD_ONLY, ONLY_RS_FORWARD_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetConcurrency == ResultSet.CONCUR_READ_ONLY, ONLY_CONCUR_READ_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetHoldability == ResultSet.CLOSE_CURSORS_AT_COMMIT, ONLY_CLOSE_CURSORS_AT_COMMIT);
return createStatement();
}
@Override
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
throws SQLException {
checkClosed();
JdbcPreconditions.checkSqlFeatureSupported(
resultSetType == ResultSet.TYPE_FORWARD_ONLY, ONLY_RS_FORWARD_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetConcurrency == ResultSet.CONCUR_READ_ONLY, ONLY_CONCUR_READ_ONLY);
return prepareStatement(sql);
}
@Override
public PreparedStatement prepareStatement(
String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
throws SQLException {
checkClosed();
JdbcPreconditions.checkSqlFeatureSupported(
resultSetType == ResultSet.TYPE_FORWARD_ONLY, ONLY_RS_FORWARD_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetConcurrency == ResultSet.CONCUR_READ_ONLY, ONLY_CONCUR_READ_ONLY);
JdbcPreconditions.checkSqlFeatureSupported(
resultSetHoldability == ResultSet.CLOSE_CURSORS_AT_COMMIT, ONLY_CLOSE_CURSORS_AT_COMMIT);
return prepareStatement(sql);
}
@Override
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException {
checkClosed();
JdbcPreconditions.checkSqlFeatureSupported(
autoGeneratedKeys == Statement.NO_GENERATED_KEYS, ONLY_NO_GENERATED_KEYS);
return prepareStatement(sql);
}
@Override
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException {
checkClosed();
return prepareStatement(sql);
}
@Override
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException {
checkClosed();
return prepareStatement(sql);
}
@Override
public Map<String, Class<?>> getTypeMap() throws SQLException {
checkClosed();
return new HashMap<>(typeMap);
}
@Override
public void setTypeMap(Map<String, Class<?>> map) throws SQLException {
checkClosed();
this.typeMap = new HashMap<>(map);
}
@Override
public boolean isValid(int timeout) throws SQLException {
JdbcPreconditions.checkArgument(timeout >= 0, "timeout must be >= 0");
if (!isClosed()) {
try {
Statement statement = createStatement();
statement.setQueryTimeout(timeout);
try (ResultSet rs = statement.executeQuery(IS_VALID_QUERY)) {
if (rs.next()) {
if (rs.getLong(1) == 1L) {
return true;
}
}
}
} catch (SQLException e) {
// ignore
}
}
return false;
}
@Override
public Blob createBlob() throws SQLException {
checkClosed();
return new JdbcBlob();
}
@Override
public Clob createClob() throws SQLException {
checkClosed();
return new JdbcClob();
}
@Override
public NClob createNClob() throws SQLException {
checkClosed();
return new JdbcClob();
}
@Override
public Array createArrayOf(String typeName, Object[] elements) throws SQLException {
checkClosed();
return JdbcArray.createArray(typeName, elements);
}
@Override
public void setCatalog(String catalog) throws SQLException {
// This method could be changed to allow the user to change to another database.
// For now we only support setting an empty string in order to support frameworks
// and applications that set this when no catalog has been specified in the connection
// URL.
checkClosed();
JdbcPreconditions.checkArgument("".equals(catalog), "Only catalog \"\" is supported");
}
@Override
public String getCatalog() throws SQLException {
checkClosed();
return "";
}
@Override
public void setSchema(String schema) throws SQLException {
checkClosed();
// Cloud Spanner does not support schemas, but does contain a pseudo 'empty string' schema that
// might be set by frameworks and applications that read the database metadata.
JdbcPreconditions.checkArgument("".equals(schema), "Only schema \"\" is supported");
}
@Override
public String getSchema() throws SQLException {
checkClosed();
return "";
}
@Override
public Timestamp getCommitTimestamp() throws SQLException {
checkClosed();
try {
return getSpannerConnection().getCommitTimestamp().toSqlTimestamp();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public Timestamp getReadTimestamp() throws SQLException {
checkClosed();
try {
return getSpannerConnection().getReadTimestamp().toSqlTimestamp();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public boolean isRetryAbortsInternally() throws SQLException {
checkClosed();
try {
return getSpannerConnection().isRetryAbortsInternally();
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void setRetryAbortsInternally(boolean retryAbortsInternally) throws SQLException {
checkClosed();
try {
getSpannerConnection().setRetryAbortsInternally(retryAbortsInternally);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void write(Mutation mutation) throws SQLException {
checkClosed();
try {
getSpannerConnection().write(mutation);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void write(Iterable<Mutation> mutations) throws SQLException {
checkClosed();
try {
getSpannerConnection().write(mutations);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void bufferedWrite(Mutation mutation) throws SQLException {
checkClosed();
try {
getSpannerConnection().bufferedWrite(mutation);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@Override
public void bufferedWrite(Iterable<Mutation> mutations) throws SQLException {
checkClosed();
try {
getSpannerConnection().bufferedWrite(mutations);
} catch (SpannerException e) {
throw JdbcSqlExceptionFactory.of(e);
}
}
@SuppressWarnings("deprecation")
private static final class JdbcToSpannerTransactionRetryListener
implements com.google.cloud.spanner.connection.TransactionRetryListener {
private final TransactionRetryListener delegate;
JdbcToSpannerTransactionRetryListener(TransactionRetryListener delegate) {
this.delegate = Preconditions.checkNotNull(delegate);
}
@Override
public void retryStarting(
com.google.cloud.Timestamp transactionStarted, long transactionId, int retryAttempt) {
delegate.retryStarting(transactionStarted, transactionId, retryAttempt);
}
@Override
public void retryFinished(
com.google.cloud.Timestamp transactionStarted,
long transactionId,
int retryAttempt,
RetryResult result) {
delegate.retryFinished(
transactionStarted,
transactionId,
retryAttempt,
TransactionRetryListener.RetryResult.valueOf(result.name()));
}
@Override
public boolean equals(Object o) {
if (!(o instanceof JdbcToSpannerTransactionRetryListener)) {
return false;
}
JdbcToSpannerTransactionRetryListener other = (JdbcToSpannerTransactionRetryListener) o;
return this.delegate.equals(other.delegate);
}
@Override
public int hashCode() {
return delegate.hashCode();
}
}
@SuppressWarnings("deprecation")
@Override
public void addTransactionRetryListener(TransactionRetryListener listener) throws SQLException {
checkClosed();
getSpannerConnection()
.addTransactionRetryListener(new JdbcToSpannerTransactionRetryListener(listener));
}
@Override
public void addTransactionRetryListener(
com.google.cloud.spanner.connection.TransactionRetryListener listener) throws SQLException {
checkClosed();
getSpannerConnection().addTransactionRetryListener(listener);
}
@SuppressWarnings("deprecation")
@Override
public boolean removeTransactionRetryListener(TransactionRetryListener listener)
throws SQLException {
checkClosed();
return getSpannerConnection()
.removeTransactionRetryListener(new JdbcToSpannerTransactionRetryListener(listener));
}
@Override
public boolean removeTransactionRetryListener(
com.google.cloud.spanner.connection.TransactionRetryListener listener) throws SQLException {
checkClosed();
return getSpannerConnection().removeTransactionRetryListener(listener);
}
@SuppressWarnings("deprecation")
@Override
public Iterator<TransactionRetryListener> getTransactionRetryListeners() throws SQLException {
checkClosed();
return Iterators.transform(
getSpannerConnection().getTransactionRetryListeners(),
new Function<
com.google.cloud.spanner.connection.TransactionRetryListener,
TransactionRetryListener>() {
@Override
public TransactionRetryListener apply(
com.google.cloud.spanner.connection.TransactionRetryListener input) {
if (input instanceof JdbcToSpannerTransactionRetryListener) {
return ((JdbcToSpannerTransactionRetryListener) input).delegate;
}
return null;
}
});
}
@Override
public Iterator<com.google.cloud.spanner.connection.TransactionRetryListener>
getTransactionRetryListenersFromConnection() throws SQLException {
checkClosed();
return getSpannerConnection().getTransactionRetryListeners();
}
}