HBase client using the REST connector
npm install @tg1518/hbase
Node.js HBase is a Node.JS client for the Apache HBase
database. It use the Rest API (Stargate) to communicate with HBase. Currently,
all the API is implemented and the data exchange format is JSON (but protocol
buffer could follow).
Apache HBase is part of the Hadoop ecosystem. It describes itself as the Hadoop
database optimized for random, realtime read/write access to big data. It is an
open-source, distributed, versioned, column-oriented store modeled after Google
Bigtable.
Client features include:
* Intuitive API following Apache HBase naming conventions
* Documentation and tests
* Full Implementation of the REST API
* Transparent encoding/decoding of values
* Scanner and filter support implementing the stream.Readable API
* Kerberos Support
* 新增命名空间支持
bash
npm install @tg1518/hbase
Or without the krb5 optional dependency
npm install @tg1518/hbase --no-optional
`
Documentation
* Index
Getting started
* Client
Server information and object factory
* Connection
HTTP REST requests
* Row
CRUD operation on rows and columns
* Scanner
Retrieve multiple rows and columns
* Table
Create, modify and delete HBase tables
* REST_API
api使用文档
* Stargate Scanner Filter Examples
Stargate 扫描仪过滤器示例
Quick example
The following code initialise a new HBase instance, create a table and a column family,
insert a record and read it.
`javascript
const hbase = require('hbase')
// Instantiate a new client
client = hbase({ host: '127.0.0.1', port: 8080 })
// Create a table
client
.table('my_table' )
.create('my_column_family', function(err, success){
// Insert a record
client
.table('my_table' )
.row('my_row')
.put('my_column_family:my_column', 'my value', function(err, success){
// Read a record
client
.table('my_table' )
.row('my_row')
.get('my_column_family', function(err, [cell]){
// Validate the result
assert(cell.key, 'my_row')
assert(cell.column, 'my_column_family:my_column')
assert(cell.$, 'my value')
})
})
})
`
Or shortly as:
`javascript
// Instantiate a new client
require('hbase')({ host: '127.0.0.1', port: 8080 })
// Create a table
.table('my_table' )
.create('my_column_family', function(err, success){
// Insert a record
this.put('my_column_family:my_column', 'my value', function(err, success){
// Read a record
this.get('my_column_family', function(err, [[cell]]){
// Validate the result
// ...
})
})
})
`
Using Kerberos/SPNEGO
Options accepts a krb5 object. Password and keytab authentication are supported.
Refer to the [krb5] package for additionnal information on how to configure the
krb5 option.
Using a keytab:
`javascript
const hbase = require('hbase');
hbase({
host: '127.0.0.1',
port: 8080,
"krb5": {
"principal": "{username}@{REALM}",
"keytab": "{path/to/keytab}",
"service_principal": "HTTP@{fqdn}"
}
})
.version();
`
Using a password:
`javascript
const hbase = require('hbase');
hbase({
host: '127.0.0.1',
port: 8080,
"krb5": {
"principal": "{username}@{REALM}",
"password": "{password}",
"service_principal": "HTTP@{fqdn}"
}
})
.version();
`
命名空间
`bash
//获取所有命名空间列表
client.spaces((error, version) => {
console.info(version)
})
//移除指定命名空间 [注意：该命名空间下不能存在表,需要先删除表]
client.removeSpace("test",(error, version) => {
console.info(error,version)
})
//创建命名空间
client.createSpace("test",(error, version) => {
console.info(error,version)
})
//获取命令空间信息
client.spaceInfo("test",(error, version) => {
console.info(error,version)
})
//获取指定命令空间下的表列表
client.spaceTable("test",(error, version) => {
console.info(error,version)
})
//添加指定命令空间下的表
client.table("test:testT1").update({
ColumnSchema: [
{
name: 'age'
},
{
name: 'name'
},
{
name: 'id'
}
]
},(error, success) => {
console.info('Table created: ' + (success ? 'yes' : 'no'))
// console.error(error)
})
`
Scanner and Filters
The scanner implement the stream.Readable API. For ease of usage, an optional
callback argument may be provided. For example:
`bash
client
.table('node_table')
.scan({
startRow: 'my_row',
maxVersions: 1
}, function(err, rows){
console.log(err, rows);
});
`
is equivalent to:
`coffee
const rows = [];
scanner = client
.table('node_table')
.scan({
startRow: 'my_row',
maxVersions: 1
});
scanner.on('readable', function(){
while(chunk = scanner.read()){
rows.push(chunk);
}
});
scanner.on('error', function(err){
console.log(err);
});
scanner.on('end', function(){
console.log(rows);
});
``