com.google.cloud.bigtable.hbase.wrappers

Interface DataClientWrapper

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DataClientVeneerApi

@InternalApi(value="For internal usage only")
public interface DataClientWrapper
extends AutoCloseable

Common API surface for data operation.

For internal use only - public for technical reasons.

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<Boolean>	checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation) Mutate a row atomically dependent on a precondition.
void	close()
BulkMutationWrapper	createBulkMutation(String tableId) Creates instance of bulkMutation with specified table ID.
BulkReadWrapper	createBulkRead(String tableId) Creates BulkReadWrapper with specified table ID.
com.google.api.core.ApiFuture<Void>	mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation) Mutate a row atomically.
com.google.api.core.ApiFuture<org.apache.hadoop.hbase.client.Result>	readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow) Perform an atomic read-modify-write operation on a row.
com.google.api.core.ApiFuture<org.apache.hadoop.hbase.client.Result>	readRowAsync(String tableId, com.google.protobuf.ByteString rowKey, com.google.cloud.bigtable.data.v2.models.Filters.Filter filter) Reads a single row based on filter, If row not found then returns an empty Result.
org.apache.hadoop.hbase.client.ResultScanner	readRows(com.google.cloud.bigtable.data.v2.models.Query request) Perform a scan over Results, in key order.
com.google.api.core.ApiFuture<List<org.apache.hadoop.hbase.client.Result>>	readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request) Read multiple Results into an in-memory list, in key order.
void	readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request, io.grpc.stub.StreamObserver<org.apache.hadoop.hbase.client.Result> observer) Read Result asynchronously, and pass them to a stream observer to be processed.
com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>>	sampleRowKeysAsync(String tableId) Sample row keys from a table, returning a Future that will complete when the sampling has completed.

Method Detail

createBulkMutation

BulkMutationWrapper createBulkMutation(String tableId)

Creates instance of bulkMutation with specified table ID.

createBulkRead

BulkReadWrapper createBulkRead(String tableId)

Creates BulkReadWrapper with specified table ID.

The BulkRead instance will be scoped to a single user visible operation. The operation timeout (which is configured in the settings) is started from the time the createBulkRead is invoked.

 try (BulkReadWrapper batch = wrapper.createBulkRead(tableId)) {
   batch.add(key1, filter1);
   batch.add(key2, filter2);
 }
 

mutateRowAsync

com.google.api.core.ApiFuture<Void> mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation)

Mutate a row atomically.

readModifyWriteRowAsync

com.google.api.core.ApiFuture<org.apache.hadoop.hbase.client.Result> readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow)

Perform an atomic read-modify-write operation on a row.

checkAndMutateRowAsync

com.google.api.core.ApiFuture<Boolean> checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation)

Mutate a row atomically dependent on a precondition.

sampleRowKeysAsync

com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>> sampleRowKeysAsync(String tableId)

Sample row keys from a table, returning a Future that will complete when the sampling has completed.

readRowAsync

com.google.api.core.ApiFuture<org.apache.hadoop.hbase.client.Result> readRowAsync(String tableId,
                                                                                  com.google.protobuf.ByteString rowKey,
                                                                                  @Nullable
                                                                                  com.google.cloud.bigtable.data.v2.models.Filters.Filter filter)

Reads a single row based on filter, If row not found then returns an empty Result.

readRows

org.apache.hadoop.hbase.client.ResultScanner readRows(com.google.cloud.bigtable.data.v2.models.Query request)

Perform a scan over Results, in key order.

readRowsAsync

com.google.api.core.ApiFuture<List<org.apache.hadoop.hbase.client.Result>> readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request)

Read multiple Results into an in-memory list, in key order.

readRowsAsync

void readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request,
                   io.grpc.stub.StreamObserver<org.apache.hadoop.hbase.client.Result> observer)

Read Result asynchronously, and pass them to a stream observer to be processed.

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException