https://github.com/adaltas/node-hbase
Asynchronous HBase client for NodeJs using REST
https://github.com/adaltas/node-hbase
bigdata driver hbase nodejs rest
Last synced: 6 months ago
JSON representation
Asynchronous HBase client for NodeJs using REST
- Host: GitHub
- URL: https://github.com/adaltas/node-hbase
- Owner: adaltas
- License: mit
- Created: 2010-10-02T00:24:42.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2021-09-13T08:28:09.000Z (over 3 years ago)
- Last Synced: 2024-04-20T14:28:36.660Z (about 1 year ago)
- Topics: bigdata, driver, hbase, nodejs, rest
- Language: CoffeeScript
- Homepage: https://hbase.js.org
- Size: 368 KB
- Stars: 242
- Watchers: 29
- Forks: 101
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hbase - node-hbase - An HBase client for Node.js, providing a simple API for HBase interactions. (Libraries and Clients)
- awesome-hbase - node-hbase - An HBase client for Node.js, providing a simple API for HBase interactions. (Libraries and Clients)
README
[](http://travis-ci.org/adaltas/node-hbase)
[Node.js HBase](https://hbase.js.org) is a Node.JS client for the [Apache HBase](https://hbase.apache.org/)
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
## About HBase
Apache HBase is part of the Hadoop ecosystem from the Apache Software Foundation. It
is a column oriented database (think NoSql) that really scale and is modelled
after Google papers and its BigTable database.
## Installing
From your project directoy, via [npm](http://github.com/isaacs/npm):
```bash
npm install hbase
# Or without the krb5 optional dependency
npm install hbase --no-optional
```
## Documentation
* [Index](https://hbase.js.org/learn/quickstart/)
Getting started
* [Client](https://hbase.js.org/api/client/)
Server information and object factory
* [Connection](https://hbase.js.org/api/connection/)
HTTP REST requests
* [Row](https://hbase.js.org/api/row/)
CRUD operation on rows and columns
* [Scanner](https://hbase.js.org/api/scanner/)
Retrieve multiple rows and columns
* [Table](https://hbase.js.org/api/table/)
Create, modify and delete HBase tables
## 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();
```
## 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);
});
```
It can be quite a pain to figure out what options can be sent
with a scanner request. You will find a lot of examples inside the
[Scanner test][scanner] and also look at the [examples][mt_samples] published by
[Marc Trudel][mt_home].
## More documentation
* [Developer Guide](https://hbase.js.org/learn/developer/)
* [Contributor Guide](https://hbase.js.org/learn/contribute/)
## Related projects
* [Official Apache HBase project](http://hbase.apache.org)
* [REST server bundled with HBase (Stargate)](https://wiki.apache.org/hadoop/Hbase/Stargate)
## Contributors
* David Worms:
* Michael Kurze:
* Michal Taborsky:
* Pierre Sauvage:
This package is developed by [Adaltas](http://www.adaltas.com).
[ryba]: https://github.com/ryba-io/ryba
[scanner]: https://github.com/adaltas/node-hbase/blob/master/test/scanner.coffee
[mt_samples]: https://gist.github.com/3979381
[mt_home]: https://github.com/stelcheck
[krb5]: https://github.com/adaltas/node-krb5