HBase——常用的Java API

小灰灰 2022-05-26 04:17 222阅读 0赞

与HBase数据存储管理相关的java API主要包括：HBaseConfiguration、HTableDescriptor、HColumnDescriptor、Put、Get、ResultScanner、Result、Scan。以下讲解这些类的功能与常用方法。

（1）   Admin

public interface Admin，是一个接口，必须通过调用Connection.getAdmin()方法，返回一个实例化对象。该接口用于管理HBase数据库的表信息，包括创建表、删除表、列出表项、使表有效或无效、添加或删除表的列族成员、检查HBase的运行状态等。

<table> 
 <tbody> 
 <tr> 
 <td>void addColumn(TableName tableName, ColumnFamilyDescriptor columnFamily) 向一个已存在的表中添加列</td> 
 </tr> 
 <tr> 
 <td>void closeRegion(String regionname, String serverName) 关闭Resign</td> 
 </tr> 
 <tr> 
 <td>void createTable(TableDescriptor desc) 创建表</td> 
 </tr> 
 <tr> 
 <td>void disableTable(TableName tableName) 使表无效</td> 
 </tr> 
 <tr> 
 <td>void deleteTable(TableName tableName) 删除表</td> 
 </tr> 
 <tr> 
 <td>Void enableTable(TableName tableName) 使表有效</td> 
 </tr> 
 <tr> 
 <td>Boolean tableExists(TableName tableName) 检查表是否存在</td> 
 </tr> 
 <tr> 
 <td>HTableDescriptor[] &nbsp;listTables() 列出所有表</td> 
 </tr> 
 <tr> 
 <td>Void void abort(String why, Throwable e) 终止服务器或客户端</td> 
 </tr> 
 <tr> 
 <td>Boolean balancer() 负载均衡</td> 
 </tr> 
 </tbody> 
</table>

（2）   HBaseConfiguration

该类用于管理HBase的配置信息。

<table> 
 <tbody> 
 <tr> 
 <td>Configuration create() 使用默认的HBase配置文件创建Configuration</td> 
 </tr> 
 <tr> 
 <td>Configuration &nbsp;addHbaseResources(Configuration conf) 向当前Configuration添加conf中的配置信息</td> 
 </tr> 
 <tr> 
 <td>Void merge(Configuration destConf, Configuration srcConf) 合并两个Configuration</td> 
 </tr> 
 </tbody> 
</table>

（3）   Table

public interface [Table][]，接口，必须调用Connection.getTable()返回一个实例化对象。该接口用于与HBase进行通信。多线程情况下，使用HTablePool较好。

<table> 
 <tbody> 
 <tr> 
 <td>Void close() 释放所有资源</td> 
 </tr> 
 <tr> 
 <td>Void delete(Delete delete) 删除指定的单元格或行</td> 
 </tr> 
 <tr> 
 <td>Boolean exists(Get get) 检查Get对象指定的列是否存在</td> 
 </tr> 
 <tr> 
 <td>Result get(Get get) 从指定行的单元格中取得相应的值</td> 
 </tr> 
 <tr> 
 <td>Void put(Put put) 向表中添加值</td> 
 </tr> 
 <tr> 
 <td>ResultScanner &nbsp;getScanner(byte[] family) ResultScanner &nbsp;getScanner(byte[] family, byte[] qualifier) ResultScanner &nbsp;getScanner(Scan scan) 获得ResultScanner &nbsp;实例</td> 
 </tr> 
 <tr> 
 <td>HTableDescriptor &nbsp;getTableDescriptor() 获得当前表格的HTableDescriptor对象</td> 
 </tr> 
 <tr> 
 <td>TableName getName() 获取当前表名</td> 
 </tr> 
 </tbody> 
</table>

（4）   HTableDescriptor

包含了HBase中表格的详细信息，如表的列族、表类型等。

<table> 
 <tbody> 
 <tr> 
 <td>HTableDescriptor&nbsp; addFamily(HColumnDescriptor family) 添加列族</td> 
 </tr> 
 <tr> 
 <td>Collection&lt;HColumnDescriptor&gt;&nbsp; getFamilies() 返回所有列族的名称</td> 
 </tr> 
 <tr> 
 <td>TableName getTableName() 返回表名实例</td> 
 </tr> 
 <tr> 
 <td>Byte[] getValue(Bytes key) 获得属性值</td> 
 </tr> 
 <tr> 
 <td>HTableDescriptor&nbsp; removeFamily(byte[] column) 删除列族</td> 
 </tr> 
 <tr> 
 <td>HTableDescriptor&nbsp; setValue(byte[] key, byte[] value) 设置属性的值</td> 
 </tr> 
 </tbody> 
</table>

（5）   HColumnDescriptor

包含了列族的详细信息，通常在添加列族或创建表时使用。列族一旦建立就不能修改，只能通过删除列族，然后创建新的列族来间接修改。一旦列族被删除，该列族包含的数据也随之删除。

<table> 
 <tbody> 
 <tr> 
 <td>Byte[] getName() 获得列族名称</td> 
 </tr> 
 <tr> 
 <td>Byte[] getValue(byte[] key) 获得某列单元格的值</td> 
 </tr> 
 <tr> 
 <td>HColumnDescriptor setValue(byte[] key, byte[] value) 设置某列单元格的值</td> 
 </tr> 
 </tbody> 
</table>

（6）   Put

用于对单元格执行添加数据。

<table> 
 <tbody> 
 <tr> 
 <td>Put addColumn(byte[] family, byte[] qualifier, byte[] value) 将指定的列族、列、值添加到Put对象中</td> 
 </tr> 
 <tr> 
 <td>List&lt;Cell&gt; &nbsp;get(byte[] family, byte[] qualifier) 获取列族和列中的所有单元格</td> 
 </tr> 
 <tr> 
 <td>Boolean has(byte[] family, byte[] qualifier) 列族和列是否存在</td> 
 </tr> 
 <tr> 
 <td>Boolean has(byte[] family, byte[] qualifier, byte[] value) 检查列族和列中是否存在value</td> 
 </tr> 
 </tbody> 
</table>

（7）   Get

获取单行的信息。

<table> 
 <tbody> 
 <tr> 
 <td>Get addColumn(byte[] family, byte[] qualifier) 根据列族和列获取对应的列</td> 
 </tr> 
 <tr> 
 <td>Get setFilter(Filter filter) 通过设置过滤器获取具体的列</td> 
 </tr> 
 </tbody> 
</table>

（8）   Result

用于存放Get或Put操作后的结果，并以<key,value>的格式存放在map结构中。

<table> 
 <tbody> 
 <tr> 
 <td>Boolean containsColumn(byte[] family, byte[] qualifier) 检查是否包含列族和列限定符指定的列</td> 
 </tr> 
 <tr> 
 <td>List&lt;Cell&gt; getColumnCells(byte[] family, byte[] qualifier) 获得列族和列限定符指定的列中的所有单元格</td> 
 </tr> 
 <tr> 
 <td>NavigableMap&lt;byte[],byte[]&gt; getFamilyMap(byte[] family) 根据列族获得包含列和值的所有行的键值对</td> 
 </tr> 
 <tr> 
 <td>Byte[] getValue(byte[] family, byte[] qualifier) 获得列族和列指定的单元格的最新值</td> 
 </tr> 
 </tbody> 
</table>

（9）   ResultScanner

<table> 
 <tbody> 
 <tr> 
 <td>Void close() 关闭scanner并释放资源</td> 
 </tr> 
 <tr> 
 <td>Result next() 获得下一个Result实例</td> 
 </tr> 
 </tbody> 
</table>

（10）   Scan

可以利用Scan限定需要查找的数据，如限定版本号、起始行号、终止行号、列族、列名、返回值数量上限等。

<table> 
 <tbody> 
 <tr> 
 <td>Scan addFamily(byte[] family) 限定列族</td> 
 </tr> 
 <tr> 
 <td>public&nbsp;<a href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client" rel="nofollow">Scan</a>&nbsp;<a href="https://hbase.apache.org/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html#line.341" rel="nofollow">addColumn</a>(byte[]&nbsp;family, byte[]&nbsp;qualifier) 限定列族和列</td> 
 </tr> 
 <tr> 
 <td>public Scan setMaxVersions() public Scan setMaxVersions(int maxVersions) 限定版本的最大个数</td> 
 </tr> 
 <tr> 
 <td>public&nbsp;<a href="https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client" rel="nofollow">Scan</a>&nbsp;<a href="https://hbase.apache.org/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html#line.365" rel="nofollow">setTimeRange</a>(long&nbsp;minStamp, long&nbsp;maxStamp) 限定最大最小时间戳范围</td> 
 </tr> 
 <tr> 
 <td>public Scan setFilter(Filter filter) 指定Fileter过滤</td> 
 </tr> 
 <tr> 
 <td>public Scan setStartRow(byte[] startRow) 限定开始的行</td> 
 </tr> 
 <tr> 
 <td>public Scan setStopRow(byte[] stopRow) 限定结束的行（不包含）</td> 
 </tr> 
 <tr> 
 <td>public Scan setBatch(int batch) 限定最多返回的单元格数目</td> 
 </tr> 
 </tbody> 
</table>

更多信息，参考[官方API][API]

[Table]: https://hbase.apache.org/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html#line.54
[API]: https://hbase.apache.org/apidocs/