hbase java api 类介绍

几个相关类与HBase数据模型之间的对应关系java类HBase数据模型HBaseAdmin数据库（DataBase)HBaseConfigurationHTable表（Table)HTableDescriptor列族（Column Family)Put列修饰符（Column Qualifier）GetScanner

一、HBaseConfiguration

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

作用：对HBase进行配置

返回值函数描述voidaddResource(Path file)通过给定的路径所指的文件来添加资源voidclear()清空所有已设置的属性stringget(String name)获取属性名对应的值StringgetBoolean(String name, boolean defaultValue)获取为boolean类型的属性值，如果其属性值类型部位boolean,则返回默认属性值voidset(String name, String value)通过属性名来设置值voidsetBoolean(String name, boolean value)设置boolean类型的属性值

用法示例：

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数据库的表信息。它提供的方法包括：创建表，删除表，列出表项，使表有效或无效，以及添加或删除表列族成员等。

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

用法示例：

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

复制代码

三、HTableDescriptor

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

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

返回值函数描述voidaddFamily(HColumnDescriptor)添加一个列族HColumnDescriptorremoveFamily(byte[] column)移除一个列族byte[]getName()获取表的名字byte[]getValue(byte[] key)获取属性的值voidsetValue(String key, String value)设置属性的值

用法示例：

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

复制代码

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

四、HColumnDescriptor

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

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

返回值函数描述byte[]getName()获取列族的名字byte[]getValue(byte[] key)获取对应的属性的值voidsetValue(String key, String value)设置对应属性的值

用法示例：

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表直接通信。此方法对于更新操作来说是非线程安全的。

返回值函数描述voidcheckAdnPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put自动的检查row/family/qualifier是否与给定的值匹配voidclose()释放所有的资源或挂起内部缓冲区中的更新Booleanexists(Get get)检查Get实例所指定的值是否存在于HTable的列中Resultget(Get get)获取指定行的某些单元格所对应的值byte[][]getEndKeys()获取当前一打开的表每个区域的结束键值ResultScannergetScanner(byte[] family)获取当前给定列族的scanner实例HTableDescriptorgetTableDescriptor()获取当前表的HTableDescriptor实例byte[]getTableName()获取表名static booleanisTableEnabled(HBaseConfiguration conf, String tableName)检查表是否有效voidput(Put put)向表中添加值

用法示例：

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

复制代码

六、Put

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

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

返回值函数描述Putadd(byte[] family, byte[] qualifier, byte[] value)将指定的列和对应的值添加到Put实例中Putadd(byte[] family, byte[] qualifier, long ts, byte[] value)将指定的列和对应的值及时间戳添加到Put实例中byte[]getRow()获取Put实例的行RowLockgetRowLock()获取Put实例的行锁longgetTimeStamp()获取Put实例的时间戳booleanisEmpty()检查familyMap是否为空PutsetTimeStamp(long timeStamp)设置Put实例的时间戳

用法示例：

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

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

返回值函数描述GetaddColumn(byte[] family, byte[] qualifier)获取指定列族和列修饰符对应的列GetaddFamily(byte[] family)通过指定的列族获取其对应列的所有列GetsetTimeRange(long minStamp,long maxStamp)获取指定取件的列的版本号GetsetFilter(Filter filter)当执行Get操作时设置服务器端的过滤器

用法示例：

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对）

返回值函数描述booleancontainsColumn(byte[] family, byte[] qualifier)检查指定的列是否存在NavigableMap<byte[],byte[]>getFamilyMap(byte[] family)获取对应列族所包含的修饰符与值的键值对byte[]getValue(byte[] family, byte[] qualifier)获取对应列的最新值

本文转自：http://blog.csdn.net/lifuxiangcaohui/article/details/39997205

九、ResultScanner

关系：Interface

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

返回值函数描述voidclose()关闭scanner并释放分配给它的资源Resultnext()

获取下一行的值