Skip to content
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

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

Merged
merged 3 commits into from
Sep 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
* }
*
Expand Down Expand Up @@ -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.
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved
*
* <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:
*
Expand Down Expand Up @@ -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.
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved
*
* <p>Sample Code:
*
Expand Down