更新表配置

本文介绍如何通过 Node.js SDK 更新表的配置信息。

前提条件

初始化Tablestore Client

方法说明

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);
});