検索インデックスを使用してデータをクエリする際、事前定義されたソート順を適用するか、クエリ時にソート順を指定できます。大規模な結果セットを扱うには、オフセットベースのページングでは limit/offset を、カーソルベースのページングではトークンを使用します。
シナリオ
カテゴリ | 方法 | 機能 | シナリオ |
ソート | 検索インデックス作成時にソート方法を事前定義 | デフォルトでは、インデックス作成時に設定された IndexSort パラメータの順序で結果が返されます。 | |
データクエリ時にソート方法を指定 | BM25 関連性スコアで結果をソートします。全文検索に最適です。 | ||
プライマリキー値で結果をソートします。一意の行識別子で結果を順序付ける必要がある場合に便利です。 | |||
売上高やページビューなど、1 つ以上のカラム値で結果をソートします。E コマース、ソーシャルネットワーキング、メディアアセット管理で一般的に使用されます。 | |||
中心点からの距離で結果をソートします。マッピングやロジスティクスで一般的に使用されます (例:近隣のレストランを距離順にソート)。 | |||
ページング | データクエリ時にページング方法を指定 | 取得する行の総数が 100,000 行以下の場合、任意のページにジャンプできます。 | |
カーソルを使用して結果を順次ページングします。前方にのみページ移動できます。トークンはクエリの期間中有効であるため、以前のトークンをキャッシュして前のページに戻ることができます。 |
インデックスの事前ソート
デフォルトでは、Tablestore はインデックスの事前ソート (IndexSort) と呼ばれる事前定義されたソート順序に基づいて、検索インデックス内のデータをソートします。データをクエリする際、IndexSort が、返される結果のデフォルトの順序を決定します。
検索インデックスを作成するときに、IndexSort をカスタマイズできます。この設定を指定しない場合、インデックスはデフォルトでプライマリキーソートになります。
インデックスの事前ソートは、
PrimaryKeySort(プライマリキーソート) とFieldSort(フィールドソート) のみをサポートします。ネスト型フィールドを含む検索インデックスには、インデックスの事前ソートを使用できません。
検索インデックスを作成した後、動的スキーマ変更機能を使用して
IndexSort設定を変更できます。
ソート方法の指定
ソートするには、ソートするフィールドで enableSortAndAgg を true に設定する必要があります。
クエリごとにソート方法を指定できます。検索インデックスは、次の 4 種類のソーターをサポートしています。複数のソーターを使用して、一連の基準に基づいて結果をソートすることもできます。
ScoreSort
BM25 アルゴリズムを使用して計算される関連度スコアによってクエリ結果をソートします。この方法は、全文検索など、関連度に基づくシナリオに適しています。
関連度スコアでソートする場合は、
ScoreSortを明示的に指定する必要があります。指定しない場合、Tablestore はインデックスのIndexSort設定に従って結果をソートします。ScoreSortを使用する場合、FuzzyKeyword 型のフィールドはソートに含まれず、weightパラメータはこれらのフィールドに影響を与えません。
ScoreSort を使用して、BM25 関連性スコアで結果を昇順または降順にソートします。
sort: {
sorters: [
{
scoreSort: {
order: TableStore.SortOrder.SORT_ORDER_ASC
}
}
]
}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
geo フィールドは GeoPoint 型です。このフィールドの値とポイント "0,0" との距離で結果をソートします。
GeoDistanceSort を使用して、中心の地理的ポイントからの距離で結果をソートします。
sort: {
sorters: [
{
geoDistanceSort: {
fieldName: "Col_Geo_Point",
points: ["0,0"],// 中心点の座標を指定します。
order: TableStore.SortOrder.SORT_ORDER_ASC // 距離の昇順で結果を返します。
}
}
]
}完全な例については、GitHub の「Search」をご参照ください。
ページング方法の指定
クエリ結果のページングには、limit と offset パラメータまたはトークンを使用できます。
limit および offset パラメータの設定
オフセットベースのページング
取得する行の総数が 100,000 未満の場合に、オフセットベースのページングを使用できます。limit と offset の合計は 100,000 以下である必要があり、limit の最大値は 100 です。
limit のしきい値を引き上げるには、「Search API の limit を 1,000 に引き上げる方法」をご参照ください。
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));
});トークンの使用
深度の制限がないため、ディープページングにはトークンベースのページングを推奨します。
レスポンスにすべての一致するデータが含まれていない場合、サーバーは nextToken を返します。
デフォルトでは、トークンベースのページングでは前方へのページングのみ可能です。ただし、トークンはクエリプロセス全体で有効なままであるため、前のトークンをキャッシュして逆方向にもページングできます。
トークンベースのページングでは、カーソル (NextToken) を使用して結果をページごとに返します。各レスポンスには、次のページのトークンが含まれています。トークンはクエリの期間中有効であるため、以前のトークンをキャッシュしておくと、前のページに戻ることができます。
NextToken を永続化するか、フロントエンドページに渡すには、Base64 文字列としてエンコードします。トークンは文字列ではなくバイナリデータ (バイトストリーム) であり、string(NextToken) を使用するとデータが失われます。変換には Buffer を使用します。
エンコード:
data.nextToken.toString("base64")デコード:
Buffer.from(base64String, "base64")
トークンを使用してページングする場合、ソート順序は、デフォルトの IndexSort を使用するかカスタムソートを使用するかにかかわらず、前のリクエストと同じになります。したがって、トークンが使用されている場合、Sort パラメータを設定することはできません。また、データを順次読み取ることしかできないため、offset を設定することもできません。
ネスト型フィールドを含む検索インデックスは、インデックスの事前ソートをサポートしていません。このようなインデックスの結果をページングする必要がある場合は、クエリでソート順序を指定する必要があります。ソート順序を指定しない場合、利用可能なデータがさらにあっても、サーバーは nextToken を返しません。
以下の例では、同期モードと非同期モードの両方におけるトークンベースのページングを示します。どちらのモードでも、同じ初期 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"]
}
};
/**
* 同期モード: 次のページを取得する前に各ページを待機します。
*/
(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));
});
}
});