Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit d22cf07

Browse files
yoshi-automationyoshi-automation
committed
feat: add option for returning Spanner commit stats
PiperOrigin-RevId: 353145174 Source-Author: Google APIs <[email protected]> Source-Date: Thu Jan 21 18:06:01 2021 -0800 Source-Repo: googleapis/googleapis Source-Sha: 8fa381b7138f1d72966ff20563efae1b2194d359 Source-Link: googleapis/googleapis@8fa381b
1 parent 4aa770c commit d22cf07

18 files changed

Lines changed: 1558 additions & 315 deletions

File tree

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -724,6 +724,11 @@ public final UnaryCallable<BeginTransactionRequest, Transaction> beginTransactio
724724
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
725725
* beginning, re-using the same session.
726726
*
727+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
728+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
729+
* track of the transaction outcome and we recommend that you perform another read from the
730+
* database to see the state of things as they are now.
731+
*
727732
* @param session Required. The session in which the transaction to be committed is running.
728733
* @param transactionId Commit a previously-started transaction.
729734
* @param mutations The mutations to be executed when this transaction commits. All mutations are
@@ -751,6 +756,11 @@ public final CommitResponse commit(
751756
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
752757
* beginning, re-using the same session.
753758
*
759+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
760+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
761+
* track of the transaction outcome and we recommend that you perform another read from the
762+
* database to see the state of things as they are now.
763+
*
754764
* @param session Required. The session in which the transaction to be committed is running.
755765
* @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike
756766
* commit of a previously-started transaction, commit with a temporary transaction is
@@ -784,6 +794,11 @@ public final CommitResponse commit(
784794
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
785795
* beginning, re-using the same session.
786796
*
797+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
798+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
799+
* track of the transaction outcome and we recommend that you perform another read from the
800+
* database to see the state of things as they are now.
801+
*
787802
* @param session Required. The session in which the transaction to be committed is running.
788803
* @param transactionId Commit a previously-started transaction.
789804
* @param mutations The mutations to be executed when this transaction commits. All mutations are
@@ -811,6 +826,11 @@ public final CommitResponse commit(
811826
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
812827
* beginning, re-using the same session.
813828
*
829+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
830+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
831+
* track of the transaction outcome and we recommend that you perform another read from the
832+
* database to see the state of things as they are now.
833+
*
814834
* @param session Required. The session in which the transaction to be committed is running.
815835
* @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike
816836
* commit of a previously-started transaction, commit with a temporary transaction is
@@ -844,6 +864,11 @@ public final CommitResponse commit(
844864
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
845865
* beginning, re-using the same session.
846866
*
867+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
868+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
869+
* track of the transaction outcome and we recommend that you perform another read from the
870+
* database to see the state of things as they are now.
871+
*
847872
* @param request The request object containing all of the parameters for the API call.
848873
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
849874
*/
@@ -861,6 +886,11 @@ public final CommitResponse commit(CommitRequest request) {
861886
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the
862887
* beginning, re-using the same session.
863888
*
889+
* <p>On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if
890+
* the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost
891+
* track of the transaction outcome and we recommend that you perform another read from the
892+
* database to see the state of things as they are now.
893+
*
864894
* <p>Sample code:
865895
*/
866896
public final UnaryCallable<CommitRequest, CommitResponse> commitCallable() {

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/v1/SpannerClientTest.java‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,10 @@ public void beginTransactionExceptionTest2() throws Exception {
954954
@Test
955955
public void commitTest() throws Exception {
956956
CommitResponse expectedResponse =
957-
CommitResponse.newBuilder().setCommitTimestamp(Timestamp.newBuilder().build()).build();
957+
CommitResponse.newBuilder()
958+
.setCommitTimestamp(Timestamp.newBuilder().build())
959+
.setCommitStats(CommitResponse.CommitStats.newBuilder().build())
960+
.build();
958961
mockSpanner.addResponse(expectedResponse);
959962

960963
SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
@@ -996,7 +999,10 @@ public void commitExceptionTest() throws Exception {
996999
@Test
9971000
public void commitTest2() throws Exception {
9981001
CommitResponse expectedResponse =
999-
CommitResponse.newBuilder().setCommitTimestamp(Timestamp.newBuilder().build()).build();
1002+
CommitResponse.newBuilder()
1003+
.setCommitTimestamp(Timestamp.newBuilder().build())
1004+
.setCommitStats(CommitResponse.CommitStats.newBuilder().build())
1005+
.build();
10001006
mockSpanner.addResponse(expectedResponse);
10011007

10021008
SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
@@ -1038,7 +1044,10 @@ public void commitExceptionTest2() throws Exception {
10381044
@Test
10391045
public void commitTest3() throws Exception {
10401046
CommitResponse expectedResponse =
1041-
CommitResponse.newBuilder().setCommitTimestamp(Timestamp.newBuilder().build()).build();
1047+
CommitResponse.newBuilder()
1048+
.setCommitTimestamp(Timestamp.newBuilder().build())
1049+
.setCommitStats(CommitResponse.CommitStats.newBuilder().build())
1050+
.build();
10421051
mockSpanner.addResponse(expectedResponse);
10431052

10441053
String session = "session1984987798";
@@ -1080,7 +1089,10 @@ public void commitExceptionTest3() throws Exception {
10801089
@Test
10811090
public void commitTest4() throws Exception {
10821091
CommitResponse expectedResponse =
1083-
CommitResponse.newBuilder().setCommitTimestamp(Timestamp.newBuilder().build()).build();
1092+
CommitResponse.newBuilder()
1093+
.setCommitTimestamp(Timestamp.newBuilder().build())
1094+
.setCommitStats(CommitResponse.CommitStats.newBuilder().build())
1095+
.build();
10841096
mockSpanner.addResponse(expectedResponse);
10851097

10861098
String session = "session1984987798";

‎grpc-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/SpannerGrpc.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -924,6 +924,11 @@ public void beginTransaction(
924924
* transactions. However, it can also happen for a variety of other
925925
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
926926
* the transaction from the beginning, re-using the same session.
927+
* On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
928+
* for example, if the client job experiences a 1+ hour networking failure.
929+
* At that point, Cloud Spanner has lost track of the transaction outcome and
930+
* we recommend that you perform another read from the database to see the
931+
* state of things as they are now.
927932
* </pre>
928933
*/
929934
public void commit(
@@ -1357,6 +1362,11 @@ public void beginTransaction(
13571362
* transactions. However, it can also happen for a variety of other
13581363
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
13591364
* the transaction from the beginning, re-using the same session.
1365+
* On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
1366+
* for example, if the client job experiences a 1+ hour networking failure.
1367+
* At that point, Cloud Spanner has lost track of the transaction outcome and
1368+
* we recommend that you perform another read from the database to see the
1369+
* state of things as they are now.
13601370
* </pre>
13611371
*/
13621372
public void commit(
@@ -1663,6 +1673,11 @@ public com.google.spanner.v1.Transaction beginTransaction(
16631673
* transactions. However, it can also happen for a variety of other
16641674
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
16651675
* the transaction from the beginning, re-using the same session.
1676+
* On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
1677+
* for example, if the client job experiences a 1+ hour networking failure.
1678+
* At that point, Cloud Spanner has lost track of the transaction outcome and
1679+
* we recommend that you perform another read from the database to see the
1680+
* state of things as they are now.
16661681
* </pre>
16671682
*/
16681683
public com.google.spanner.v1.CommitResponse commit(
@@ -1932,6 +1947,11 @@ public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.v1.
19321947
* transactions. However, it can also happen for a variety of other
19331948
* reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
19341949
* the transaction from the beginning, re-using the same session.
1950+
* On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
1951+
* for example, if the client job experiences a 1+ hour networking failure.
1952+
* At that point, Cloud Spanner has lost track of the transaction outcome and
1953+
* we recommend that you perform another read from the database to see the
1954+
* state of things as they are now.
19351955
* </pre>
19361956
*/
19371957
public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.v1.CommitResponse>

‎proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequest.java‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,11 @@ private CommitRequest(
111111
input.readMessage(com.google.spanner.v1.Mutation.parser(), extensionRegistry));
112112
break;
113113
}
114+
case 40:
115+
{
116+
returnCommitStats_ = input.readBool();
117+
break;
118+
}
114119
default:
115120
{
116121
if (!parseUnknownField(input, unknownFields, extensionRegistry, tag)) {
@@ -422,6 +427,26 @@ public com.google.spanner.v1.MutationOrBuilder getMutationsOrBuilder(int index)
422427
return mutations_.get(index);
423428
}
424429

430+
public static final int RETURN_COMMIT_STATS_FIELD_NUMBER = 5;
431+
private boolean returnCommitStats_;
432+
/**
433+
*
434+
*
435+
* <pre>
436+
* If `true`, then statistics related to the transaction will be included in
437+
* the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
438+
* `false`.
439+
* </pre>
440+
*
441+
* <code>bool return_commit_stats = 5;</code>
442+
*
443+
* @return The returnCommitStats.
444+
*/
445+
@java.lang.Override
446+
public boolean getReturnCommitStats() {
447+
return returnCommitStats_;
448+
}
449+
425450
private byte memoizedIsInitialized = -1;
426451

427452
@java.lang.Override
@@ -448,6 +473,9 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
448473
for (int i = 0; i < mutations_.size(); i++) {
449474
output.writeMessage(4, mutations_.get(i));
450475
}
476+
if (returnCommitStats_ != false) {
477+
output.writeBool(5, returnCommitStats_);
478+
}
451479
unknownFields.writeTo(output);
452480
}
453481

@@ -473,6 +501,9 @@ public int getSerializedSize() {
473501
for (int i = 0; i < mutations_.size(); i++) {
474502
size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, mutations_.get(i));
475503
}
504+
if (returnCommitStats_ != false) {
505+
size += com.google.protobuf.CodedOutputStream.computeBoolSize(5, returnCommitStats_);
506+
}
476507
size += unknownFields.getSerializedSize();
477508
memoizedSize = size;
478509
return size;
@@ -490,6 +521,7 @@ public boolean equals(final java.lang.Object obj) {
490521

491522
if (!getSession().equals(other.getSession())) return false;
492523
if (!getMutationsList().equals(other.getMutationsList())) return false;
524+
if (getReturnCommitStats() != other.getReturnCommitStats()) return false;
493525
if (!getTransactionCase().equals(other.getTransactionCase())) return false;
494526
switch (transactionCase_) {
495527
case 2:
@@ -518,6 +550,8 @@ public int hashCode() {
518550
hash = (37 * hash) + MUTATIONS_FIELD_NUMBER;
519551
hash = (53 * hash) + getMutationsList().hashCode();
520552
}
553+
hash = (37 * hash) + RETURN_COMMIT_STATS_FIELD_NUMBER;
554+
hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getReturnCommitStats());
521555
switch (transactionCase_) {
522556
case 2:
523557
hash = (37 * hash) + TRANSACTION_ID_FIELD_NUMBER;
@@ -684,6 +718,8 @@ public Builder clear() {
684718
} else {
685719
mutationsBuilder_.clear();
686720
}
721+
returnCommitStats_ = false;
722+
687723
transactionCase_ = 0;
688724
transaction_ = null;
689725
return this;
@@ -733,6 +769,7 @@ public com.google.spanner.v1.CommitRequest buildPartial() {
733769
} else {
734770
result.mutations_ = mutationsBuilder_.build();
735771
}
772+
result.returnCommitStats_ = returnCommitStats_;
736773
result.transactionCase_ = transactionCase_;
737774
onBuilt();
738775
return result;
@@ -814,6 +851,9 @@ public Builder mergeFrom(com.google.spanner.v1.CommitRequest other) {
814851
}
815852
}
816853
}
854+
if (other.getReturnCommitStats() != false) {
855+
setReturnCommitStats(other.getReturnCommitStats());
856+
}
817857
switch (other.getTransactionCase()) {
818858
case TRANSACTION_ID:
819859
{
@@ -1712,6 +1752,64 @@ public java.util.List<com.google.spanner.v1.Mutation.Builder> getMutationsBuilde
17121752
return mutationsBuilder_;
17131753
}
17141754

1755+
private boolean returnCommitStats_;
1756+
/**
1757+
*
1758+
*
1759+
* <pre>
1760+
* If `true`, then statistics related to the transaction will be included in
1761+
* the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
1762+
* `false`.
1763+
* </pre>
1764+
*
1765+
* <code>bool return_commit_stats = 5;</code>
1766+
*
1767+
* @return The returnCommitStats.
1768+
*/
1769+
@java.lang.Override
1770+
public boolean getReturnCommitStats() {
1771+
return returnCommitStats_;
1772+
}
1773+
/**
1774+
*
1775+
*
1776+
* <pre>
1777+
* If `true`, then statistics related to the transaction will be included in
1778+
* the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
1779+
* `false`.
1780+
* </pre>
1781+
*
1782+
* <code>bool return_commit_stats = 5;</code>
1783+
*
1784+
* @param value The returnCommitStats to set.
1785+
* @return This builder for chaining.
1786+
*/
1787+
public Builder setReturnCommitStats(boolean value) {
1788+
1789+
returnCommitStats_ = value;
1790+
onChanged();
1791+
return this;
1792+
}
1793+
/**
1794+
*
1795+
*
1796+
* <pre>
1797+
* If `true`, then statistics related to the transaction will be included in
1798+
* the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
1799+
* `false`.
1800+
* </pre>
1801+
*
1802+
* <code>bool return_commit_stats = 5;</code>
1803+
*
1804+
* @return This builder for chaining.
1805+
*/
1806+
public Builder clearReturnCommitStats() {
1807+
1808+
returnCommitStats_ = false;
1809+
onChanged();
1810+
return this;
1811+
}
1812+
17151813
@java.lang.Override
17161814
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
17171815
return super.setUnknownFields(unknownFields);

‎proto-google-cloud-spanner-v1/src/main/java/com/google/spanner/v1/CommitRequestOrBuilder.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,5 +185,20 @@ public interface CommitRequestOrBuilder
185185
*/
186186
com.google.spanner.v1.MutationOrBuilder getMutationsOrBuilder(int index);
187187

188+
/**
189+
*
190+
*
191+
* <pre>
192+
* If `true`, then statistics related to the transaction will be included in
193+
* the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is
194+
* `false`.
195+
* </pre>
196+
*
197+
* <code>bool return_commit_stats = 5;</code>
198+
*
199+
* @return The returnCommitStats.
200+
*/
201+
boolean getReturnCommitStats();
202+
188203
public com.google.spanner.v1.CommitRequest.TransactionCase getTransactionCase();
189204
}

0 commit comments

Comments
 (0)