Skip to content

feat: add support for BatchWriteAtLeastOnce #2520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
7ff7cb2
feat: add support for BatchWriteAtleastOnce
rajatbhatta Jun 5, 2023
43c4f63
test: add batchwrite() support to MockSpannerServiceImpl
rajatbhatta Jun 5, 2023
abedd15
test: add commit timestamp to proto
rajatbhatta Jun 5, 2023
21d8f67
test: add commit timestamp to proto
rajatbhatta Jun 5, 2023
4858965
test: add commit timestamp to proto
rajatbhatta Jun 12, 2023
81743a7
consume the stream in tests
rajatbhatta Jun 12, 2023
65abc96
refactor tests
rajatbhatta Jun 12, 2023
8d76346
refactor tests
rajatbhatta Jun 14, 2023
a3569ae
test if mutations are correctly applied
rajatbhatta Jun 20, 2023
4cb0ada
null check
rajatbhatta Jun 20, 2023
5401b7d
skip for emulator
rajatbhatta Jun 20, 2023
5103b5c
Merge branch 'googleapis:main' into batch-write
rajatbhatta Jun 20, 2023
95c3326
add method documentation
rajatbhatta Jun 20, 2023
5678207
add method documentation
rajatbhatta Jun 20, 2023
347e9c3
add method documentation
rajatbhatta Jun 20, 2023
4c7251f
Merge branch 'googleapis:main' into batch-write
rajatbhatta Jul 6, 2023
1deaa29
remove autogenerated code
rajatbhatta Jul 6, 2023
acece36
remove autogenerated tests
rajatbhatta Jul 6, 2023
5f04154
batchWriteAtleastOnce -> batchWriteAtLeastOnce
rajatbhatta Jul 6, 2023
8e15c5c
batchWriteAtleastOnceWithOptions -> batchWriteAtLeastOnceWithOptions
rajatbhatta Jul 6, 2023
56f3929
changes based on updated batch write API
rajatbhatta Aug 17, 2023
356849e
add copyright and doc
rajatbhatta Aug 17, 2023
07f3bfb
Merge branch 'main' into batch-write-review
rajatbhatta Aug 17, 2023
1ca0d31
address review comments
rajatbhatta Aug 22, 2023
c3e3d7b
address review comments
rajatbhatta Aug 22, 2023
a036ced
add more documentation
rajatbhatta Aug 25, 2023
d8ef791
Merge branch 'googleapis:main' into batch-write-review
rajatbhatta Sep 18, 2023
7c4c73d
Merge branch 'googleapis:main' into batch-write-review
arpan14 Sep 26, 2023
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove autogenerated code
  • Loading branch information
rajatbhatta committed Jul 6, 2023
commit 1deaa29a762ef53add0a3e8979e070ae07050cb3
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
Expand Down Expand Up @@ -1270,41 +1268,6 @@ public final ServerStreamingCallable<ReadRequest, PartialResultSet> streamingRea
return stub.streamingReadCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Batches the supplied mutations in a collection of efficient transactions. The mutations are
* applied non-atomically in an unspecified order and thus, they must be independent of each
* other. Partial failure is possible, i.e., some mutations may have been applied successfully,
* while some may have failed. The results of individual batches are streamed into the response as
* and when the batches are applied.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpannerClient spannerClient = SpannerClient.create()) {
* BatchWriteRequest request =
* BatchWriteRequest.newBuilder()
* .setSession(
* SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
* .addAllMutations(new ArrayList<Mutation>())
* .setRequestOptions(RequestOptions.newBuilder().build())
* .build();
* ServerStream<BatchWriteResponse> stream = spannerClient.batchWriteCallable().call(request);
* for (BatchWriteResponse response : stream) {
* // Do something when a response is received.
* }
* }
* }</pre>
*/
public final ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable() {
return stub.batchWriteCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Begins a new transaction. This step can often be skipped:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
Expand Down Expand Up @@ -154,11 +152,6 @@ public ServerStreamingCallSettings<ReadRequest, PartialResultSet> streamingReadS
return ((SpannerStubSettings) getStubSettings()).streamingReadSettings();
}

/** Returns the object with the settings used for calls to batchWrite. */
public ServerStreamingCallSettings<BatchWriteRequest, BatchWriteResponse> batchWriteSettings() {
return ((SpannerStubSettings) getStubSettings()).batchWriteSettings();
}

/** Returns the object with the settings used for calls to beginTransaction. */
public UnaryCallSettings<BeginTransactionRequest, Transaction> beginTransactionSettings() {
return ((SpannerStubSettings) getStubSettings()).beginTransactionSettings();
Expand Down Expand Up @@ -354,12 +347,6 @@ public UnaryCallSettings.Builder<ReadRequest, ResultSet> readSettings() {
return getStubSettingsBuilder().streamingReadSettings();
}

/** Returns the builder for the settings used for calls to batchWrite. */
public ServerStreamingCallSettings.Builder<BatchWriteRequest, BatchWriteResponse>
batchWriteSettings() {
return getStubSettingsBuilder().batchWriteSettings();
}

/** Returns the builder for the settings used for calls to beginTransaction. */
public UnaryCallSettings.Builder<BeginTransactionRequest, Transaction>
beginTransactionSettings() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
"BatchCreateSessions": {
"methods": ["batchCreateSessions", "batchCreateSessions", "batchCreateSessions", "batchCreateSessionsCallable"]
},
"BatchWrite": {
"methods": ["batchWriteCallable"]
},
"BeginTransaction": {
"methods": ["beginTransaction", "beginTransaction", "beginTransaction", "beginTransactionCallable"]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
Expand Down Expand Up @@ -158,15 +156,6 @@ public class GrpcSpannerStub extends SpannerStub {
.setResponseMarshaller(ProtoUtils.marshaller(PartialResultSet.getDefaultInstance()))
.build();

private static final MethodDescriptor<BatchWriteRequest, BatchWriteResponse>
batchWriteMethodDescriptor =
MethodDescriptor.<BatchWriteRequest, BatchWriteResponse>newBuilder()
.setType(MethodDescriptor.MethodType.SERVER_STREAMING)
.setFullMethodName("google.spanner.v1.Spanner/BatchWrite")
.setRequestMarshaller(ProtoUtils.marshaller(BatchWriteRequest.getDefaultInstance()))
.setResponseMarshaller(ProtoUtils.marshaller(BatchWriteResponse.getDefaultInstance()))
.build();

private static final MethodDescriptor<BeginTransactionRequest, Transaction>
beginTransactionMethodDescriptor =
MethodDescriptor.<BeginTransactionRequest, Transaction>newBuilder()
Expand Down Expand Up @@ -228,7 +217,6 @@ public class GrpcSpannerStub extends SpannerStub {
executeBatchDmlCallable;
private final UnaryCallable<ReadRequest, ResultSet> readCallable;
private final ServerStreamingCallable<ReadRequest, PartialResultSet> streamingReadCallable;
private final ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable;
private final UnaryCallable<BeginTransactionRequest, Transaction> beginTransactionCallable;
private final UnaryCallable<CommitRequest, CommitResponse> commitCallable;
private final UnaryCallable<RollbackRequest, Empty> rollbackCallable;
Expand Down Expand Up @@ -376,16 +364,6 @@ protected GrpcSpannerStub(
return params.build();
})
.build();
GrpcCallSettings<BatchWriteRequest, BatchWriteResponse> batchWriteTransportSettings =
GrpcCallSettings.<BatchWriteRequest, BatchWriteResponse>newBuilder()
.setMethodDescriptor(batchWriteMethodDescriptor)
.setParamsExtractor(
request -> {
ImmutableMap.Builder<String, String> params = ImmutableMap.builder();
params.put("session", String.valueOf(request.getSession()));
return params.build();
})
.build();
GrpcCallSettings<BeginTransactionRequest, Transaction> beginTransactionTransportSettings =
GrpcCallSettings.<BeginTransactionRequest, Transaction>newBuilder()
.setMethodDescriptor(beginTransactionMethodDescriptor)
Expand Down Expand Up @@ -474,9 +452,6 @@ protected GrpcSpannerStub(
this.streamingReadCallable =
callableFactory.createServerStreamingCallable(
streamingReadTransportSettings, settings.streamingReadSettings(), clientContext);
this.batchWriteCallable =
callableFactory.createServerStreamingCallable(
batchWriteTransportSettings, settings.batchWriteSettings(), clientContext);
this.beginTransactionCallable =
callableFactory.createUnaryCallable(
beginTransactionTransportSettings, settings.beginTransactionSettings(), clientContext);
Expand Down Expand Up @@ -558,11 +533,6 @@ public ServerStreamingCallable<ReadRequest, PartialResultSet> streamingReadCalla
return streamingReadCallable;
}

@Override
public ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable() {
return batchWriteCallable;
}

@Override
public UnaryCallable<BeginTransactionRequest, Transaction> beginTransactionCallable() {
return beginTransactionCallable;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@
import com.google.protobuf.TypeRegistry;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
Expand Down Expand Up @@ -436,43 +434,6 @@ public class HttpJsonSpannerStub extends SpannerStub {
.build())
.build();

private static final ApiMethodDescriptor<BatchWriteRequest, BatchWriteResponse>
batchWriteMethodDescriptor =
ApiMethodDescriptor.<BatchWriteRequest, BatchWriteResponse>newBuilder()
.setFullMethodName("google.spanner.v1.Spanner/BatchWrite")
.setHttpMethod("POST")
.setType(ApiMethodDescriptor.MethodType.SERVER_STREAMING)
.setRequestFormatter(
ProtoMessageRequestFormatter.<BatchWriteRequest>newBuilder()
.setPath(
"/v1/{session=projects/*/instances/*/databases/*/sessions/*}:batchWrite",
request -> {
Map<String, String> fields = new HashMap<>();
ProtoRestSerializer<BatchWriteRequest> serializer =
ProtoRestSerializer.create();
serializer.putPathParam(fields, "session", request.getSession());
return fields;
})
.setQueryParamsExtractor(
request -> {
Map<String, List<String>> fields = new HashMap<>();
ProtoRestSerializer<BatchWriteRequest> serializer =
ProtoRestSerializer.create();
serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int");
return fields;
})
.setRequestBodyExtractor(
request ->
ProtoRestSerializer.create()
.toBody("*", request.toBuilder().clearSession().build(), true))
.build())
.setResponseParser(
ProtoMessageResponseParser.<BatchWriteResponse>newBuilder()
.setDefaultInstance(BatchWriteResponse.getDefaultInstance())
.setDefaultTypeRegistry(typeRegistry)
.build())
.build();

private static final ApiMethodDescriptor<BeginTransactionRequest, Transaction>
beginTransactionMethodDescriptor =
ApiMethodDescriptor.<BeginTransactionRequest, Transaction>newBuilder()
Expand Down Expand Up @@ -671,7 +632,6 @@ public class HttpJsonSpannerStub extends SpannerStub {
executeBatchDmlCallable;
private final UnaryCallable<ReadRequest, ResultSet> readCallable;
private final ServerStreamingCallable<ReadRequest, PartialResultSet> streamingReadCallable;
private final ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable;
private final UnaryCallable<BeginTransactionRequest, Transaction> beginTransactionCallable;
private final UnaryCallable<CommitRequest, CommitResponse> commitCallable;
private final UnaryCallable<RollbackRequest, Empty> rollbackCallable;
Expand Down Expand Up @@ -770,11 +730,6 @@ protected HttpJsonSpannerStub(
.setMethodDescriptor(streamingReadMethodDescriptor)
.setTypeRegistry(typeRegistry)
.build();
HttpJsonCallSettings<BatchWriteRequest, BatchWriteResponse> batchWriteTransportSettings =
HttpJsonCallSettings.<BatchWriteRequest, BatchWriteResponse>newBuilder()
.setMethodDescriptor(batchWriteMethodDescriptor)
.setTypeRegistry(typeRegistry)
.build();
HttpJsonCallSettings<BeginTransactionRequest, Transaction> beginTransactionTransportSettings =
HttpJsonCallSettings.<BeginTransactionRequest, Transaction>newBuilder()
.setMethodDescriptor(beginTransactionMethodDescriptor)
Expand Down Expand Up @@ -838,9 +793,6 @@ protected HttpJsonSpannerStub(
this.streamingReadCallable =
callableFactory.createServerStreamingCallable(
streamingReadTransportSettings, settings.streamingReadSettings(), clientContext);
this.batchWriteCallable =
callableFactory.createServerStreamingCallable(
batchWriteTransportSettings, settings.batchWriteSettings(), clientContext);
this.beginTransactionCallable =
callableFactory.createUnaryCallable(
beginTransactionTransportSettings, settings.beginTransactionSettings(), clientContext);
Expand Down Expand Up @@ -874,7 +826,6 @@ public static List<ApiMethodDescriptor> getMethodDescriptors() {
methodDescriptors.add(executeBatchDmlMethodDescriptor);
methodDescriptors.add(readMethodDescriptor);
methodDescriptors.add(streamingReadMethodDescriptor);
methodDescriptors.add(batchWriteMethodDescriptor);
methodDescriptors.add(beginTransactionMethodDescriptor);
methodDescriptors.add(commitMethodDescriptor);
methodDescriptors.add(rollbackMethodDescriptor);
Expand Down Expand Up @@ -940,11 +891,6 @@ public ServerStreamingCallable<ReadRequest, PartialResultSet> streamingReadCalla
return streamingReadCallable;
}

@Override
public ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable() {
return batchWriteCallable;
}

@Override
public UnaryCallable<BeginTransactionRequest, Transaction> beginTransactionCallable() {
return beginTransactionCallable;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
Expand Down Expand Up @@ -103,10 +101,6 @@ public ServerStreamingCallable<ReadRequest, PartialResultSet> streamingReadCalla
throw new UnsupportedOperationException("Not implemented: streamingReadCallable()");
}

public ServerStreamingCallable<BatchWriteRequest, BatchWriteResponse> batchWriteCallable() {
throw new UnsupportedOperationException("Not implemented: batchWriteCallable()");
}

public UnaryCallable<BeginTransactionRequest, Transaction> beginTransactionCallable() {
throw new UnsupportedOperationException("Not implemented: beginTransactionCallable()");
}
Expand Down
Loading