Node.js HBase 客户端技术文档

1. 安装指南

安装方式

从项目目录中，使用 npm 进行安装：

npm install hbase

如果不希望安装 krb5 依赖项，可以使用以下命令：

npm install hbase --no-optional

2. 项目使用说明

本项目是一个 Node.js 客户端，用于与 Apache HBase 数据库进行交互。它使用 Rest API（Stargate）与 HBase 进行通信。目前，所有 API 已经实现，数据交换格式为 JSON（但可能会支持 protocol buffer）。

Apache HBase 是 Hadoop 生态系统的一部分，它将自己描述为优化随机、实时读写大数据的 Hadoop 数据库。它是一个开源的、分布式的、版本化的、基于列的存储，模仿了 Google 的 Bigtable。

客户端特性包括：

• 遵循 Apache HBase 命名约定的直观 API
• 文档和测试
• REST API 的完整实现
• 透明地编码/解码值
• 扫描器和过滤器支持，实现 stream.Readable API
• Kerberos 支持

3. 项目API使用文档

以下是一些基本的使用示例：

创建表和列族

const hbase = require('hbase');
const client = hbase({ host: '127.0.0.1', port: 8080 });

client
  .table('my_table')
  .create('my_column_family', function(err, success) {
    // 处理错误或成功回调
  });

插入和读取记录

client
  .table('my_table')
  .row('my_row')
  .put('my_column_family:my_column', 'my value', function(err, success) {
    // 插入后处理错误或成功回调

    client
      .table('my_table')
      .row('my_row')
      .get('my_column_family', function(err, [cell]) {
        // 读取后处理错误，验证结果
      });
  });

使用 Kerberos/SPNEGO

hbase({
  host: '127.0.0.1',
  port: 8080,
  "krb5": {
    "principal": "{username}@{REALM}",
    "keytab": "{path/to/keytab}",
    "service_principal": "HTTP@{fqdn}"
  }
})
.version();

或者使用密码：

hbase({
  host: '127.0.0.1',
  port: 8080,
  "krb5": {
    "principal": "{username}@{REALM}",
    "password": "{password}",
    "service_principal": "HTTP@{fqdn}"
  }
})
.version();

扫描器和过滤器

client
  .table('node_table')
  .scan({
    startRow: 'my_row',
    maxVersions: 1
  }, function(err, rows) {
    // 处理错误或结果
  });

或者：

const rows = [];
const 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);
});

4. 项目安装方式

请参考“安装指南”部分中的说明进行安装。

npm install hbase
# 或者
npm install hbase --no-optional

以上是 Node.js HBase 客户端的基本使用和技术文档概述。希望这些信息能帮助您更好地了解和使用该项目。