Node.js SDK

Table Store Node.js SDK 支援寬表模型操作。

快速接入

完成環境準備、SDK 安裝和用戶端初始化，快速接入Table Store Node.js SDK。

準備環境

已安裝 Node.js 4.0 及以上版本。
重要
由於相容性問題，不要使用 Node.js 12.0~12.14 版本。
已安裝 Node.js 開發工具。

安裝 SDK

執行以下 npm 命令安裝Table Store Node.js SDK。

npm install tablestore

Node.js SDK 提供樣本程式，涵蓋寬表模型的常見操作。通過以下方式擷取樣本程式。

下載Node.js SDK並解壓後查看 sample 檔案夾中的樣本程式。
訪問GitHub專案。

配置訪問憑證

為阿里雲帳號或RAM使用者建立AccessKey，並按如下方式將AccessKey配置到環境變數中。通過環境變數配置AccessKey可避免在代碼中寫入程式碼敏感資訊，提升安全性。

配置完成後請重啟或重新整理編譯運行環境，包括IDE、命令列介面、其它傳統型應用程式及後台服務，確保最新的系統內容變數成功載入。更多訪問憑證類型，請參見配置訪問憑證。

Linux

在命令列介面執行以下命令來將環境變數設定追加到 ~/.bashrc 檔案中。

echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

執行以下命令使變更生效。
```
source ~/.bashrc
```

執行以下命令檢查環境變數是否生效。

echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET

macOS

在終端中執行以下命令，查看預設 Shell 類型。
```
echo $SHELL
```

根據預設 Shell 類型進行操作。

Zsh

執行以下命令來將環境變數設定追加到 ~/.zshrc 檔案中。

echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc

執行以下命令使變更生效。
```
source ~/.zshrc
```

執行以下命令檢查環境變數是否生效。

echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET

Bash

執行以下命令來將環境變數設定追加到 ~/.bash_profile 檔案中。

echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile

執行以下命令使變更生效。
```
source ~/.bash_profile
```

執行以下命令檢查環境變數是否生效。

echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET

Windows

CMD

在CMD中運行以下命令設定環境變數。

setx TABLESTORE_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
setx TABLESTORE_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

重啟CMD後，運行以下命令，檢查環境變數是否生效。
```
echo %TABLESTORE_ACCESS_KEY_ID%
echo %TABLESTORE_ACCESS_KEY_SECRET%
```

PowerShell

在PowerShell中運行以下命令。

[Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

運行以下命令，檢查環境變數是否生效。

[Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

初始化用戶端

初始化用戶端後，通過列舉執行個體下的資料表驗證串連是否正常。

重要

新建立的執行個體預設未啟用公網訪問功能。如需通過公網訪問執行個體中的資源，在執行個體的網絡管理中開啟公網訪問。

var TableStore = require('tablestore');

// yourInstanceName 填寫您的執行個體名稱
var instancename = 'yourInstanceName';
// yourEndpoint 填寫您的執行個體訪問地址
var endpoint = 'yourEndpoint';
// 擷取環境變數裡的 AccessKey ID 和 AccessKey Secret
var accessKeyId = process.env.TABLESTORE_ACCESS_KEY_ID;
var secretAccessKey = process.env.TABLESTORE_ACCESS_KEY_SECRET;

// 初始化 Tablestore Client
var client = new TableStore.Client({
  accessKeyId: accessKeyId,
  secretAccessKey: secretAccessKey,
  endpoint: endpoint,
  instancename: instancename
});

// 列出執行個體中的資料表列表並列印到控制台
client.listTable({}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', data);
});

資料類型

Table Store資料類型與 Node.js SDK 資料類型的對應關係如下。

Table Store資料類型	Node.js SDK 資料類型	說明
String	string	JavaScript 基本類型。
Integer	int64	Node.js SDK 封裝類型。JavaScript 沒有原生 64 位元整數，SDK 通過 `TableStore.Long` 提供 `int64` 支援。
Double	number	JavaScript 基本類型。
Boolean	boolean	JavaScript 基本類型。
Binary	Buffer	Node.js `Buffer` 對象，用於處理位元據。

TableStore.Long 用於在 int64 與 JavaScript 原生的 number 或 string 之間互相轉換：

// 從 number 或 string 構造 int64
const valueA = TableStore.Long.fromNumber(1000);
const valueB = TableStore.Long.fromString('2000');

// 將 int64 轉換回 JavaScript 原生類型
const numA = valueA.toNumber();   // 1000
const strA = valueA.toString();   // '1000'

const numB = valueB.toNumber();   // 2000
const strB = valueB.toString();   // '2000'

Node.js SDK

快速接入

準備環境

安裝 SDK

配置訪問憑證

Linux

macOS

Zsh

Bash

Windows

CMD

PowerShell

初始化用戶端

資料類型

常見問題

相關文檔