File tree

69 files changed

+9895
-687
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searcx below for content that may be hidden.

69 files changed

+9895
-687
lines changed
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@
9393
<className>com/google/cloud/spanner/DatabaseAdminClient</className>
9494
<method>com.google.cloud.spanner.Backup updateBackup(java.lang.String, java.lang.String, com.google.cloud.Timestamp)</method>
9595
</difference>
96-
9796
<difference>
9897
<differenceType>7012</differenceType>
9998
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
@@ -147,6 +146,88 @@
147146
<method>com.google.api.gax.paging.Page listDatabases()</method>
148147
</difference>
149148

149+
<!-- Add Async API -->
150+
<difference>
151+
<differenceType>7012</differenceType>
152+
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
153+
<method>com.google.api.core.ApiFuture executeQueryAsync(com.google.spanner.v1.ExecuteSqlRequest, java.util.Map)</method>
154+
</difference>
155+
<difference>
156+
<differenceType>7012</differenceType>
157+
<className>com/google/cloud/spanner/DatabaseClient</className>
158+
<method>* runAsync(*)</method>
159+
</difference>
160+
<difference>
161+
<differenceType>7012</differenceType>
162+
<className>com/google/cloud/spanner/DatabaseClient</className>
163+
<method>* transactionManagerAsync(*)</method>
164+
</difference>
165+
<difference>
166+
<differenceType>7012</differenceType>
167+
<className>com/google/cloud/spanner/Spanner</className>
168+
<method>* getAsyncExecutorProvider(*)</method>
169+
</difference>
170+
<difference>
171+
<differenceType>7012</differenceType>
172+
<className>com/google/cloud/spanner/ReadContext</className>
173+
<method>* executeQueryAsync(*)</method>
174+
</difference>
175+
<difference>
176+
<differenceType>7012</differenceType>
177+
<className>com/google/cloud/spanner/ReadContext</className>
178+
<method>* readAsync(*)</method>
179+
</difference>
180+
<difference>
181+
<differenceType>7012</differenceType>
182+
<className>com/google/cloud/spanner/ReadContext</className>
183+
<method>* readRowAsync(*)</method>
184+
</difference>
185+
<difference>
186+
<differenceType>7012</differenceType>
187+
<className>com/google/cloud/spanner/ReadContext</className>
188+
<method>* readUsingIndexAsync(*)</method>
189+
</difference>
190+
<difference>
191+
<differenceType>7012</differenceType>
192+
<className>com/google/cloud/spanner/ReadContext</className>
193+
<method>* readRowUsingIndexAsync(*)</method>
194+
</difference>
195+
<difference>
196+
<differenceType>7012</differenceType>
197+
<className>com/google/cloud/spanner/TransactionContext</className>
198+
<method>* batchUpdateAsync(*)</method>
199+
</difference>
200+
<difference>
201+
<differenceType>7012</differenceType>
202+
<className>com/google/cloud/spanner/TransactionContext</className>
203+
<method>* executeUpdateAsync(*)</method>
204+
</difference>
205+
<difference>
206+
<differenceType>7012</differenceType>
207+
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
208+
<method>* beginTransactionAsync(*)</method>
209+
</difference>
210+
<difference>
211+
<differenceType>7012</differenceType>
212+
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
213+
<method>* commitAsync(*)</method>
214+
</difference>
215+
<difference>
216+
<differenceType>7012</differenceType>
217+
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
218+
<method>* rollbackAsync(*)</method>
219+
</difference>
220+
<difference>
221+
<differenceType>7012</differenceType>
222+
<className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
223+
<method>* executeBatchDmlAsync(*)</method>
224+
</difference>
225+
<difference>
226+
<differenceType>7012</differenceType>
227+
<className>com/google/cloud/spanner/connection/Connection</className>
228+
<method>* executeQueryAsync(*)</method>
229+
</difference>
230+
150231
<!-- Adding operation RPCs to InstanceAdminClient. -->
151232
<difference>
152233
<differenceType>7012</differenceType>
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,24 @@
2121
import static com.google.common.base.Preconditions.checkNotNull;
2222
import static com.google.common.base.Preconditions.checkState;
2323

24+
import com.google.api.core.ApiFuture;
25+
import com.google.api.core.ApiFutureCallback;
26+
import com.google.api.core.ApiFutures;
27+
import com.google.api.core.SettableApiFuture;
28+
import com.google.api.gax.core.ExecutorProvider;
2429
import com.google.cloud.Timestamp;
2530
import com.google.cloud.spanner.AbstractResultSet.CloseableIterator;
2631
import com.google.cloud.spanner.AbstractResultSet.GrpcResultSet;
2732
import com.google.cloud.spanner.AbstractResultSet.GrpcStreamIterator;
2833
import com.google.cloud.spanner.AbstractResultSet.ResumableStreamIterator;
34+
import com.google.cloud.spanner.AsyncResultSet.CallbackResponse;
35+
import com.google.cloud.spanner.AsyncResultSet.ReadyCallback;
2936
import com.google.cloud.spanner.Options.QueryOption;
3037
import com.google.cloud.spanner.Options.ReadOption;
3138
import com.google.cloud.spanner.SessionImpl.SessionTransaction;
3239
import com.google.cloud.spanner.spi.v1.SpannerRpc;
3340
import com.google.common.annotations.VisibleForTesting;
41+
import com.google.common.util.concurrent.MoreExecutors;
3442
import com.google.protobuf.ByteString;
3543
import com.google.spanner.v1.BeginTransactionRequest;
3644
import com.google.spanner.v1.ExecuteBatchDmlRequest;
@@ -62,6 +70,7 @@ abstract static class Builder<B extends Builder<?, T>, T extends AbstractReadCon
6270
private Span span = Tracing.getTracer().getCurrentSpan();
6371
private int defaultPrefetchChunks = SpannerOptions.Builder.DEFAULT_PREFETCH_CHUNKS;
6472
private QueryOptions defaultQueryOptions = SpannerOptions.Builder.DEFAULT_QUERY_OPTIONS;
73+
private ExecutorProvider executorProvider;
6574

6675
Builder() {}
6776

@@ -95,9 +104,25 @@ B setDefaultQueryOptions(QueryOptions defaultQueryOptions) {
95104
return self();
96105
}
97106

107+
B setExecutorProvider(ExecutorProvider executorProvider) {
108+
this.executorProvider = executorProvider;
109+
return self();
110+
}
111+
98112
abstract T build();
99113
}
100114

115+
/**
116+
* {@link AsyncResultSet} that supports adding listeners that are called when all rows from the
117+
* underlying result stream have been fetched.
118+
*/
119+
interface ListenableAsyncResultSet extends AsyncResultSet {
120+
/** Adds a listener to this {@link AsyncResultSet}. */
121+
void addListener(Runnable listener);
122+
123+
void removeListener(Runnable listener);
124+
}
125+
101126
/**
102127
* A {@code ReadContext} for standalone reads. This can only be used for a single operation, since
103128
* each standalone read may see a different timestamp of Cloud Spanner data.
@@ -350,7 +375,8 @@ void initTransaction() {
350375
final Object lock = new Object();
351376
final SessionImpl session;
352377
final SpannerRpc rpc;
353-
final Span span;
378+
final ExecutorProvider executorProvider;
379+
Span span;
354380
private final int defaultPrefetchChunks;
355381
private final QueryOptions defaultQueryOptions;
356382

@@ -374,6 +400,12 @@ void initTransaction() {
374400
this.defaultPrefetchChunks = builder.defaultPrefetchChunks;
375401
this.defaultQueryOptions = builder.defaultQueryOptions;
376402
this.span = builder.span;
403+
this.executorProvider = builder.executorProvider;
404+
}
405+
406+
@Override
407+
public void setSpan(Span span) {
408+
this.span = span;
377409
}
378410

379411
long getSeqNo() {
@@ -386,12 +418,38 @@ public final ResultSet read(
386418
return readInternal(table, null, keys, columns, options);
387419
}
388420

421+
@Override
422+
public ListenableAsyncResultSet readAsync(
423+
String table, KeySet keys, Iterable<String> columns, ReadOption... options) {
424+
Options readOptions = Options.fromReadOptions(options);
425+
final int bufferRows =
426+
readOptions.hasBufferRows()
427+
? readOptions.bufferRows()
428+
: AsyncResultSetImpl.DEFAULT_BUFFER_SIZE;
429+
return new AsyncResultSetImpl(
430+
executorProvider, readInternal(table, null, keys, columns, options), bufferRows);
431+
}
432+
389433
@Override
390434
public final ResultSet readUsingIndex(
391435
String table, String index, KeySet keys, Iterable<String> columns, ReadOption... options) {
392436
return readInternal(table, checkNotNull(index), keys, columns, options);
393437
}
394438

439+
@Override
440+
public ListenableAsyncResultSet readUsingIndexAsync(
441+
String table, String index, KeySet keys, Iterable<String> columns, ReadOption... options) {
442+
Options readOptions = Options.fromReadOptions(options);
443+
final int bufferRows =
444+
readOptions.hasBufferRows()
445+
? readOptions.bufferRows()
446+
: AsyncResultSetImpl.DEFAULT_BUFFER_SIZE;
447+
return new AsyncResultSetImpl(
448+
executorProvider,
449+
readInternal(table, checkNotNull(index), keys, columns, options),
450+
bufferRows);
451+
}
452+
395453
@Nullable
396454
@Override
397455
public final Struct readRow(String table, Key key, Iterable<String> columns) {
@@ -400,6 +458,13 @@ public final Struct readRow(String table, Key key, Iterable<String> columns) {
400458
}
401459
}
402460

461+
@Override
462+
public final ApiFuture<Struct> readRowAsync(String table, Key key, Iterable<String> columns) {
463+
try (AsyncResultSet resultSet = readAsync(table, KeySet.singleKey(key), columns)) {
464+
return consumeSingleRowAsync(resultSet);
465+
}
466+
}
467+
403468
@Nullable
404469
@Override
405470
public final Struct readRowUsingIndex(
@@ -409,12 +474,35 @@ public final Struct readRowUsingIndex(
409474
}
410475
}
411476

477+
@Override
478+
public final ApiFuture<Struct> readRowUsingIndexAsync(
479+
String table, String index, Key key, Iterable<String> columns) {
480+
try (AsyncResultSet resultSet =
481+
readUsingIndexAsync(table, index, KeySet.singleKey(key), columns)) {
482+
return consumeSingleRowAsync(resultSet);
483+
}
484+
}
485+
412486
@Override
413487
public final ResultSet executeQuery(Statement statement, QueryOption... options) {
414488
return executeQueryInternal(
415489
statement, com.google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL, options);
416490
}
417491

492+
@Override
493+
public ListenableAsyncResultSet executeQueryAsync(Statement statement, QueryOption... options) {
494+
Options readOptions = Options.fromQueryOptions(options);
495+
final int bufferRows =
496+
readOptions.hasBufferRows()
497+
? readOptions.bufferRows()
498+
: AsyncResultSetImpl.DEFAULT_BUFFER_SIZE;
499+
return new AsyncResultSetImpl(
500+
executorProvider,
501+
executeQueryInternal(
502+
statement, com.google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL, options),
503+
bufferRows);
504+
}
505+
418506
@Override
419507
public final ResultSet analyzeQuery(Statement statement, QueryAnalyzeMode readContextQueryMode) {
420508
switch (readContextQueryMode) {
@@ -666,4 +754,71 @@ private Struct consumeSingleRow(ResultSet resultSet) {
666754
}
667755
return row;
668756
}
757+
758+
static ApiFuture<Struct> consumeSingleRowAsync(AsyncResultSet resultSet) {
759+
final SettableApiFuture<Struct> result = SettableApiFuture.create();
760+
// We can safely use a directExecutor here, as we will only be consuming one row, and we will
761+
// not be doing any blocking stuff in the handler.
762+
final SettableApiFuture<Struct> row = SettableApiFuture.create();
763+
ApiFutures.addCallback(
764+
resultSet.setCallback(MoreExecutors.directExecutor(), ConsumeSingleRowCallback.create(row)),
765+
new ApiFutureCallback<Void>() {
766+
@Override
767+
public void onFailure(Throwable t) {
768+
result.setException(t);
769+
}
770+
771+
@Override
772+
public void onSuccess(Void input) {
773+
try {
774+
result.set(row.get());
775+
} catch (Throwable t) {
776+
result.setException(t);
777+
}
778+
}
779+
},
780+
MoreExecutors.directExecutor());
781+
return result;
782+
}
783+
784+
/**
785+
* {@link ReadyCallback} for returning the first row in a result set as a future {@link Struct}.
786+
*/
787+
private static class ConsumeSingleRowCallback implements ReadyCallback {
788+
private final SettableApiFuture<Struct> result;
789+
private Struct row;
790+
791+
static ConsumeSingleRowCallback create(SettableApiFuture<Struct> result) {
792+
return new ConsumeSingleRowCallback(result);
793+
}
794+
795+
private ConsumeSingleRowCallback(SettableApiFuture<Struct> result) {
796+
this.result = result;
797+
}
798+
799+
@Override
800+
public CallbackResponse cursorReady(AsyncResultSet resultSet) {
801+
try {
802+
switch (resultSet.tryNext()) {
803+
case DONE:
804+
result.set(row);
805+
return CallbackResponse.DONE;
806+
case NOT_READY:
807+
return CallbackResponse.CONTINUE;
808+
case OK:
809+
if (row != null) {
810+
throw newSpannerException(
811+
ErrorCode.INTERNAL, "Multiple rows returned for single key");
812+
}
813+
row = resultSet.getCurrentRowAsStruct();
814+
return CallbackResponse.CONTINUE;
815+
default:
816+
throw new IllegalStateException();
817+
}
818+
} catch (Throwable t) {
819+
result.setException(t);
820+
return CallbackResponse.DONE;
821+
}
822+
}
823+
}
669824
}
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ private static Struct decodeStructValue(Type structType, ListValue structValue)
495495
return new GrpcStruct(structType, fields);
496496
}
497497

498-
private static Object decodeArrayValue(Type elementType, ListValue listValue) {
498+
static Object decodeArrayValue(Type elementType, ListValue listValue) {
499499
switch (elementType.getCode()) {
500500
case BOOL:
501501
// Use a view: element conversion is virtually free.
@@ -1009,7 +1009,7 @@ protected PartialResultSet computeNext() {
10091009
}
10101010
}
10111011

1012-
private static double valueProtoToFloat64(com.google.protobuf.Value proto) {
1012+
static double valueProtoToFloat64(com.google.protobuf.Value proto) {
10131013
if (proto.getKindCase() == KindCase.STRING_VALUE) {
10141014
switch (proto.getStringValue()) {
10151015
case "-Infinity":
@@ -1037,7 +1037,7 @@ private static double valueProtoToFloat64(com.google.protobuf.Value proto) {
10371037
return proto.getNumberValue();
10381038
}
10391039

1040-
private static NullPointerException throwNotNull(int columnIndex) {
1040+
static NullPointerException throwNotNull(int columnIndex) {
10411041
throw new NullPointerException(
10421042
"Cannot call array getter for column " + columnIndex + " with null elements");
10431043
}
@@ -1048,7 +1048,7 @@ private static NullPointerException throwNotNull(int columnIndex) {
10481048
* {@code BigDecimal} respectively. Rather than construct new wrapper objects for each array
10491049
* element, we use primitive arrays and a {@code BitSet} to track nulls.
10501050
*/
1051-
private abstract static class PrimitiveArray<T, A> extends AbstractList<T> {
1051+
abstract static class PrimitiveArray<T, A> extends AbstractList<T> {
10521052
private final A data;
10531053
private final BitSet nulls;
10541054
private final int size;
@@ -1103,7 +1103,7 @@ A toPrimitiveArray(int columnIndex) {
11031103
}
11041104
}
11051105

1106-
private static class Int64Array extends PrimitiveArray<Long, long[]> {
1106+
static class Int64Array extends PrimitiveArray<Long, long[]> {
11071107
Int64Array(ListValue protoList) {
11081108
super(protoList);
11091109
}
@@ -1128,7 +1128,7 @@ Long get(long[] array, int i) {
11281128
}
11291129
}
11301130

1131-
private static class Float64Array extends PrimitiveArray<Double, double[]> {
1131+
static class Float64Array extends PrimitiveArray<Double, double[]> {
11321132
Float64Array(ListValue protoList) {
11331133
super(protoList);
11341134
}

0 commit comments

Comments
 (0)