feat: HBase Compatibility Phase 3 - Ecosystem Integration and DDL Support

example/simple-hbase-demo/src/main/java/com/oceanbase/example/SimpleHBaseClientDemo.java

@@ -19,6 +19,8 @@
 
 import com.alipay.oceanbase.hbase.OHTableClient;
 import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.Cell;
+import org.apache.hadoop.hbase.CellUtil;
 import org.apache.hadoop.hbase.client.Get;
 import org.apache.hadoop.hbase.client.Put;
 import org.apache.hadoop.hbase.client.Result;
@@ -49,7 +51,7 @@ public static void simpleTest() throws Exception {
         byte[] rowKey = toBytes("rowKey1");
         byte[] column = toBytes("column1");
         Put put = new Put(rowKey);
-        put.add(family, column, System.currentTimeMillis(), toBytes("value1"));
+        put.addColumn(family, column, System.currentTimeMillis(), toBytes("value1"));
         hTable.put(put);
 
         // 3. get data like hbase
@@ -58,7 +60,7 @@ public static void simpleTest() throws Exception {
         Result r = hTable.get(get);
         if (!r.isEmpty()) {
             Cell cell = r.rawCells()[0];
-            System.out.printf("column1: " + CellUtil.cloneQualifier(r));
+            System.out.printf("column1: " + CellUtil.cloneQualifier(cell));
         }
 
         // 4. close

pom.xml

@@ -54,7 +54,7 @@
         <project.build.sourceEncoding>${project.encoding}</project.build.sourceEncoding>
         <project.encoding>UTF-8</project.encoding>
         <slf4j.version>1.7.21</slf4j.version>
-        <table.client.version>2.0.0</table.client.version>
+        <table.client.version>2.0.1-SNAPSHOT</table.client.version>
     </properties>
 
     <dependencies>
@@ -167,6 +167,10 @@
                     <artifactId>jersey-json</artifactId>
                     <groupId>com.sun.jersey</groupId>
                 </exclusion>
+                <exclusion>
+                    <artifactId>jackson-databind</artifactId>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                </exclusion>
             </exclusions>
         </dependency>
         <dependency>

src/main/java/com/alipay/oceanbase/hbase/OHTable.java

@@ -220,8 +220,7 @@ public OHTable(Configuration configuration, String tableName) throws IOException
             DEFAULT_HBASE_HTABLE_THREAD_KEEP_ALIVE_TIME);
         this.executePool = createDefaultThreadPoolExecutor(1, maxThreads, keepAliveTime);
         OHConnectionConfiguration ohConnectionConf = new OHConnectionConfiguration(configuration);
-        int numRetries = configuration.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,
-            HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);
+        int numRetries = ohConnectionConf.getNumRetries();
         this.obTableClient = ObTableClientManager.getOrCreateObTableClient(setUserDefinedNamespace(
             this.tableNameString, ohConnectionConf));
         this.obTableClient.setRpcExecuteTimeout(ohConnectionConf.getRpcTimeout());
@@ -273,8 +272,7 @@ public OHTable(Configuration configuration, final byte[] tableName,
         this.executePool = executePool;
         this.cleanupPoolOnClose = false;
         OHConnectionConfiguration ohConnectionConf = new OHConnectionConfiguration(configuration);
-        int numRetries = configuration.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,
-            HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);
+        int numRetries = ohConnectionConf.getNumRetries();
         this.obTableClient = ObTableClientManager.getOrCreateObTableClient(setUserDefinedNamespace(
             this.tableNameString, ohConnectionConf));
         this.obTableClient.setRpcExecuteTimeout(ohConnectionConf.getRpcTimeout());
@@ -345,8 +343,7 @@ public OHTable(TableName tableName, Connection connection,
             DEFAULT_HBASE_HTABLE_PUT_WRITE_BUFFER_CHECK);
         this.writeBufferSize = connectionConfig.getWriteBufferSize();
         this.tableName = tableName.getName();
-        int numRetries = configuration.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,
-            HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);
+        int numRetries = connectionConfig.getNumRetries();
         this.obTableClient = ObTableClientManager.getOrCreateObTableClient(setUserDefinedNamespace(
             this.tableNameString, connectionConfig));
         this.obTableClient.setRpcExecuteTimeout(rpcTimeout);
@@ -389,8 +386,7 @@ public OHTable(Connection connection, ObTableBuilderBase builder,
         this.putWriteBufferCheck = this.configuration.getInt(HBASE_HTABLE_PUT_WRITE_BUFFER_CHECK,
             DEFAULT_HBASE_HTABLE_PUT_WRITE_BUFFER_CHECK);
         this.writeBufferSize = connectionConfig.getWriteBufferSize();
-        int numRetries = configuration.getInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER,
-            HConstants.DEFAULT_HBASE_CLIENT_RETRIES_NUMBER);
+        int numRetries = connectionConfig.getNumRetries();
         this.obTableClient = ObTableClientManager.getOrCreateObTableClient(setUserDefinedNamespace(
             this.tableNameString, connectionConfig));
         this.obTableClient.setRpcExecuteTimeout(rpcTimeout);
@@ -462,7 +458,7 @@ private void finishSetUp() {
             WRITE_BUFFER_SIZE_DEFAULT);
     }
 
-    private OHConnectionConfiguration setUserDefinedNamespace(String tableNameString,
+    public static OHConnectionConfiguration setUserDefinedNamespace(String tableNameString,
                                                               OHConnectionConfiguration ohConnectionConf)
                                                                                                          throws IllegalArgumentException {
         if (tableNameString.indexOf(':') != -1) {
@@ -503,13 +499,15 @@ public Configuration getConfiguration() {
     }
 
     @Override
-    public HTableDescriptor getTableDescriptor() {
-        throw new FeatureNotSupportedException("not supported yet.");
+    public HTableDescriptor getTableDescriptor() throws IOException {
+        OHTableDescriptorExecutor executor = new OHTableDescriptorExecutor(tableNameString, obTableClient);
+        return executor.getTableDescriptor();
     }
 
     @Override
     public TableDescriptor getDescriptor() throws IOException {
-        throw new FeatureNotSupportedException("not supported yet.");
+        OHTableDescriptorExecutor executor = new OHTableDescriptorExecutor(tableNameString, obTableClient);
+        return executor.getTableDescriptor();
     }
 
     /**
@@ -1950,6 +1948,8 @@ private ObTableQuery buildObTableQuery(ObHTableFilter filter, final Scan scan) {
                 HConstants.DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE));
         obTableQuery.setObKVParams(buildOBKVParams(scan));
         obTableQuery.setScanRangeColumns("K", "Q", "T");
+        byte[] hotOnly = scan.getAttribute(HBASE_HTABLE_QUERY_HOT_ONLY);
+        obTableQuery.setHotOnly(hotOnly != null && Arrays.equals(hotOnly, "true".getBytes()));
         return obTableQuery;
     }
 
@@ -1967,6 +1967,8 @@ private ObTableQuery buildObTableQuery(final Get get, Collection<byte[]> columnQ
         }
         obTableQuery.setObKVParams(buildOBKVParams(get));
         obTableQuery.setScanRangeColumns("K", "Q", "T");
+        byte[] hotOnly = get.getAttribute(HBASE_HTABLE_QUERY_HOT_ONLY);
+        obTableQuery.setHotOnly(hotOnly != null && Arrays.equals(hotOnly, "true".getBytes()));
         return obTableQuery;
     }
 

src/main/java/com/alipay/oceanbase/hbase/OHTableClient.java

@@ -223,7 +223,8 @@ public HTableDescriptor getTableDescriptor() throws IOException {
 
     @Override
     public TableDescriptor getDescriptor() throws IOException {
-        return null;
+        checkStatus();
+        return ohTable.getDescriptor();
     }
 
     @Override

src/main/java/com/alipay/oceanbase/hbase/constants/OHConstants.java

@@ -23,17 +23,17 @@
 public final class OHConstants {
 
     /**
-     * ocenbase hbase root server http url
+     * oceanbase hbase root server http url
      */
     public static final String   HBASE_OCEANBASE_PARAM_URL                   = "hbase.oceanbase.paramURL";
 
     /**
-     * ocenbase hbase connect server username
+     * oceanbase hbase connect server username
      */
     public static final String   HBASE_OCEANBASE_FULL_USER_NAME              = "hbase.oceanbase.fullUserName";
 
     /**
-     * ocenbase hbase connect server password
+     * oceanbase hbase connect server password
      */
     public static final String   HBASE_OCEANBASE_PASSWORD                    = "hbase.oceanbase.password";
 
@@ -48,39 +48,39 @@ public final class OHConstants {
     public static final String   HBASE_OCEANBASE_SYS_PASSWORD                = "hbase.oceanbase.sysPassword";
 
     /**
-     * ocenbase hbase connect server password
+     * oceanbase hbase connect server password
      */
     public static final String   HBASE_OCEANBASE_BATCH_EXECUTOR              = "hbase.oceanbase.batch.executor";
 
     /**
-     * ocenbase hbase connect server ODP address
+     * oceanbase hbase connect server ODP address
      */
     public static final String   HBASE_OCEANBASE_ODP_ADDR                    = "hbase.oceanbase.odpAddr";
 
     /**
-     * ocenbase hbase connect server ODP port
+     * oceanbase hbase connect server ODP port
      */
     public static final String   HBASE_OCEANBASE_ODP_PORT                    = "hbase.oceanbase.odpPort";
 
     /**
-     * ocenbase hbase connect server ODP mode
+     * oceanbase hbase connect server ODP mode
      */
     public static final String   HBASE_OCEANBASE_ODP_MODE                    = "hbase.oceanbase.odpMode";
 
     /**
-     * ocenbase hbase connect server database
+     * oceanbase hbase connect server database
      */
     public static final String   HBASE_OCEANBASE_DATABASE                    = "hbase.oceanbase.database";
 
     /**
-     * ocenbase hbase model rowkey column is consist of following column
+     * oceanbase hbase model rowkey column is consist of following column
      * K, Q, T hbase value
      */
     public static final String[] ROW_KEY_COLUMNS                             = new String[] { "K",
             "Q", "T"                                                        };
 
     /**
-     * ocenbase hbase model value column is consist of following column
+     * oceanbase hbase model value column is consist of following column
      * V hbase value
      */
     public static final String[] V_COLUMNS                                   = new String[] { "V" };
@@ -124,6 +124,11 @@ public final class OHConstants {
      */
     public static final String   DEFAULT_HBASE_HTABLE_TEST_LOAD_SUFFIX       = "_t";
 
+    /**
+     * use to specify whether to query only the data in hot storage when performing a query.
+     */
+    public static final String   HBASE_HTABLE_QUERY_HOT_ONLY       = "hbase.htable.query.hot_only";
+
     /*-------------------------------------------------------------------------------------------------------------*/
 
     /**

src/main/java/com/alipay/oceanbase/hbase/execute/AbstractObTableMetaExecutor.java

@@ -0,0 +1,49 @@
+/*-
+ * #%L
+ * com.oceanbase:obkv-hbase-client
+ * %%
+ * Copyright (C) 2022 - 2025 OceanBase Group
+ * %%
+ * OBKV HBase Client Framework  is licensed under Mulan PSL v2.
+ * You can use this software according to the terms and conditions of the Mulan PSL v2.
+ * You may obtain a copy of Mulan PSL v2 at:
+ *          http://license.coscl.org.cn/MulanPSL2
+ * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+ * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+ * See the Mulan PSL v2 for more details.
+ * #L%
+ */
+
+package com.alipay.oceanbase.hbase.execute;
+
+import com.alipay.oceanbase.hbase.util.OHBaseExceptionUtil;
+import com.alipay.oceanbase.rpc.ObTableClient;
+import com.alipay.oceanbase.rpc.exception.ObTableException;
+import com.alipay.oceanbase.rpc.meta.ObTableMetaRequest;
+import com.alipay.oceanbase.rpc.meta.ObTableMetaResponse;
+import com.alipay.oceanbase.rpc.table.ObTable;
+
+import java.io.IOException;
+
+public abstract class AbstractObTableMetaExecutor<T> implements ObTableMetaExecutor<T> {
+
+    @Override
+    public T execute(ObTableClient client, ObTableMetaRequest request) throws IOException {
+        if (request.getMetaType() != getMetaType()) {
+            throw new IOException("Invalid meta type, expected " + getMetaType());
+        }
+        ObTable table = client.getRandomTable();
+        ObTableMetaResponse response;
+        try {
+            response = (ObTableMetaResponse) client.executeWithRetry(
+                    table,
+                    request,
+                    null /*tableName*/
+            );
+        } catch (Exception e) {
+            throw OHBaseExceptionUtil.convertTableException(e);
+        }
+        return parse(response);
+    }
+}

src/main/java/com/alipay/oceanbase/hbase/execute/ObTableMetaExecutor.java

@@ -0,0 +1,49 @@
+/*-
+ * #%L
+ * com.oceanbase:obkv-hbase-client
+ * %%
+ * Copyright (C) 2022 - 2025 OceanBase Group
+ * %%
+ * OBKV HBase Client Framework  is licensed under Mulan PSL v2.
+ * You can use this software according to the terms and conditions of the Mulan PSL v2.
+ * You may obtain a copy of Mulan PSL v2 at:
+ *          http://license.coscl.org.cn/MulanPSL2
+ * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+ * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+ * See the Mulan PSL v2 for more details.
+ * #L%
+ */
+
+package com.alipay.oceanbase.hbase.execute;
+
+import com.alipay.oceanbase.rpc.ObTableClient;
+import com.alipay.oceanbase.rpc.meta.ObTableMetaRequest;
+import com.alipay.oceanbase.rpc.meta.ObTableMetaResponse;
+import com.alipay.oceanbase.rpc.meta.ObTableRpcMetaType;
+
+import java.io.IOException;
+
+public interface ObTableMetaExecutor<T> {
+    /**
+     * 执行元数据请求
+     * @param request 元数据请求
+     * @return 解析后的元数据对象
+     * @throws IOException 如果执行失败或解析失败
+     */
+    T execute(ObTableClient client, ObTableMetaRequest request) throws IOException;
+
+    /**
+     * 解析元数据响应, 用户需要重写
+     * @param response 元数据响应
+     * @return 解析后的元数据对象
+     * @throws IOException 如果解析失败
+     */
+    T parse(ObTableMetaResponse response) throws IOException;
+
+    /**
+     * 获取元信息类型, 用户需要重写
+     * @return 元信息类型
+     */
+    ObTableRpcMetaType getMetaType() throws IOException;
+}