Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Bigtable: 10. Implementation: integrate ReadRows #2940
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
garrettjonesgoogle
merged 6 commits into
googleapis:master
from
igorbernstein2:10-impl-integrate-readrows
Mar 1, 2018
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ad2c3a7
Bigtable: 10. Implementation: integrate ReadRows
igorbernstein2 f53ac97
codacy fixes
igorbernstein2 b5e61d4
innerCallable should be the first arg
igorbernstein2 5236265
add a comment explaining why first is overriden
igorbernstein2 5138238
add justification for inconsistent ordering of withDefaultContext
igorbernstein2 b26ca34
fix grammar
igorbernstein2 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
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
...c/main/java/com/google/cloud/bigtable/data/v2/stub/readrows/FilterMarkerRowsCallable.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| * Copyright 2018 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 | ||
| * | ||
| * https://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.bigtable.data.v2.stub.readrows; | ||
|
|
||
| import com.google.api.core.InternalApi; | ||
| import com.google.api.gax.rpc.ApiCallContext; | ||
| import com.google.api.gax.rpc.ResponseObserver; | ||
| import com.google.api.gax.rpc.ServerStreamingCallable; | ||
| import com.google.api.gax.rpc.StreamController; | ||
| import com.google.bigtable.v2.ReadRowsRequest; | ||
| import com.google.cloud.bigtable.data.v2.models.RowAdapter; | ||
|
|
||
| /** | ||
| * Remove the special marker rows generated by {@link RowMergingCallable}. | ||
| * | ||
| * <p>This class is considered an internal implementation detail and not meant to be used by | ||
| * applications. | ||
| */ | ||
| @InternalApi | ||
| public class FilterMarkerRowsCallable<RowT> extends ServerStreamingCallable<ReadRowsRequest, RowT> { | ||
| private final ServerStreamingCallable<ReadRowsRequest, RowT> innerCallable; | ||
| private final RowAdapter<RowT> rowAdapter; | ||
|
|
||
| public FilterMarkerRowsCallable( | ||
| ServerStreamingCallable<ReadRowsRequest, RowT> inner, RowAdapter<RowT> rowAdapter) { | ||
| this.rowAdapter = rowAdapter; | ||
| this.innerCallable = inner; | ||
| } | ||
|
|
||
| @Override | ||
| public void call( | ||
| ReadRowsRequest request, ResponseObserver<RowT> responseObserver, ApiCallContext context) { | ||
| FilteringResponseObserver innerObserver = new FilteringResponseObserver(responseObserver); | ||
| innerCallable.call(request, innerObserver, context); | ||
| } | ||
|
|
||
| private class FilteringResponseObserver implements ResponseObserver<RowT> { | ||
| private final ResponseObserver<RowT> outerObserver; | ||
| private StreamController innerController; | ||
| private boolean autoFlowControl = true; | ||
|
|
||
| FilteringResponseObserver(ResponseObserver<RowT> outerObserver) { | ||
| this.outerObserver = outerObserver; | ||
| } | ||
|
|
||
| @Override | ||
| public void onStart(final StreamController controller) { | ||
| innerController = controller; | ||
|
|
||
| outerObserver.onStart( | ||
| new StreamController() { | ||
| @Override | ||
| public void cancel() { | ||
| controller.cancel(); | ||
| } | ||
|
|
||
| @Override | ||
| public void disableAutoInboundFlowControl() { | ||
| autoFlowControl = false; | ||
| controller.disableAutoInboundFlowControl(); | ||
| } | ||
|
|
||
| @Override | ||
| public void request(int count) { | ||
| controller.request(count); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public void onResponse(RowT response) { | ||
| if (rowAdapter.isScanMarkerRow(response)) { | ||
| if (!autoFlowControl) { | ||
| innerController.request(1); | ||
| } | ||
| } else { | ||
| outerObserver.onResponse(response); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void onError(Throwable t) { | ||
| outerObserver.onError(t); | ||
| } | ||
|
|
||
| @Override | ||
| public void onComplete() { | ||
| outerObserver.onComplete(); | ||
| } | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
.../src/main/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsFirstCallable.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /* | ||
| * Copyright 2018 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 | ||
| * | ||
| * https://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.bigtable.data.v2.stub.readrows; | ||
|
|
||
| import com.google.api.core.ApiFuture; | ||
| import com.google.api.gax.rpc.ApiCallContext; | ||
| import com.google.api.gax.rpc.UnaryCallable; | ||
| import com.google.cloud.bigtable.data.v2.models.Query; | ||
|
|
||
| /** | ||
| * Enhancement for `readRowsCallable().first()` to gracefully limit the row count instead of | ||
| * cancelling the RPC | ||
| */ | ||
| class ReadRowsFirstCallable<RowT> extends UnaryCallable<Query, RowT> { | ||
| private final UnaryCallable<Query, RowT> inner; | ||
|
|
||
| ReadRowsFirstCallable(UnaryCallable<Query, RowT> inner) { | ||
| this.inner = inner; | ||
| } | ||
|
|
||
| @Override | ||
| public ApiFuture<RowT> futureCall(Query query, ApiCallContext context) { | ||
| return inner.futureCall(query.limit(1), context); | ||
| } | ||
| } |
60 changes: 60 additions & 0 deletions
60
...e/src/main/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsUserCallable.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2018 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 | ||
| * | ||
| * https://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.bigtable.data.v2.stub.readrows; | ||
|
|
||
| import com.google.api.core.InternalApi; | ||
| import com.google.api.gax.rpc.ApiCallContext; | ||
| import com.google.api.gax.rpc.ResponseObserver; | ||
| import com.google.api.gax.rpc.ServerStreamingCallable; | ||
| import com.google.api.gax.rpc.UnaryCallable; | ||
| import com.google.bigtable.v2.ReadRowsRequest; | ||
| import com.google.cloud.bigtable.data.v2.internal.RequestContext; | ||
| import com.google.cloud.bigtable.data.v2.models.Query; | ||
|
|
||
| /** | ||
| * Simple wrapper for ReadRows to wrap the request protobufs. | ||
| * | ||
| * <p>This class is considered an internal implementation detail and not meant to be used by | ||
| * applications. | ||
| */ | ||
| @InternalApi | ||
| public class ReadRowsUserCallable<RowT> extends ServerStreamingCallable<Query, RowT> { | ||
| private final ServerStreamingCallable<ReadRowsRequest, RowT> inner; | ||
| private final RequestContext requestContext; | ||
| private final ReadRowsFirstCallable<RowT> firstCallable; | ||
|
|
||
| public ReadRowsUserCallable( | ||
| ServerStreamingCallable<ReadRowsRequest, RowT> inner, RequestContext requestContext) { | ||
| this.inner = inner; | ||
| this.requestContext = requestContext; | ||
|
|
||
| this.firstCallable = new ReadRowsFirstCallable<>(super.first()); | ||
| } | ||
|
|
||
| @Override | ||
| public void call(Query request, ResponseObserver<RowT> responseObserver, ApiCallContext context) { | ||
| ReadRowsRequest innerRequest = request.toProto(requestContext); | ||
| inner.call(innerRequest, responseObserver, context); | ||
| } | ||
|
|
||
| // Optimization: since the server supports row limits, override the first callable. | ||
| // This way unnecessary data doesn't need to be buffered and the number of CANCELLED request | ||
| // statuses is minimized | ||
| @Override | ||
| public UnaryCallable<Query, RowT> first() { | ||
| return firstCallable; | ||
| } | ||
| } | ||
106 changes: 106 additions & 0 deletions
106
...st/java/com/google/cloud/bigtable/data/v2/stub/readrows/FilterMarkerRowsCallableTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * Copyright 2018 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 | ||
| * | ||
| * https://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.bigtable.data.v2.stub.readrows; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
|
|
||
| import com.google.api.gax.rpc.ServerStream; | ||
| import com.google.bigtable.v2.ReadRowsRequest; | ||
| import com.google.cloud.bigtable.data.v2.models.DefaultRowAdapter; | ||
| import com.google.cloud.bigtable.data.v2.models.Row; | ||
| import com.google.cloud.bigtable.data.v2.models.RowAdapter.RowBuilder; | ||
| import com.google.cloud.bigtable.gaxx.testing.FakeStreamingApi.ServerStreamingStashCallable; | ||
| import com.google.common.collect.Lists; | ||
| import com.google.protobuf.ByteString; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class FilterMarkerRowsCallableTest { | ||
| private final DefaultRowAdapter rowAdapter = new DefaultRowAdapter(); | ||
|
|
||
| @Test | ||
| public void testEmpty() { | ||
| ServerStreamingStashCallable<ReadRowsRequest, Row> innerCallable = | ||
| new ServerStreamingStashCallable<>(); | ||
| FilterMarkerRowsCallable<Row> filterCallable = | ||
| new FilterMarkerRowsCallable<>(innerCallable, rowAdapter); | ||
|
|
||
| ServerStream<Row> results = filterCallable.call(ReadRowsRequest.getDefaultInstance()); | ||
|
|
||
| assertThat(results).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testOnlyMarker() { | ||
| ServerStreamingStashCallable<ReadRowsRequest, Row> innerCallable = | ||
| new ServerStreamingStashCallable<>(Lists.newArrayList(buildScanMarker())); | ||
| FilterMarkerRowsCallable<Row> filterCallable = | ||
| new FilterMarkerRowsCallable<>(innerCallable, rowAdapter); | ||
|
|
||
| ServerStream<Row> results = filterCallable.call(ReadRowsRequest.getDefaultInstance()); | ||
|
|
||
| assertThat(results).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRealRow() { | ||
| Row row = buildRealRow(); | ||
|
|
||
| ServerStreamingStashCallable<ReadRowsRequest, Row> innerCallable = | ||
| new ServerStreamingStashCallable<>(Lists.newArrayList(row)); | ||
| FilterMarkerRowsCallable<Row> filterCallable = | ||
| new FilterMarkerRowsCallable<>(innerCallable, rowAdapter); | ||
|
|
||
| ServerStream<Row> results = filterCallable.call(ReadRowsRequest.getDefaultInstance()); | ||
|
|
||
| assertThat(results).containsExactly(row); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMixed() { | ||
| Row row = buildRealRow(); | ||
| Row markerRow = buildScanMarker(); | ||
|
|
||
| ServerStreamingStashCallable<ReadRowsRequest, Row> innerCallable = | ||
| new ServerStreamingStashCallable<>(Lists.newArrayList(row, markerRow)); | ||
| FilterMarkerRowsCallable<Row> filterCallable = | ||
| new FilterMarkerRowsCallable<>(innerCallable, rowAdapter); | ||
|
|
||
| ServerStream<Row> results = filterCallable.call(ReadRowsRequest.getDefaultInstance()); | ||
|
|
||
| assertThat(results).containsExactly(row); | ||
| } | ||
|
|
||
| private Row buildRealRow() { | ||
| RowBuilder<Row> rowBuilder = rowAdapter.createRowBuilder(); | ||
| rowBuilder.startRow(ByteString.copyFromUtf8("fake-key")); | ||
| rowBuilder.startCell( | ||
| "fake-family", | ||
| ByteString.copyFromUtf8("fake-qualifer"), | ||
| 1_000, | ||
| Lists.<String>newArrayList(), | ||
| 0); | ||
| rowBuilder.cellValue(ByteString.copyFromUtf8("fake-value")); | ||
| rowBuilder.finishCell(); | ||
| return rowBuilder.finishRow(); | ||
| } | ||
|
|
||
| private Row buildScanMarker() { | ||
| return rowAdapter.createRowBuilder().createScanMarkerRow(ByteString.copyFromUtf8("fake-key2")); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can’t perform that action at this time.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.