使用DescribeTable接口可以查询指定表的结构、预留读/写吞吐量详情等信息。
前提条件
已初始化Client。具体操作,请参见初始化OTSClient。
已创建数据表。具体操作,请参见创建数据表。
接口
/**
* 查询指定表的结构信息和预留读/写吞吐量设置信息。
*/
describeTable(params, callback)
参数
参数 | 说明 |
tableName | 表名。 |
示例
以下示例用于获取表的最大版本数和数据生命周期等配置信息。
var client = require('./client');
var params = {
tableName: 'sampleTable'
};
client.describeTable(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data, 'maxVersions:', data.tableOptions.maxVersions, 'timeToLive:', data.tableOptions.timeToLive);
});
相关文档
关于API说明的更多信息,请参见DescribeTable。详细代码请参见DescribeTable@GitHub。
如果要读写表中数据,您可以通过调用读写数据接口实现。具体操作,请参见基础数据操作。
如果要修改表的数据生命周期、最大版本数等信息,您可以通过更新表实现。具体操作,请参见更新表配置。
如果不再使用数据表,您可以删除数据表。具体操作,请参见删除数据表。