com.google.cloud.bigtable.grpc

Class BigtableDataGrpcClient

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableDataGrpcClient

All Implemented Interfaces:

BigtableDataClient

public class BigtableDataGrpcClient
extends Object
implements BigtableDataClient

A gRPC client to access the v2 Bigtable data service.

In addition to calling the underlying data service API via grpc, this class adds retry logic and some useful headers.

Most of the methods are unary (single response). The only exception is ReadRows which is a streaming call.

Version:

$Id: $Id

Author:

sduskis

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<com.google.bigtable.v2.MutateRowRequest>	IS_RETRYABLE_MUTATION Constant IS_RETRYABLE_MUTATION

Constructor Summary

Constructors

Constructor and Description
BigtableDataGrpcClient(io.grpc.Channel channel, ScheduledExecutorService retryExecutorService, BigtableOptions bigtableOptions) Constructor for BigtableDataGrpcClient.

Method Summary

Modifier and Type	Method and Description
com.google.bigtable.v2.CheckAndMutateRowResponse	checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request) Mutate a row atomically dependent on a precondition.
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse>	checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request) Mutate a row atomically dependent on a precondition.
com.google.bigtable.v2.MutateRowResponse	mutateRow(com.google.bigtable.v2.MutateRowRequest request) Mutate a row atomically.
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.MutateRowResponse>	mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request) Mutate a row atomically.
List<com.google.bigtable.v2.MutateRowsResponse>	mutateRows(com.google.bigtable.v2.MutateRowsRequest request) Mutates multiple rows in a batch.
com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>>	mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request) Mutates multiple rows in a batch.
ResultScanner<FlatRow>	readFlatRows(com.google.bigtable.v2.ReadRowsRequest request) Perform a scan over FlatRows, in key order.
ScanHandler	readFlatRows(com.google.bigtable.v2.ReadRowsRequest request, io.grpc.stub.StreamObserver<FlatRow> observer) Perform a streaming read of FlatRows in key order.
com.google.common.util.concurrent.ListenableFuture<List<FlatRow>>	readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request) Read multiple FlatRows into an in-memory list, in key order.
List<FlatRow>	readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request) Returns a list of FlatRows, in key order.
com.google.bigtable.v2.ReadModifyWriteRowResponse	readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request) Perform an atomic read-modify-write operation on a row.
com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse>	readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request) Perform an atomic read-modify-write operation on a row,
ResultScanner<com.google.bigtable.v2.Row>	readRows(com.google.bigtable.v2.ReadRowsRequest request) Perform a scan over Rows, in key order.
com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.Row>>	readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request) Read multiple Rows into an in-memory list, in key order.
List<com.google.bigtable.v2.SampleRowKeysResponse>	sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request) Sample row keys from a table.
com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>>	sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request) Sample row keys from a table, returning a Future that will complete when the sampling has completed.
void	setCallOptionsFactory(CallOptionsFactory callOptionsFactory) Sets a CallOptionsFactory which creates CallOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IS_RETRYABLE_MUTATION

public static final com.google.common.base.Predicate<com.google.bigtable.v2.MutateRowRequest> IS_RETRYABLE_MUTATION

Constant IS_RETRYABLE_MUTATION

Constructor Detail

BigtableDataGrpcClient

public BigtableDataGrpcClient(io.grpc.Channel channel,
                              ScheduledExecutorService retryExecutorService,
                              BigtableOptions bigtableOptions)

Constructor for BigtableDataGrpcClient.

Parameters:

channel - a Channel object.

retryExecutorService - a ScheduledExecutorService object.

bigtableOptions - a BigtableOptions object.

Method Detail

setCallOptionsFactory

public void setCallOptionsFactory(CallOptionsFactory callOptionsFactory)

Sets a CallOptionsFactory which creates CallOptions

Specified by:

setCallOptionsFactory in interface BigtableDataClient

Parameters:

callOptionsFactory - a CallOptionsFactory object.

mutateRow

public com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.MutateRowRequest request)

Mutate a row atomically.

Specified by:

mutateRow in interface BigtableDataClient

Parameters:

request - a MutateRowRequest object.

Returns:

a MutateRowResponse object.

mutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.MutateRowResponse> mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request)

Mutate a row atomically.

Specified by:

mutateRowAsync in interface BigtableDataClient

Parameters:

request - a MutateRowRequest object.

Returns:

a ListenableFuture that will finish when the mutation has completed.

mutateRows

public List<com.google.bigtable.v2.MutateRowsResponse> mutateRows(com.google.bigtable.v2.MutateRowsRequest request)

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Specified by:

mutateRows in interface BigtableDataClient

Parameters:

request - a MutateRowsRequest object.

Returns:

a List object.

mutateRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>> mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request)

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Specified by:

mutateRowsAsync in interface BigtableDataClient

Parameters:

request - a MutateRowsRequest object.

Returns:

a ListenableFuture that will finish when the mutations have all been completed.

checkAndMutateRow

public com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)

Mutate a row atomically dependent on a precondition.

Specified by:

checkAndMutateRow in interface BigtableDataClient

Parameters:

request - a CheckAndMutateRowRequest object.

Returns:

a CheckAndMutateRowResponse object.

checkAndMutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request)

Mutate a row atomically dependent on a precondition.

Specified by:

checkAndMutateRowAsync in interface BigtableDataClient

Parameters:

request - a CheckAndMutateRowRequest object.

Returns:

a ListenableFuture that will finish when the mutation has completed.

readModifyWriteRow

public com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)

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

Specified by:

readModifyWriteRow in interface BigtableDataClient

Parameters:

request - a ReadModifyWriteRowRequest object.

Returns:

a ReadModifyWriteRowResponse object.

readModifyWriteRowAsync

public com.google.common.util.concurrent.ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request)

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

Specified by:

readModifyWriteRowAsync in interface BigtableDataClient

Parameters:

request - a ReadModifyWriteRowRequest object.

Returns:

a ListenableFuture that will finish when the mutation has completed.

sampleRowKeys

public List<com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request)

Sample row keys from a table.

Specified by:

sampleRowKeys in interface BigtableDataClient

Parameters:

request - a SampleRowKeysRequest object.

Returns:

an immutable List object.

sampleRowKeysAsync

public com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>> sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request)

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

Specified by:

sampleRowKeysAsync in interface BigtableDataClient

Parameters:

request - a SampleRowKeysRequest object.

Returns:

a ListenableFuture object.

readRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<com.google.bigtable.v2.Row>> readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)

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

Specified by:

readRowsAsync in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

Returns:

a ListenableFuture that will finish when all reads have completed.

readFlatRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<FlatRow>> readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)

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

Specified by:

readFlatRowsAsync in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

Returns:

a ListenableFuture that will finish when all reads have completed.

readFlatRowsList

public List<FlatRow> readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request)

Returns a list of FlatRows, in key order.

Specified by:

readFlatRowsList in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

Returns:

a List with FlatRows.

readRows

public ResultScanner<com.google.bigtable.v2.Row> readRows(com.google.bigtable.v2.ReadRowsRequest request)

Perform a scan over Rows, in key order.

Specified by:

readRows in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

Returns:

a ResultScanner object.

readFlatRows

public ResultScanner<FlatRow> readFlatRows(com.google.bigtable.v2.ReadRowsRequest request)

Perform a scan over FlatRows, in key order.

Specified by:

readFlatRows in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

Returns:

a ResultScanner object.

readFlatRows

public ScanHandler readFlatRows(com.google.bigtable.v2.ReadRowsRequest request,
                                io.grpc.stub.StreamObserver<FlatRow> observer)

Perform a streaming read of FlatRows in key order. It would be a good idea to turn on client side timeouts via CallOptionsConfig.Builder.setUseTimeout(boolean).

Specified by:

readFlatRows in interface BigtableDataClient

Parameters:

request - a ReadRowsRequest object.

observer - a StreamObserver object

Returns:

a ScanHandler which can be used to either cancel or timeout the request.