Table Store Node.js SDK 建立資料表 - Tablestore

本文介紹如何通過Node.js SDK建立Table Store的資料表。

注意事項

建立資料表後，請等待資料表載入完成後再進行資料操作，否則資料操作會失敗，這個過程通常需要幾秒鐘。

前提條件

方法說明

 createTable: function createTable(params, callback)

params參數說明

tableMeta（必選）object：表結構資訊，包含以下參數。

名稱	類型	說明
tableName（必選）	string	資料表名稱。
primaryKey（必選）	Array	主鍵資訊。可以設定1~4個主鍵列，預設按升序進行排序，第一個主鍵列將作為分區鍵。主鍵資料類型包含STRING、INTEGER和BINARY，非分區鍵中整型的主鍵列可以設定主鍵列自增。
definedColumn（可選）	Array	預定義列資訊。預定義列是預先定義的屬性列，可以用於建立二級索引和多元索引。預定義列資料類型包含STRING、INTEGER、DOUBLE和BOOLEAN。

tableOptions（必選）object：表配置資訊，包含以下參數。

名稱	類型	說明
timeToLive（必選）	number	資料生命週期，單位為秒。設定為-1時表示資料永不到期，否則取值最低為86400（1天），超出生命週期的資料將會被自動清除。如果要使用多元索引或二級索引功能，必須將資料生命週期設定為-1，或者將allowUpdate參數設定為false。
maxVersions（必選）	number	最大版本數。如果要使用多元索引或二級索引，最大版本數必須設定為1。
maxTimeDeviation（可選）	number	有效版本偏差，單位為秒，預設值為86400（1天）。寫入資料的時間戳記與系統目前時間的差值必須在有效版本偏差範圍內，否則寫入資料將會失敗。屬性列資料的有效版本範圍為`[max(資料寫入時間-有效版本偏差, 資料寫入時間-資料生命週期), 資料寫入時間+有效版本偏差)`。
allowUpdate（可選）	boolean	是否允許更新，預設值為true。設定為false時，無法通過`updateRow()`方法更新資料。

indexMetas（可選）Array：二級索引列表，每個索引包含以下參數。

名稱	類型	說明
name（必選）	string	索引名稱。
primaryKey（必選）	Array	索引的主鍵列。可以由資料表的主鍵列和預定義列組成。使用本地二級索引時，索引第一個主鍵列必須是資料表的第一個主鍵列。
definedColumn（可選）	Array	索引的預定義列。由資料表的預定義列組成。
indexType（可選）	number	索引類型，取值範圍： IT_GLOBAL_INDEX（預設值）：全域二級索引。 IT_LOCAL_INDEX：本地二級索引。
indexUpdateMode（可選）	number	索引更新模式，取值範圍： IUM_ASYNC_INDEX（預設值）：非同步更新。全域二級索引的更新模式必須設定為非同步更新。 IUM_SYNC_INDEX：同步更新。本地二級索引的更新模式必須設定為同步更新。

streamSpecification（可選）object：Stream配置資訊，包含以下參數。

名稱

類型

說明

enableStream（可選）

boolean

是否開啟Stream，預設值為false。

expirationTime（可選）

number

Stream到期時間，表示增量日誌到期時間長度。單位為小時，最大值為168（7天）。

enableStream設定為true時，必須設定expirationTime。

reservedThroughput（必選）object：預留讀寫輸送量，單位為CU。僅CU模式的高效能型執行個體可以設定為非零值且有效。

範例程式碼

建立資料表

以下範例程式碼建立了一張test_table表，該表包含1個 String類型的主鍵。

var params = {
  // 資料表的結構資訊
  tableMeta: {
    tableName: 'test_table',
    // 建立資料表至少需要添加一個主鍵
    primaryKey: [
      {
        name: 'id',
        type: 'STRING'
      }
    ],
    // （可選）添加預定義列
    definedColumn: [
      {
        name: 'name',
        type: TableStore.DefinedColumnType.DCT_STRING
      }
    ]
  },
  // 資料表的配置資訊
  tableOptions: {
    // 建立資料表時必須指定資料生命週期，-1表示資料永不到期
    timeToLive: -1,
    // 建立資料表時必須指定最大版本數
    maxVersions: 1,
    // （可選）設定有效版本偏差
    maxTimeDeviation: 86400,
    // （可選）設定是否允許更新
    allowUpdate: true
  },
  // 建立資料表時必須設定預留讀寫輸送量（僅CU模式高效能執行個體支援設定資料表的預留讀寫輸送量為非零值）
  reservedThroughput: {
    capacityUnit: {
      read: 0,
      write: 0
    }
  },
  // （可選）設定Stream資訊
  streamSpecification: {
    enableStream: true,
    expirationTime: 168
  }
};

client.createTable(params, function (err, data) {
  if (err) {
    console.error('error:', err);
    return;
  }
  console.log('success:', data);
});

建立資料表時配置二級索引

以下範例程式碼建立資料表並配置二級索引。

var params = {
    // 資料表結構資訊
    tableMeta: {
        tableName: 'test_table',
        // 主鍵
        primaryKey: [
            {
                name: 'id',
                type: 'STRING'
            }
        ],
        // 預定義列
        definedColumn: [
            {
                name: 'name',
                type: TableStore.DefinedColumnType.DCT_STRING
            }
        ]
    },
    // 資料表配置資訊
    tableOptions: {
        // 資料生命週期
        timeToLive: -1,
        // 最大版本數
        maxVersions: 1
    },
    // 預留讀寫輸送量（僅CU模式高效能執行個體支援設定資料表的預留讀寫輸送量為非零值）
    reservedThroughput: {
        capacityUnit: {
            read: 0,
            write: 0
        }
    },
    // 二級索引資訊
    indexMetas: [
        {
            name: 'test_table_index',
            // 索引主鍵
            primaryKey: ['id'],
            // 索引預定義列
            definedColumn: ['name'],
            //索引類型
            indexType: TableStore.IndexType.IT_LOCAL_INDEX,
            //索引更新模式
            indexUpdateMode: TableStore.IndexUpdateMode.IUM_SYNC_INDEX
        }
    ]
};

client.createTable(params, function (err, data) {
    if (err) {
        console.error('error:', err);
        return;
    }
    console.log('success:', data);
});

Tablestore：建立資料表