Tablestore:ソートとページング

利用シーン

インデックス事前ソート

デフォルトでは、多次元インデックス内のデータは IndexSort パラメーターで指定された事前ソート設定に基づいてソートされます。多次元インデックスを使用してデータをクエリする際、一致したデータが返されるデフォルトの順序は、IndexSort パラメーターで指定された事前ソート設定によって決まります。

検索インデックスを作成する際、IndexSort パラメーターを設定して事前ソート設定を指定できます。事前ソート設定を指定しない場合、検索インデックス内のデータはプライマリキーの値でソートされます。

ソート方法の指定

ソートを行うには、ソート対象のフィールドに対して enableSortAndAgg を true に設定する必要があります。

各クエリごとにソート方法を指定できます。多次元インデックスベースのクエリでは、以下のソート方法がサポートされています。また、異なる優先度に基づいて複数のソート方法を指定することもできます。

ScoreSort

ScoreSort を使用して、BM25 関連スコアに基づき昇順または降順で結果をランク付けします。

sort: {
    sorters: [
        {
            scoreSort: {
                order: TableStore.SortOrder.SORT_ORDER_ASC
            }
        }
    ]
}

PrimaryKeySort

PrimaryKeySort を使用して、プライマリキー値に基づいてクエリ結果をソートできます。

PrimaryKeySort を使用して、プライマリキー値で結果を並べ替えます。

sort: {
    sorters: [
        {
            primaryKeySort: {
                order: TableStore.SortOrder.SORT_ORDER_DESC // 降順でソートします。
                //order: TableStore.SortOrder.SORT_ORDER_ASC // 昇順でソートします。
            }
        }
    ]
}

FieldSort

FieldSort を使用して、1 つ以上のカラム値に基づいて結果をソートします。

sort: {
    sorters: [
        {
            fieldSort: {
                fieldName: "Col_Keyword",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        }
    ]
}

sort: {
    sorters: [
        {
            fieldSort: {
                fieldName: "Col_Keyword",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        },
        {
            fieldSort: {
                fieldName: "Col_Long",
                order: TableStore.SortOrder.SORT_ORDER_DESC
            }
        }
    ]
}

GeoDistanceSort

GeoDistanceSort を使用して、地理的位置に基づいてクエリ結果をソートできます。

GeoDistanceSort を使用して、中心となる地理的ポイントからの距離に基づき結果をランク付けします。

sort: {
    sorters: [
        {
            geoDistanceSort: {
                fieldName: "Col_Geo_Point",
                points: ["0,0"],// 中心点の座標ペアを指定します。
                order: TableStore.SortOrder.SORT_ORDER_ASC // 距離の昇順で結果を返します。
            }
        }
    ]
}

完全なサンプルについては、GitHub の「Search」をご参照ください。

ページング方法の指定

応答内の行をページングするために、limit および offset パラメーターを設定するか、トークンを使用できます。

limit および offset パラメーターの設定

limit および offset パラメーターの値を指定しない場合、デフォルト値が使用されます。limit パラメーターのデフォルト値は 10 です。offset パラメーターのデフォルト値は 0 です。

offset および limit を使用して、任意のページに直接ジャンプします。この方法は最大 100,000 行の結果セットをサポートします。

/**
 * offset を 90、limit を 10 に設定して、90～99 行目を取得します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 90,
        limit: 10,
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true // 一致する行の総数を返します。デフォルト: false。
    },
    columnToGet: {
        // RETURN_ALL: すべてのカラムを返します。
        // RETURN_SPECIFIED: 指定されたカラムを返します。
        // RETURN_NONE: プライマリキーカラムのみを返します。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

トークンの使用

深さのあるページングには、ページング深度に制限がないため、トークンの使用を推奨します。

Tablestore がクエリ条件を満たすすべてのデータを読み取れない場合、Tablestore は nextToken を返します。nextToken を使用して後続のデータを継続的に読み取ることができます。

デフォルトでは、トークンを使用する場合、前に戻ることしかできません。ただし、トークンはクエリ中に有効であるため、前のトークンをキャッシュして使用することで次に進むことができます。

トークンベースのページングは、カーソル (NextToken) を使用して結果をページごとに返します。各応答には次のページ用のトークンが含まれます。トークンはクエリの持続時間中に有効であるため、以前のトークンをキャッシュして前のページに戻ることができます。

トークンを使用する場合、ソート方法は前回のリクエストで使用された方法と同じになります。Tablestore はデフォルトで IndexSort パラメーターに基づいてデータをソートするか、指定された方法に基づいてソートします。トークン使用時にはソート方法を指定できません。また、トークン使用時には offset パラメーターを設定できません。データは順番にページごとに返されるため、クエリが遅くなります。

以下の例は、同期モードと非同期モードの両方におけるトークンベースのページングを示しています。どちらも同じ初期 params オブジェクトを使用します。

var params = {
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10,
        token: null, // 次のページを取得するには、前回の応答の nextToken を設定します。
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true
    },
    columnToGet: {
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["pic_tag", "pic_description", "time_stemp", "pos"]
    }
};

/**
 * 同期モード: 次のページを取得する前に各ページを await します。
 */
(async () => {
  try {
    var data = await client.search(params);
    console.log('success:', JSON.stringify(data, null, 2));

    while (data.nextToken && data.nextToken.length) {
      // バイナリトークンを Base64 としてエンコードして保存または転送し、
      // 次のトークンとして渡す前にバイナリに戻します。
      var nextToken = data.nextToken.toString("base64");
      var token = Buffer.from(nextToken, "base64");

      params.searchQuery.token = token;
      data = await client.search(params);
      console.log('token success:', JSON.stringify(data, null, 2));
    }
  } catch (error) {
      console.log(error);
  }
})()

/**
 * 非同期モード: コールバックを使用して次のページを取得します。
 */
client.search(params, function (err, data) {
    console.log('success:', JSON.stringify(data, null, 2));

    if (data.nextToken && data.nextToken.length) {
        // 同期モードと同様にトークンをエンコードおよびデコードします。
        var nextToken = data.nextToken.toString("base64");
        var token = Buffer.from(nextToken, "base64");

        params.searchQuery.token = token;
        client.search(params, function (err, data) {
            console.log('token success:', JSON.stringify(data, null, 2));
        });
    }
});