Table Store SDK には、CreateTable、ListTable、DeleteTable、UpdateTable、DescribeTable というテーブルを操作するための API が用意されています。
CreateTable
与えられたテーブル構造情報に基づいてテーブルを作成します。
Table Store でテーブルを作成する場合、テーブルのプライマリキーを指定する必要があります。 プライマリキーには 1 つから 4 つのプライマリキー列があります。 各プライマリキー列には名前と型があります。
API
/**
* 与えられたテーブル構造情報に基づいてテーブルを作成します。
*/
createTable(params, callback)
注 テーブルが Table Store に作成された後、テーブルのロードに数秒かかります。 この間は何の操作もしないでください。
例
2つのプライマリキー列と (0,0) の予約済み読み書きスループットを持つテーブルを作成します。
var client = require('./client');
var params = {
tableMeta: {
tableName: 'sampleTable',
primaryKey: [
{
name: 'gid',
type: 'INTEGER'
},
{
name: 'uid',
type: 'INTEGER'
}
]
},
reservedThroughput: {
capacityUnit: {
read: 0,
write: 0
}
},
tableOptions: {
timeToLive: -1, // 秒単位のデータ有効期限です。 -1 はデータが期限切れにならないことを示します。 有効期限を 1 年に設定するには、365 * 24 * 3600 を使用します。
maxVersions: 1 // 保存するバージョンの最大数です。 1 に設定されている場合、各列には最新バージョンのみが保存されます。
}
};
client.createTable(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
注 完全なサンプルコードは、『createTable@GitHub』をご参照ください。
ListTable
現在のインスタンスで作成されたすべてのテーブルの名前を取得するために使用されます。
API
/**
* 現在のインスタンスの下にあるすべてのテーブルの名前を取得します。
*/
listTable(params, callback)
例
インスタンスの下にあるすべてのテーブルの名前を取得します。
var client = require('./client');
client.listTable({}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
注 完全なサンプルコードは、『listTable@GitHub』 をご参照ください。
UpdateTable
指定されたテーブルの maxVersions と予約済み読み書きスループット値を更新します。
API
/**
* 指定されたテーブルの予約された読み取りまたは書き込みのスループット値を更新します。
*/
updateTable(params, callback)
例
Set maxVersions of a table to 5.
var client = require('./client');
var params = {
tableName: 'sampleTable',
tableOptions: {
maxVersions: 5,
}
};
client.updateTable(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
注 完全なサンプルコードは、『updateTable@GitHub』をご参照ください。
DescribeTable
指定されたテーブルの構造情報と予約済み読み書きスループット値を照会します。
API
/**
* 指定されたテーブルの構造情報と予約済み読み書きスループット値を照会します。
*/
describeTable(params, callback)
例
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);
});
注 完全なサンプルコードは、『describeTable@GitHub』をご参照ください。
DeleteTable
インスタンス下の指定されたテーブルを削除します。
API
/**
* インスタンス下の指定されたテーブルを削除します。
*/
deleteTable(params, callback)
例
テーブルを削除します。
var client = require('./client');
var params = {
tableName: 'sampleTable'
};
client.deleteTable(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
注 完全なサンプルコードは、『deleteTable@GitHub』をご参照ください。