HBase(1.0.2) API数据模型

Love The Way You Lie 2021-12-16 07:21 222阅读 0赞

几个相关类与HBase数据模型之间的对应关系

<table> 
 <tbody> 
  <tr> 
   <td>java类</td> 
   <td>HBase数据模型</td> 
  </tr> 
  <tr> 
   <td>HBaseAdmin</td> 
   <td>数据库（DataBase)</td> 
  </tr> 
  <tr> 
   <td>HBaseConfiguration</td> 
  </tr> 
  <tr> 
   <td>HTable</td> 
   <td>表（Table)</td> 
  </tr> 
  <tr> 
   <td>HTableDescriptor</td> 
   <td>列族（Column Family)</td> 
  </tr> 
  <tr> 
   <td>Put</td> 
   <td>列修饰符（Column Qualifier）</td> 
  </tr> 
  <tr> 
   <td>Get</td> 
  </tr> 
  <tr> 
   <td>Scanner</td> 
  </tr> 
 </tbody> 
</table>

一、HBaseConfiguration

关系：org.apache.hadoop.hbase.HBaseConfiguration

作用：对HBase进行配置

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>addResource(Path file)</td> 
   <td>通过给定的路径所指的文件来添加资源</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>clear()</td> 
   <td>清空所有已设置的属性</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>get(String name)</td> 
   <td>获取属性名对应的值</td> 
  </tr> 
  <tr> 
   <td>String</td> 
   <td>getBoolean(String name, boolean defaultValue)</td> 
   <td>获取为boolean类型的属性值，如果其属性值类型部位boolean,则返回默认属性值</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>set(String name, String value)</td> 
   <td>通过属性名来设置值</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setBoolean(String name, boolean value)</td> 
   <td>设置boolean类型的属性值</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HBaseConfiguration hconfig = new HBaseConfiguration();
2.  hconfig.set("hbase.zookeeper.property.clientPort","2181");

复制代码

该方法设置了"hbase.zookeeper.property.clientPort"的端口号为2181。一般情况下，HBaseConfiguration会使用构造函数进行初始化，然后在使用其他方法。

二、HBaseAdmin

关系：org.apache.hadoop.hbase.client.HBaseAdmin

作用：提供了一个接口来管理HBase数据库的表信息。它提供的方法包括：创建表，删除表，列出表项，使表有效或无效，以及添加或删除表列族成员等。

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>&nbsp; &nbsp;&nbsp; &nbsp;void</td> 
   <td>addColumn(String tableName, HColumnDescriptor column)</td> 
   <td>向一个已经存在的表添加咧</td> 
  </tr> 
  <tr> 
   <td>checkHBaseAvailable(HBaseConfiguration conf)</td> 
   <td>静态函数，查看HBase是否处于运行状态</td> 
  </tr> 
  <tr> 
   <td>createTable(HTableDescriptor desc)</td> 
   <td>创建一个表，同步操作</td> 
  </tr> 
  <tr> 
   <td>deleteTable(byte[] tableName)</td> 
   <td>删除一个已经存在的表</td> 
  </tr> 
  <tr> 
   <td>enableTable(byte[] tableName)</td> 
   <td>使表处于有效状态</td> 
  </tr> 
  <tr> 
   <td>disableTable(byte[] tableName)</td> 
   <td>使表处于无效状态</td> 
  </tr> 
  <tr> 
   <td>HTableDescriptor[]</td> 
   <td>listTables()</td> 
   <td>列出所有用户控件表项</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>modifyTable(byte[] tableName, HTableDescriptor htd)</td> 
   <td>修改表的模式，是异步的操作，可能需要花费一定的时间</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>tableExists(String tableName)</td> 
   <td>检查表是否存在</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HBaseAdmin admin = new HBaseAdmin(config);
2.  admin.disableTable("tablename")

复制代码

三、HTableDescriptor

关系：org.apache.hadoop.hbase.HTableDescriptor

作用：包含了表的名字极其对应表的列族

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>addFamily(HColumnDescriptor)</td> 
   <td>添加一个列族</td> 
  </tr> 
  <tr> 
   <td>HColumnDescriptor</td> 
   <td>removeFamily(byte[] column)</td> 
   <td>移除一个列族</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getName()</td> 
   <td>获取表的名字</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getValue(byte[] key)</td> 
   <td>获取属性的值</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setValue(String key, String value)</td> 
   <td>设置属性的值</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HTableDescriptor htd = new HTableDescriptor(table);
2.  htd.addFamily(new HcolumnDescriptor("family"));

复制代码

在上述例子中，通过一个HColumnDescriptor实例，为HTableDescriptor添加了一个列族：family

四、HColumnDescriptor

关系：org.apache.hadoop.hbase.HColumnDescriptor

作用：维护着关于列族的信息，例如版本号，压缩设置等。它通常在创建表或者为表添加列族的时候使用。列族被创建后不能直接修改，只能通过删除然后重新创建的方式。列族被删除的时候，列族里面的数据也会同时被删除。

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getName()</td> 
   <td>获取列族的名字</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getValue(byte[] key)</td> 
   <td>获取对应的属性的值</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setValue(String key, String value)</td> 
   <td>设置对应属性的值</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HTableDescriptor htd = new HTableDescriptor(tablename);
2.  HColumnDescriptor col = new HColumnDescriptor("content:");
3.  htd.addFamily(col);

复制代码

此例添加了一个content的列族

五、HTable

关系：org.apache.hadoop.hbase.client.HTable

作用：可以用来和HBase表直接通信。此方法对于更新操作来说是非线程安全的。

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>checkAdnPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put</td> 
   <td>自动的检查row/family/qualifier是否与给定的值匹配</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>close()</td> 
   <td>释放所有的资源或挂起内部缓冲区中的更新</td> 
  </tr> 
  <tr> 
   <td>Boolean</td> 
   <td>exists(Get get)</td> 
   <td>检查Get实例所指定的值是否存在于HTable的列中</td> 
  </tr> 
  <tr> 
   <td>Result</td> 
   <td>get(Get get)</td> 
   <td>获取指定行的某些单元格所对应的值</td> 
  </tr> 
  <tr> 
   <td>byte[][]</td> 
   <td>getEndKeys()</td> 
   <td>获取当前一打开的表每个区域的结束键值</td> 
  </tr> 
  <tr> 
   <td>ResultScanner</td> 
   <td>getScanner(byte[] family)</td> 
   <td>获取当前给定列族的scanner实例</td> 
  </tr> 
  <tr> 
   <td>HTableDescriptor</td> 
   <td>getTableDescriptor()</td> 
   <td>获取当前表的HTableDescriptor实例</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getTableName()</td> 
   <td>获取表名</td> 
  </tr> 
  <tr> 
   <td>static boolean</td> 
   <td>isTableEnabled(HBaseConfiguration conf, String tableName)</td> 
   <td>检查表是否有效</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>put(Put put)</td> 
   <td>向表中添加值</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HTable table = new HTable(conf, Bytes.toBytes(tablename));
2.  ResultScanner scanner = table.getScanner(family);

复制代码

六、Put

关系：org.apache.hadoop.hbase.client.Put

作用：用来对单个行执行添加操作

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>Put</td> 
   <td>add(byte[] family, byte[] qualifier, byte[] value)</td> 
   <td>将指定的列和对应的值添加到Put实例中</td> 
  </tr> 
  <tr> 
   <td>Put</td> 
   <td>add(byte[] family, byte[] qualifier, long ts, byte[] value)</td> 
   <td>将指定的列和对应的值及时间戳添加到Put实例中</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getRow()</td> 
   <td>获取Put实例的行</td> 
  </tr> 
  <tr> 
   <td>RowLock</td> 
   <td>getRowLock()</td> 
   <td>获取Put实例的行锁</td> 
  </tr> 
  <tr> 
   <td>long</td> 
   <td>getTimeStamp()</td> 
   <td>获取Put实例的时间戳</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>isEmpty()</td> 
   <td>检查familyMap是否为空</td> 
  </tr> 
  <tr> 
   <td>Put</td> 
   <td>setTimeStamp(long timeStamp)</td> 
   <td>设置Put实例的时间戳</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HTable table = new HTable(conf,Bytes.toBytes(tablename));
2.  Put p = new Put(brow);//为指定行创建一个Put操作
3.  p.add(family,qualifier,value);
4.  table.put(p);

复制代码

七、Get

关系：org.apache.hadoop.hbase.client.Get

作用：用来获取单个行的相关信息

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>Get</td> 
   <td>addColumn(byte[] family, byte[] qualifier)</td> 
   <td>获取指定列族和列修饰符对应的列</td> 
  </tr> 
  <tr> 
   <td>Get</td> 
   <td>addFamily(byte[] family)</td> 
   <td>通过指定的列族获取其对应列的所有列</td> 
  </tr> 
  <tr> 
   <td>Get</td> 
   <td>setTimeRange(long minStamp,long maxStamp)</td> 
   <td>获取指定取件的列的版本号</td> 
  </tr> 
  <tr> 
   <td>Get</td> 
   <td>setFilter(Filter filter)</td> 
   <td>当执行Get操作时设置服务器端的过滤器</td> 
  </tr> 
 </tbody> 
</table>

用法示例：

1.  HTable table = new HTable(conf, Bytes.toBytes(tablename));
2.  Get g = new Get(Bytes.toBytes(row));

复制代码

八、Result

关系：org.apache.hadoop.hbase.client.Result

作用：存储Get或者Scan操作后获取表的单行值。使用此类提供的方法可以直接获取值或者各种Map结构（key-value对）

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>containsColumn(byte[] family, byte[] qualifier)</td> 
   <td>检查指定的列是否存在</td> 
  </tr> 
  <tr> 
   <td>NavigableMap&lt;byte[],byte[]&gt;</td> 
   <td>getFamilyMap(byte[] family)</td> 
   <td>获取对应列族所包含的修饰符与值的键值对</td> 
  </tr> 
  <tr> 
   <td>byte[]</td> 
   <td>getValue(byte[] family, byte[] qualifier)</td> 
   <td>获取对应列的最新值</td> 
  </tr> 
 </tbody> 
</table>

九、ResultScanner

关系：Interface

作用：客户端获取值的接口

<table> 
 <tbody> 
  <tr> 
   <td>返回值</td> 
   <td>函数</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>close()</td> 
   <td>关闭scanner并释放分配给它的资源</td> 
  </tr> 
  <tr> 
   <td>Result</td> 
   <td>next()</td> 
   <td>获取下一行的值</td> 
  </tr> 
 </tbody> 
</table>

转载于:https://www.cnblogs.com/runnerjack/p/9341040.html