Table Store Node.js SDK 更新表配置 - Tablestore

本文介紹如何通過 Node.js SDK 更新表的配置資訊。

前提條件

方法說明

updateTable: function describeTable(params, callback)

params參數說明

tableName（必選）string：資料表名稱。

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

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

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

名稱

類型

說明

enableStream（可選）

boolean

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

expirationTime（可選）

number

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

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

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

說明

調用 updateTable() 方法時，必須設定tableOptions。
設定 tableOptions 時，必須設定timeToLive、maxVersions、maxTimeDeviation、allowUpdate中的至少一項。

範例程式碼

以下範例程式碼用於修改test_table表的配置資訊。

var params = {
    tableName: 'test_table',
    tableOptions: {
        // 設定資料生命週期，單位為秒
        timeToLive: 86400,
        // 設定最大版本數
        maxVersions: 3,
        // 設定有效版本偏差，單位為秒
        maxTimeDeviation: 86400,
        // 設定是否允許更新
        allowUpdate: false
    },
    // 設定預留讀為0CU，預留寫為0CU（僅CU模式高效能執行個體支援設定資料表的預留讀寫輸送量為非零值）
    reservedThroughput: {
        capacityUnit: {
            read: 0,
            write: 0
        }
    },
    // 開啟Stream資訊，並設定Stream到期時間為7天
    streamSpecification: {
        enableStream: true,
        expirationTime: 168
    }
};

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