DescribeTable オペレーションを呼び出すことで、スキーマ情報、予約済み読み取りスループット、予約済み書き込みスループットなど、テーブルの記述をクエリできます。
前提条件
OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。
データテーブルが作成されていること。詳細については、データテーブルの作成を参照してください。
API オペレーション
/**
* 指定されたテーブルのスキーマ情報、予約済み読み取りスループット、および予約済み書き込みスループットをクエリします。
*/
describeTable(params, callback)
パラメーター
パラメーター | 説明 |
tableName | テーブルの名前 |
例
次のサンプルコードは、最大バージョン数や有効期限 (TTL) など、テーブルに関する構成情報をクエリする方法の例を示しています。
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 をご覧ください。
API オペレーションを呼び出して、テーブル内のデータを読み書きできます。詳細については、データの基本操作を参照してください。
テーブルを更新して、TTL や最大バージョン数など、テーブルに関する情報を変更できます。詳細については、テーブルの構成の更新を参照してください。
不要になったデータテーブルを削除できます。詳細については、データテーブルの削除を参照してください。