fix: Add documentation to bulkReadRows that each batch will process t… (#410)

dmitry-fa · web-flow · commit 71dc8e3419fb · 2020-09-14T09:38:48.000-04:00
* 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
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java
@@ -76,7 +76,7 @@
  * // One instance per application.
  * BigtableTableAdminClient client =  BigtableTableAdminClient.create("[PROJECT]", "[INSTANCE]");
  *
- * CreateTable request =
+ * CreateTableRequest request =
  *   CreateTableRequest.of("my-table")
  *     .addFamily("cf1")
  *     .addFamily("cf2", GCRULES.maxVersions(10))
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataClient.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/BigtableDataClient.java
@@ -57,7 +57,7 @@
  * // One instance per application.
  * BigtableDataClient client = BigtableDataClient.create("[PROJECT]", "[INSTANCE]")
  *
- * for(Row row : client.readRows(Query.create("[TABLE]")) {
+ * for(Row row : client.readRows(Query.create("[TABLE]"))) {
  *   // Do something with row
  * }
  *
@@ -1077,9 +1077,13 @@ public Batcher<RowMutationEntry, Void> newBulkMutationBatcher(@Nonnull String ta
   }
 
   /**
-   * Reads rows for given tableId in a batch. If the row does not exist, the value will be null.
-   * This operation should be called with in a single thread. The returned Batcher instance is not
-   * threadsafe, it can only be used from single thread.
+   * Reads rows for given tableId in a batch. If the row does not exist, the value will be null. The
+   * returned Batcher instance is not threadsafe, it can only be used from a single thread.
+   *
+   * <p>Performance notice: The ReadRows protocol requires that rows are sent in ascending key
+   * order, which means that the keys are processed sequentially on the server-side, so batching
+   * allows improving throughput but not latency. Lower latencies can be achieved by sending smaller
+   * requests concurrently.
    *
    * <p>Sample Code:
    *
@@ -1113,8 +1117,13 @@ public Batcher<ByteString, Row> newBulkReadRowsBatcher(String tableId) {
 
   /**
    * Reads rows for given tableId and filter criteria in a batch. If the row does not exist, the
-   * value will be null. This operation should be called with in a single thread. The returned
-   * Batcher instance is not threadsafe, it can only be used from single thread.
+   * value will be null. The returned Batcher instance is not threadsafe, it can only be used from a
+   * single thread.
+   *
+   * <p>Performance notice: The ReadRows protocol requires that rows are sent in ascending key
+   * order, which means that the keys are processed sequentially on the server-side, so batching
+   * allows improving throughput but not latency. Lower latencies can be achieved by sending smaller
+   * requests concurrently.
    *
    * <p>Sample Code:
    *

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@`
`76`	`76`	`* // One instance per application.`
`77`	`77`	`* BigtableTableAdminClient client = BigtableTableAdminClient.create("[PROJECT]", "[INSTANCE]");`
`78`	`78`	`*`
`79`		`- * CreateTable request =`
	`79`	`+ * CreateTableRequest request =`
`80`	`80`	`* CreateTableRequest.of("my-table")`
`81`	`81`	`* .addFamily("cf1")`
`82`	`82`	`* .addFamily("cf2", GCRULES.maxVersions(10))`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`	`* // One instance per application.`
`58`	`58`	`* BigtableDataClient client = BigtableDataClient.create("[PROJECT]", "[INSTANCE]")`
`59`	`59`	`*`
`60`		`- * for(Row row : client.readRows(Query.create("[TABLE]")) {`
	`60`	`+ * for(Row row : client.readRows(Query.create("[TABLE]"))) {`
`61`	`61`	`* // Do something with row`
`62`	`62`	`* }`
`63`	`63`	`*`
`@@ -1077,9 +1077,13 @@ public Batcher<RowMutationEntry, Void> newBulkMutationBatcher(@Nonnull String ta`
`1077`	`1077`	`}`
`1078`	`1078`
`1079`	`1079`	`/**`
`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.`
`1083`	`1087`	`*`
`1084`	`1088`	`* <p>Sample Code:`
`1085`	`1089`	`*`
`@@ -1113,8 +1117,13 @@ public Batcher<ByteString, Row> newBulkReadRowsBatcher(String tableId) {`
`1113`	`1117`
`1114`	`1118`	`/**`
`1115`	`1119`	`* 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.`
`1118`	`1127`	`*`
`1119`	`1128`	`* <p>Sample Code:`
`1120`	`1129`	`*`