Tablestore:データの読み取り

クエリメソッド

Tablestoreは、データを読み取るためのGetRow、BatchGetRow、およびGetRange操作を提供します。データを読み取る前に、実際のクエリシナリオに基づいて適切なクエリメソッドを選択してください。

前提条件

• OTSClientインスタンスが初期化されています。詳細については、OTSClientインスタンスの初期化を参照してください。

• データテーブルが作成され、データがデータテーブルに書き込まれます。詳細については、データテーブルの作成およびデータの書き込みを参照してください。

単一のデータ行の読み取り

GetRow操作を呼び出して、単一のデータ行を読み取ることができます。GetRow操作を呼び出すと、次のいずれかの結果が返される場合があります。

• 行が存在する場合、行の主キー列と属性列が返されます。

• 行が存在しない場合、行は返されず、エラーも報告されません。

API操作

/*
 * 指定された主キー情報に基づいて単一のデータ行を読み取ります。
 */
getRow(params, callback)

パラメーター

サンプルコード

次のサンプルコードは、データ行を読み取る方法の例を示しています。

var TableStore = require('../index.js');
var Long = TableStore.Long;
var client = require('./client');

var params = {
  tableName: "sampleTable",
  primaryKey: [{ 'gid': Long.fromNumber(20004) }, { 'uid': Long.fromNumber(20004) }],
  maxVersions: 2 // 読み取ることができるデータバージョンの最大数を指定します。値2は、最大2つのバージョンのデータを読み取ることができることを指定します。
};
var condition = new TableStore.CompositeCondition(TableStore.LogicalOperator.AND);
condition.addSubCondition(new TableStore.SingleColumnCondition('name', 'john', TableStore.ComparatorType.EQUAL));
condition.addSubCondition(new TableStore.SingleColumnCondition('addr', 'china', TableStore.ComparatorType.EQUAL));

params.columnFilter = condition;

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

詳細なサンプルコードを表示するには、GetRow@GitHubにアクセスしてください。

一度に複数のデータ行の読み取り

BatchGetRow操作を呼び出して、1つ以上のテーブルから一度に複数のデータ行を読み取ることができます。BatchGetRow操作は、複数のGetRow操作で構成されます。BatchGetRow操作を呼び出す場合、各GetRow操作を構築するプロセスは、GetRow操作を呼び出すときにGetRow操作を構築するプロセスと同じです。

BatchGetRow操作を呼び出すと、各GetRow操作は個別に実行され、Tablestoreは各GetRow操作へのレスポンスを個別に返します。

使用上の注意

• BatchGetRow操作を呼び出して一度に複数の行を読み取ると、一部の行の読み取りに失敗する場合があります。この場合、Tablestoreは例外を返さず、失敗した行に関する情報が含まれているBatchGetRowResponseを返します。したがって、BatchGetRow操作を呼び出すときは、戻り値をチェックして、各行からデータが正常に読み取られたかどうかを確認する必要があります。

• BatchGetRow操作は、すべての行に同じパラメーター設定を使用します。たとえば、ColumnsToGetパラメーターが[colA]に設定されている場合、colA列の値のみがすべての行から読み取られます。

• BatchGetRow操作を呼び出して、一度に最大100行を読み取ることができます。

API操作

/**
 * 1つ以上のテーブルから一度に複数のデータ行を読み取ります。
 */
batchGetRow(params, callback)  

パラメーター

サンプルコード

次のサンプルコードは、一度に複数のテーブルからデータを読み取り、エラーが発生した場合に読み取り操作を再試行する方法の例を示しています。

var client = require('./client');
var TableStore = require('../index.js');
var Long = TableStore.Long;

var params = {
    tables: [{
        tableName: 'sampleTable',
        primaryKey: [
            [{ 'gid': Long.fromNumber(20013) }, { 'uid': Long.fromNumber(20013) }],
            [{ 'gid': Long.fromNumber(20015) }, { 'uid': Long.fromNumber(20015) }]
        ],
        startColumn: "col2",
        endColumn: "col4"
    },
    {
        tableName: 'notExistTable',
        primaryKey: [
            [{ 'gid': Long.fromNumber(10001) }, { 'uid': Long.fromNumber(10001) }]
        ]
    }
    ],
};

var maxRetryTimes = 3;
var retryCount = 0;

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

        var isAllSuccess = true;
        var retryRequest = { tables: [] };
        for (var i = 0; i < data.tables.length; i++) {
            var failedRequest = { tableName: data.tables[i][0].tableName, primaryKey: [] };

            for (var j = 0; j < data.tables[i].length; j++) {
                if (!data.tables[i][j].isOk && null != data.tables[i][j].primaryKey) {
                    isAllSuccess = false;
                    var pks = [];
                    for (var k in data.tables[i][j].primaryKey) {
                        var name = data.tables[i][j].primaryKey[k].name;
                        var value = data.tables[i][j].primaryKey[k].value;
                        var kp = {};
                        kp[name] = value;
                        pks.push(kp);
                    }
                    failedRequest.primaryKey.push(pks);

                } else {
                    // 成功データの取得
                }
            }

            if (failedRequest.primaryKey.length > 0) {
                retryRequest.tables.push(failedRequest);
            }
        }

        if (!isAllSuccess && retryCount++ < maxRetryTimes) {
            batchGetRow(retryRequest);
        }

        console.log('success:', data);
    });
}

batchGetRow(params, maxRetryTimes);                    

詳細なサンプルコードを表示するには、BatchGetRow@GitHubにアクセスしてください。

主キー値が特定の範囲内にあるデータの読み取り

GetRange操作を呼び出して、主キー値が指定された範囲内にあるデータを読み取ることができます。

GetRange操作を使用すると、主キー値が指定された範囲内にあるデータを前方または後方に読み取ることができます。読み取る行数を指定することもできます。範囲が広く、スキャンされた行数またはスキャンされたデータの量が上限を超えると、スキャンは停止し、読み取られた行と次の行の主キーに関する情報が返されます。前回の操作が中断したところからリクエストを開始し、前回の操作によって返された次の行の主キー情報に基づいて残りの行を読み取ることができます。

使用上の注意

GetRange操作は、左端一致の原則に従います。 Tablestoreは、最初の主キー列から最後の主キー列まで順番に値を比較して、主キー値が指定された範囲内にあるデータを読み取ります。たとえば、データテーブルの主キーは、PK1、PK2、およびPK3という主キー列で構成されます。データを読み取るとき、Tablestoreは最初に、行のPK1値が最初の主キー列に指定された範囲内にあるかどうかを判断します。行のPK1値が範囲内にある場合、Tablestoreは、行の他の主キー列の値が各主キー列に指定された範囲内にあるかどうかの判断を停止し、行を返します。行のPK1値が範囲内にない場合、Tablestoreは、PK1と同じ方法で、行の他の主キー列の値が各主キー列に指定された範囲内にあるかどうかを判断し続けます。

次のいずれかの条件が満たされると、GetRange操作が停止してデータが返される場合があります。

• スキャンされたデータ量が4 MBに達する。

• スキャンされた行数が5,000に達する。

• 返される行数が上限に達する。

• 予約済みの読み取りスループットがすべて消費されているため、読み取りスループットが次のデータ行を読み取るのに不十分である。

API操作

/**
 * 主キー値が指定された範囲内にあるデータを読み取ります。
 */
getRange(params, callback)                   

パラメーター

サンプルコード

次のサンプルコードは、主キー値が指定された範囲内にあるデータを読み取る方法の例を示しています。

var Long = TableStore.Long;
var client = require('./client');

var params = {
  tableName: "sampleTable",
  direction: TableStore.Direction.FORWARD,
  inclusiveStartPrimaryKey: [{ "gid": TableStore.INF_MIN }, { "uid": TableStore.INF_MIN }],
  exclusiveEndPrimaryKey: [{ "gid": TableStore.INF_MAX }, { "uid": TableStore.INF_MAX }],
  limit: 50
};

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

  // data.next_start_primary_keyパラメーターの値が空でない場合、システムはデータの読み取りを続けます。
  if (data.next_start_primary_key) {

  }

  console.log('success:', data);
});                  

詳細なサンプルコードを表示するには、GetRange@GitHubにアクセスしてください。