Tablestore:Sort and paginate results

クエリリクエスト

request のタイプは SearchRequest です。次の表にそのパラメーターを示します。

クエリ構成

request.searchQuery のタイプは SearchQuery です。次の表では、ソートとページネーションに関連するパラメーターのみを説明します。

ソート構成

request.searchQuery.sort のタイプは Sort です。次の表にそのパラメーターを示します。

関連性スコアによるソート

ScoreSort は、BM25 アルゴリズムを使用して計算された関連性スコアで行をソートします。次の表にそのパラメーターを示します。

関連性スコアでソートするには、明示的に ScoreSort を構成します。そうしない場合、インデックスソートが使用されます。

プライマリキーによるソート

PrimaryKeySort は、プライマリキーで行をソートします。次の表にそのパラメーターを示します。

フィールドによるソート

FieldSort は、フィールド値で行をソートします。次の表にそのパラメーターを示します。

Nested フィルター

FieldSort.nestedFilter のタイプは NestedFilter です。次の表にそのパラメーターを示します。

地理的距離によるソート

GeoDistanceSort は、地理的なポイントフィールドとターゲットポイント間の距離で行をソートします。次の表にそのパラメーターを示します。

返される列

request.columnsToGet のタイプは SearchRequest.ColumnsToGet です。返される列がデータテーブルから読み取られる必要があるかどうかは、limit の最大値に影響します。

インデックスソートの構成

次の例では、多次元インデックスの作成時に score フィールドをインデックスソートフィールドとして構成します。クエリにソートが構成されていない場合、結果は score の昇順で返されます。

FieldSchema score = new FieldSchema("score", FieldType.LONG)
        .setEnableSortAndAgg(true);

IndexSchema indexSchema = new IndexSchema();
indexSchema.setFieldSchemas(Collections.singletonList(score));
indexSchema.setIndexSort(new Sort(
        Collections.<Sort.Sorter>singletonList(
                new FieldSort("score", SortOrder.ASC))));

関連性スコアによるソート

次の例では、BM25 関連性スコアの降順で結果を返します。

TermQuery termQuery = new TermQuery();
termQuery.setFieldName("category");
termQuery.setTerm(ColumnValue.fromString("book"));

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(termQuery);
searchQuery.setSort(new Sort(
        Collections.<Sort.Sorter>singletonList(new ScoreSort())));

フィールド値の欠落の処理

次の例では、score フィールドで降順に行をソートします。行にこのフィールドが含まれていない場合、score_backup の値が使用されます。両方のフィールドが欠落している場合、その行は最後に配置されます。

FieldSort fieldSort = new FieldSort("score", SortOrder.DESC);
fieldSort.setMissingFields(Collections.singletonList("score_backup"));
fieldSort.setMissingValue(FieldSort.LAST_WHEN_MISSING);

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setSort(new Sort(
        Collections.<Sort.Sorter>singletonList(fieldSort)));

複数値フィールドと Nested フィールドのソート

配列やその他の複数値フィールドをソートする場合、mode を使用してソートに参加する値を指定します。次の例では、scores 配列の最大値で降順に行をソートします。

FieldSort fieldSort = new FieldSort("scores", SortOrder.DESC);
fieldSort.setMode(SortMode.MAX);

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setSort(new Sort(
        Collections.<Sort.Sorter>singletonList(fieldSort)));

Nested サブフィールドをソートする場合、Nested パスも構成し、ソートに参加する子行を選択します。次の例では、items.age が 1 の子行のみを使用し、items.name の最小値で昇順に行をソートします。

TermQuery ageQuery = new TermQuery();
ageQuery.setFieldName("items.age");
ageQuery.setTerm(ColumnValue.fromLong(1));

FieldSort fieldSort = new FieldSort("items.name", SortOrder.ASC);
fieldSort.setMode(SortMode.MIN);
fieldSort.setNestedFilter(new NestedFilter("items", ageQuery));

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setSort(new Sort(
        Collections.<Sort.Sorter>singletonList(fieldSort)));

地理的距離によるソート

次の例では、location フィールドと 30.23,120.19 の間の球面距離に基づいて、最も近いものから最も遠いものへと行を返します。

GeoDistanceSort geoSort = new GeoDistanceSort(
        "location", Collections.singletonList("30.23,120.19"));
geoSort.setOrder(SortOrder.ASC);
geoSort.setDistanceType(GeoDistanceType.ARC);

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setSort(new Sort(
        Collections.<Sort.Sorter>singletonList(geoSort)));

limit と offset を使用したページネーション

次の例では、最初の 100 行をスキップし、次の 100 行を返します。このメソッドを使用する場合、limit と offset の合計は 100,000 を超えることはできません。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(new MatchAllQuery());
searchQuery.setLimit(100);
searchQuery.setOffset(100);

トークンを使用したページネーション

次の例では、ループですべての結果を読み取ります。最初のクエリではトークンは null です。後続の各クエリは、前の応答の nextToken を直接使用します。setToken が呼び出されると、トークンには前のページのソート条件が含まれているため、SDK はソートをクリアします。

List<Row> rows = new ArrayList<Row>();
byte[] nextToken = null;
do {
    SearchQuery searchQuery = new SearchQuery();
    searchQuery.setQuery(new MatchAllQuery());
    searchQuery.setLimit(100);
    searchQuery.setToken(nextToken);

    SearchRequest request =
            new SearchRequest("example_table", "example_index", searchQuery);
    SearchResponse response = client.search(request);
    rows.addAll(response.getRows());
    nextToken = response.getNextToken();
} while (nextToken != null);

同一プロセス内でのシーケンシャルなクエリでは、nextToken をバイト配列として直接渡します。Base64 エンコーディングは、トークンを永続化したり、プロセス間やフロントエンドとバックエンド間で転送したりする必要がある場合にのみ使用してください。new String(nextToken) を使用してトークンを変換しないでください。トークンが破損する原因となります。

String encodedToken = Base64.getEncoder().encodeToString(nextToken);
byte[] decodedToken = Base64.getDecoder().decode(encodedToken);