查询表信息

前提条件

初始化Tablestore Client

方法说明

describeTable: function describeTable(params, callback)

示例代码

以下示例代码用于查询test_table表的详细信息。

var params = {
    tableName: 'test_table'
};

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

    // 获取数据表结构信息
    var tableMeta = data.tableMeta;
    console.log('* 数据表名称:', tableMeta.tableName);
    console.log('* 主键信息 (主键类型 1:INTEGER,2:STRING,3:BINARY)');
    tableMeta.primaryKey.forEach(function (primaryKey) {
        console.log(primaryKey.name, ':', primaryKey.type);
    });
    console.log("* 预定义列信息 (预定义列类型 1:INTEGER,2:DOUBLE,3:BOOLEAN,4:STRING)");
    tableMeta.definedColumn.forEach(function (definedColumn) {
        console.log(definedColumn.name, ':', definedColumn.type);
    });

    // 获取数据表配置信息
    var tableOptions = data.tableOptions;
    console.log("* 数据表配置信息");
    console.log("最大版本数:", tableOptions.maxVersions);
    console.log("数据生命周期:", tableOptions.timeToLive);
    console.log("有效版本偏差:", tableOptions.deviationCellVersionInSec.toNumber());
    console.log("是否允许更新:", tableOptions.allowUpdate);

    // 获取数据表Stream信息
    var streamDetails = data.streamDetails
    console.log("* 是否开启Steam:", streamDetails.enableStream);
    if (streamDetails.enableStream) {
        console.log("Stream过期时间:", streamDetails.expirationTime);
    }

    // 获取数据表预留读写吞吐量
    var reservedThroughputDetails = data.reservedThroughputDetails
    console.log("* 预留读写吞吐量");
    console.log("预留读吞吐量:", reservedThroughputDetails.capacityUnit.read);
    console.log("预留写吞吐量:", reservedThroughputDetails.capacityUnit.write);

    // 获取二级索引信息
    data.indexMetas.forEach(function (indexMeta) {
        console.log("* 二级索引名称:", indexMeta.name);
        console.log("主键列表:", indexMeta.primaryKey);
        console.log("预定义列列表:", indexMeta.definedColumn);
        console.log("二级索引类型:", indexMeta.indexType, "(0:IT_GLOBAL_INDEX,1:IT_LOCAL_INDEX)");
        console.log("二级索引更新模式:", indexMeta.indexUpdateMode, "(0:IUM_ASYNC_INDEX,1:IUM_SYNC_INDEX)");
    });
});