Skip to content

Commit 71dc8e3

Browse files
authored
fix: Add documentation to bulkReadRows that each batch will process t… (#410)
* fix: Add documentation to bulkReadRows that each batch will process the keys sequentially * fix: Add documentation to bulkReadRows that each batch will process the keys sequentially * fix: Add documentation to bulkReadRows that each batch will process the keys sequentially
1 parent 2e17f0a commit 71dc8e3

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
* // One instance per application.
7777
* BigtableTableAdminClient client = BigtableTableAdminClient.create("[PROJECT]", "[INSTANCE]");
7878
*
79-
* CreateTable request =
79+
* CreateTableRequest request =
8080
* CreateTableRequest.of("my-table")
8181
* .addFamily("cf1")
8282
* .addFamily("cf2", GCRULES.maxVersions(10))

google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataClient.java

+15-6
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
* // One instance per application.
5858
* BigtableDataClient client = BigtableDataClient.create("[PROJECT]", "[INSTANCE]")
5959
*
60-
* for(Row row : client.readRows(Query.create("[TABLE]")) {
60+
* for(Row row : client.readRows(Query.create("[TABLE]"))) {
6161
* // Do something with row
6262
* }
6363
*
@@ -1077,9 +1077,13 @@ public Batcher<RowMutationEntry, Void> newBulkMutationBatcher(@Nonnull String ta
10771077
}
10781078

10791079
/**
1080-
* Reads rows for given tableId in a batch. If the row does not exist, the value will be null.
1081-
* This operation should be called with in a single thread. The returned Batcher instance is not
1082-
* threadsafe, it can only be used from single thread.
1080+
* Reads rows for given tableId in a batch. If the row does not exist, the value will be null. The
1081+
* returned Batcher instance is not threadsafe, it can only be used from a single thread.
1082+
*
1083+
* <p>Performance notice: The ReadRows protocol requires that rows are sent in ascending key
1084+
* order, which means that the keys are processed sequentially on the server-side, so batching
1085+
* allows improving throughput but not latency. Lower latencies can be achieved by sending smaller
1086+
* requests concurrently.
10831087
*
10841088
* <p>Sample Code:
10851089
*
@@ -1113,8 +1117,13 @@ public Batcher<ByteString, Row> newBulkReadRowsBatcher(String tableId) {
11131117

11141118
/**
11151119
* Reads rows for given tableId and filter criteria in a batch. If the row does not exist, the
1116-
* value will be null. This operation should be called with in a single thread. The returned
1117-
* Batcher instance is not threadsafe, it can only be used from single thread.
1120+
* value will be null. The returned Batcher instance is not threadsafe, it can only be used from a
1121+
* single thread.
1122+
*
1123+
* <p>Performance notice: The ReadRows protocol requires that rows are sent in ascending key
1124+
* order, which means that the keys are processed sequentially on the server-side, so batching
1125+
* allows improving throughput but not latency. Lower latencies can be achieved by sending smaller
1126+
* requests concurrently.
11181127
*
11191128
* <p>Sample Code:
11201129
*

0 commit comments

Comments
 (0)