edit-icon download-icon

テーブルレベルの操作

最終更新日: May 05, 2018

テーブルストアSDKは、CreateTable、ListTable、DeleteTable、UpdateTable、およびDescribeTableの各テーブルを操作するためのAPIを提供します。

テーブルの作成

指定されたテーブル構造情報に基づいてテーブルを作成します。

テーブルストアでテーブルを作成するときは、テーブルの主キーを指定する必要があります。主キーには1〜4個の主キー列があり、各主キー列には名前と型があります。

API

  1. /**
  2. * Create a table based on the given table structure information.
  3. */
  4. createTable(params, callback)

注意: テーブルストアでテーブルを作成した後、テーブルをロードするのに数秒かかります。この間は何も操作しないでください。

2つの主キー列と予約された読み取り/書き込みスループット(0,0)を持つ表を作成します。

  1. var client = require('./client');
  2. var params = {
  3. tableMeta: {
  4. tableName: 'sampleTable',
  5. primaryKey: [
  6. {
  7. name: 'gid',
  8. type: 'INTEGER'
  9. },
  10. {
  11. name: 'uid',
  12. type: 'INTEGER'
  13. }
  14. ]
  15. },
  16. reservedThroughput: {
  17. capacityUnit: {
  18. read: 0,
  19. write: 0
  20. }
  21. },
  22. tableOptions: {
  23. timeToLive: -1,// The data expiration time in seconds; –1 indicates that the data does not expire. To set the expiration time to one year, use 365 x 24 x 3600
  24. maxVersions: 1//The max number of versions to save. If it is set to 1, each column will only save the one latest version
  25. }
  26. };
  27. client.createTable(params, function (err, data) {
  28. if (err) {
  29. console.log('error:', err);
  30. return;
  31. }
  32. console.log('success:', data);
  33. });

注意: 完全なサンプルコードはcreateTable@GitHubで入手してください。

リストテーブル

現在のインスタンスの下にあるすべてのテーブルの名前を取得します。

API

  1. /**
  2. * Obtain the names of all tables under the current instance.
  3. */
  4. listTable(params, callback)

インスタンスの下にあるすべてのテーブルの名前を取得します。

  1. var client = require('./client');
  2. client.listTable({}, function (err, data) {
  3. if (err) {
  4. console.log('error:', err);
  5. return;
  6. }
  7. console.log('success:', data);
  8. });

注意:完全なサンプルコードはlistTable@GitHubで入手してください。

アップデートテーブル

指定したテーブルの予約された読み取りまたは書き込みスループット値を更新します。

API

  1. /**
  2. * Update the reserved read or write throughput value of the specified table.
  3. */
  4. updateTable(params, callback)

表のmaxVersionsを5に設定します。

  1. var client = require('./client');
  2. var params = {
  3. tableName: 'sampleTable',
  4. tableOptions: {
  5. maxVersions: 5,
  6. }
  7. };
  8. client.updateTable(params, function (err, data) {
  9. if (err) {
  10. console.log('error:', err);
  11. return;
  12. }
  13. console.log('success:', data);
  14. });

注意: 完全なサンプルコードは、updateTable@GitHubで入手してください。

テーブルの記述

指定されたテーブルの構造情報と予約済みの読み込み/書き込みスループット値を照会します。

API

  1. /**
  2. * Query the structure information and the reserved read/write throughput value of the specified table.
  3. */
  4. describeTable(params, callback)

  1. var client = require('./client');
  2. var params = {
  3. tableName: 'sampleTable'
  4. };
  5. client.describeTable(params, function (err, data) {
  6. if (err) {
  7. console.log('error:', err);
  8. return;
  9. }
  10. console.log('success:', data);
  11. });

注意:完全なサンプルコードはdescribeTable@GitHubで入手してください。

テーブルの削除

インスタンスの下で指定されたテーブルを削除します。

API

  1. /**
  2. * Delete the specified table under an instance.
  3. */
  4. deleteTable(params, callback)

テーブルを削除します。

  1. var client = require('./client');
  2. var params = {
  3. tableName: 'sampleTable'
  4. };
  5. client.deleteTable(params, function (err, data) {
  6. if (err) {
  7. console.log('error:', err);
  8. return;
  9. }
  10. console.log('success:', data);
  11. });

注意: 完全なサンプルコードは、deleteTable@GitHubで入手してください。