com.google.cloud.bigtable.hbase.adapters

Class CheckAndMutateUtil.RequestBuilder

java.lang.Object

com.google.cloud.bigtable.hbase.adapters.CheckAndMutateUtil.RequestBuilder

Enclosing class:

CheckAndMutateUtil

public static class CheckAndMutateUtil.RequestBuilder
extends Object

This class can be used to convert HBase checkAnd* operations to Bigtable ConditionalRowMutations.

Constructor Summary

Constructors

Constructor and Description
RequestBuilder(HBaseRequestAdapter hbaseAdapter, byte[] row, byte[] family) RequestBuilder.

Method Summary

Modifier and Type	Method and Description
com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation	build()
CheckAndMutateUtil.RequestBuilder	ifMatches(org.apache.hadoop.hbase.filter.CompareFilter.CompareOp compareOp, byte[] value) For non-null values, this produces a RowFilter equivalent to:
CheckAndMutateUtil.RequestBuilder	ifNotExists()
CheckAndMutateUtil.RequestBuilder	qualifier(byte[] qualifier)
CheckAndMutateUtil.RequestBuilder	timeRange(long start, long end)
CheckAndMutateUtil.RequestBuilder	withDelete(org.apache.hadoop.hbase.client.Delete delete)
CheckAndMutateUtil.RequestBuilder	withMutations(org.apache.hadoop.hbase.client.RowMutations rm)
CheckAndMutateUtil.RequestBuilder	withPut(org.apache.hadoop.hbase.client.Put put)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestBuilder

public RequestBuilder(HBaseRequestAdapter hbaseAdapter,
                      byte[] row,
                      byte[] family)

RequestBuilder.

Parameters:

hbaseAdapter - a HBaseRequestAdapter used to convert HBase Mutation to Cloud Bigtable Mutation

row - the RowKey in which to to check value matching

family - the family in which to check value matching.

Method Detail

qualifier

public CheckAndMutateUtil.RequestBuilder qualifier(byte[] qualifier)

ifNotExists

public CheckAndMutateUtil.RequestBuilder ifNotExists()

ifMatches

public CheckAndMutateUtil.RequestBuilder ifMatches(org.apache.hadoop.hbase.filter.CompareFilter.CompareOp compareOp,
                                                   @Nullable
                                                   byte[] value)

For non-null values, this produces a RowFilter equivalent to:

   new ValueFilter(reverseCompareOp(compareOp), new BinaryComparator(value)
 

Null values are bit tricky. In HBase 1.* style check and mutate, value == null always means `check non-existence` regardless of compareOp. That's semantically confusing for CompareOperators other than EQUALS. It's even more confusing if value == null and compareOp = NOT_EQUALS.

HBase 2.* APIs introduced an explicit method of checking for "Non-Existence" as an independent concept from compareOp, which is the inspiration for the ifNotExists() method.

Checking for existence in HBase can be expressed as follows:

 compareOp = CompareOp.GREATER_OR_EQUAL, value = new byte[]{Byte.MIN_VALUE})
 

Bigtable decided that value == null with a compareOp of NOT_EQUALS actually means check for existence, even though HBase will still treat it as non-existence.

Parameters:

compareOp - a CompareFilter.CompareOp

value - a byte array.

Returns:

a CheckAndMutateUtil.RequestBuilder object with compareOp and byte array value.

timeRange

public CheckAndMutateUtil.RequestBuilder timeRange(long start,
                                                   long end)

withPut

public CheckAndMutateUtil.RequestBuilder withPut(org.apache.hadoop.hbase.client.Put put)
                                          throws org.apache.hadoop.hbase.DoNotRetryIOException

Throws:

org.apache.hadoop.hbase.DoNotRetryIOException

withDelete

public CheckAndMutateUtil.RequestBuilder withDelete(org.apache.hadoop.hbase.client.Delete delete)
                                             throws org.apache.hadoop.hbase.DoNotRetryIOException

Throws:

org.apache.hadoop.hbase.DoNotRetryIOException

withMutations

public CheckAndMutateUtil.RequestBuilder withMutations(org.apache.hadoop.hbase.client.RowMutations rm)
                                                throws org.apache.hadoop.hbase.DoNotRetryIOException

Throws:

org.apache.hadoop.hbase.DoNotRetryIOException

build

public com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation build()