HBASE-19111 Add CellUtil#isPut and deprecate methods returning/expecting non public-api data
KeyValue.Type, and its corresponding byte value, are not public API. We shouldn't have methods that are expecting them. Added a basic sanity test for isPut and isDelete. Signed-off-by: Ramkrishna <ramkrishna.s.vasude...@intel.com> Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/f4a4144f Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/f4a4144f Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/f4a4144f Branch: refs/heads/branch-2 Commit: f4a4144f35f962c594c18d710eceb4c23ec63ebf Parents: 43b4aab Author: Josh Elser <els...@apache.org> Authored: Fri Oct 27 19:27:59 2017 -0400 Committer: Josh Elser <els...@apache.org> Committed: Mon Nov 6 15:37:16 2017 -0500 ---------------------------------------------------------------------- .../main/java/org/apache/hadoop/hbase/Cell.java | 3 + .../java/org/apache/hadoop/hbase/CellUtil.java | 9 +++ .../hadoop/hbase/client/TestFromClientSide.java | 73 +++++++++++++++----- 3 files changed, 66 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/f4a4144f/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java ---------------------------------------------------------------------- diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java index b2f6304..f5833c8 100644 --- a/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java @@ -133,7 +133,10 @@ public interface Cell { /** * @return The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc + * @deprecated since 2.0.0, use appropriate {@link CellUtil#isDelete} or + * {@link CellUtil#isPut(Cell)} methods instead. This will be removed in 3.0.0. */ + @Deprecated byte getTypeByte(); http://git-wip-us.apache.org/repos/asf/hbase/blob/f4a4144f/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java ---------------------------------------------------------------------- diff --git a/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java b/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java index 206a897..30283f1 100644 --- a/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java +++ b/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java @@ -927,6 +927,7 @@ public final class CellUtil { * @return True if a delete type, a {@link KeyValue.Type#Delete} or a {KeyValue.Type#DeleteFamily} * or a {@link KeyValue.Type#DeleteColumn} KeyValue type. */ + @SuppressWarnings("deprecation") public static boolean isDelete(final Cell cell) { return PrivateCellUtil.isDelete(cell.getTypeByte()); } @@ -993,6 +994,14 @@ public final class CellUtil { } /** + * @return True if this cell is a Put. + */ + @SuppressWarnings("deprecation") + public static boolean isPut(Cell cell) { + return cell.getTypeByte() == Type.Put.getCode(); + } + + /** * Estimate based on keyvalue's serialization format in the RPC layer. Note that there is an extra * SIZEOF_INT added to the size here that indicates the actual length of the cell for cases where * cell's are serialized in a contiguous format (For eg in RPCs). http://git-wip-us.apache.org/repos/asf/hbase/blob/f4a4144f/hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java ---------------------------------------------------------------------- diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java index 804f821..02d3797 100644 --- a/hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java +++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestFromClientSide.java @@ -50,6 +50,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.hbase.Cell; +import org.apache.hadoop.hbase.CellScanner; import org.apache.hadoop.hbase.CellUtil; import org.apache.hadoop.hbase.ClusterStatus.Option; import org.apache.hadoop.hbase.CompareOperator; @@ -132,9 +133,6 @@ public class TestFromClientSide { @Rule public TestName name = new TestName(); - /** - * @throws java.lang.Exception - */ @BeforeClass public static void setUpBeforeClass() throws Exception { // Uncomment the following lines if more verbosity is needed for @@ -151,9 +149,6 @@ public class TestFromClientSide { TEST_UTIL.startMiniCluster(SLAVES); } - /** - * @throws java.lang.Exception - */ @AfterClass public static void tearDownAfterClass() throws Exception { TEST_UTIL.shutdownMiniCluster(); @@ -342,8 +337,6 @@ public class TestFromClientSide { /** * Test from client side of an involved filter against a multi family that * involves deletes. - * - * @throws Exception */ @Test public void testWeirdCacheBehaviour() throws Exception { @@ -468,8 +461,6 @@ public class TestFromClientSide { * Test filters when multiple regions. It does counts. Needs eye-balling of * logs to ensure that we're not scanning more regions that we're supposed to. * Related to the TestFilterAcrossRegions over in the o.a.h.h.filter package. - * @throws IOException - * @throws InterruptedException */ @Test public void testFilterAcrossMultipleRegions() @@ -4106,7 +4097,6 @@ public class TestFromClientSide { /** * test for HBASE-737 - * @throws IOException */ @Test public void testHBase737 () throws IOException { @@ -4229,8 +4219,6 @@ public class TestFromClientSide { /** * simple test that just executes parts of the client * API that accept a pre-created Connection instance - * - * @throws IOException */ @Test public void testUnmanagedHConnection() throws IOException { @@ -4247,8 +4235,6 @@ public class TestFromClientSide { /** * test of that unmanaged HConnections are able to reconnect * properly (see HBASE-5058) - * - * @throws Exception */ @Test public void testUnmanagedHConnectionReconnect() throws Exception { @@ -4467,7 +4453,6 @@ public class TestFromClientSide { /** * For HBASE-2156 - * @throws Exception */ @Test public void testScanVariableReuse() throws Exception { @@ -4993,7 +4978,6 @@ public class TestFromClientSide { /** * Test ScanMetrics - * @throws Exception */ @Test @SuppressWarnings ("unused") @@ -5131,8 +5115,6 @@ public class TestFromClientSide { * * Performs inserts, flushes, and compactions, verifying changes in the block * cache along the way. - * - * @throws Exception */ @Test public void testCacheOnWriteEvictOnClose() throws Exception { @@ -6562,4 +6544,57 @@ public class TestFromClientSide { table.close(); admin.close(); } + + @Test + public void testCellUtilTypeMethods() throws IOException { + final TableName tableName = TableName.valueOf(name.getMethodName()); + Table table = TEST_UTIL.createTable(tableName, FAMILY); + + final byte[] row = Bytes.toBytes("p"); + Put p = new Put(row); + p.addColumn(FAMILY, QUALIFIER, VALUE); + table.put(p); + + try (ResultScanner scanner = table.getScanner(new Scan())) { + Result result = scanner.next(); + assertNotNull(result); + CellScanner cs = result.cellScanner(); + assertTrue(cs.advance()); + Cell c = cs.current(); + assertTrue(CellUtil.isPut(c)); + assertFalse(CellUtil.isDelete(c)); + assertFalse(cs.advance()); + assertNull(scanner.next()); + } + + Delete d = new Delete(row); + d.addColumn(FAMILY, QUALIFIER); + table.delete(d); + + Scan scan = new Scan(); + scan.setRaw(true); + try (ResultScanner scanner = table.getScanner(scan)) { + Result result = scanner.next(); + assertNotNull(result); + CellScanner cs = result.cellScanner(); + assertTrue(cs.advance()); + + // First cell should be the delete (masking the Put) + Cell c = cs.current(); + assertTrue("Cell should be a Delete: " + c, CellUtil.isDelete(c)); + assertFalse("Cell should not be a Put: " + c, CellUtil.isPut(c)); + + // Second cell should be the original Put + assertTrue(cs.advance()); + c = cs.current(); + assertFalse("Cell should not be a Delete: " + c, CellUtil.isDelete(c)); + assertTrue("Cell should be a Put: " + c, CellUtil.isPut(c)); + + // No more cells in this row + assertFalse(cs.advance()); + + // No more results in this scan + assertNull(scanner.next()); + } + } }
