Tablestore:ソートとページングの実行

シナリオ

Tablestore SDK を使用してソートとページングを実行する

次の Tablestore SDK を使用してソートとページングを実行できます。

• Java 用 Tablestore SDK: ソートとページング

• Go 用 Tablestore SDK: ソートとページング

• Python 用 Tablestore SDK: ソートとページング

• Node.js 用 Tablestore SDK: ソートとページング

• .NET 用 Tablestore SDK: ソートとページング

• PHP 用 Tablestore SDK: ソートとページング

インデックスの事前ソート

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

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

データをクエリするときにソート方法を指定する

ソートは、enableSortAndAgg パラメーターが true に設定されているフィールドに対してのみ有効にできます。

クエリごとにソート方法を指定できます。 検索インデックスベースのクエリは、次のソート方法をサポートしています。 優先順位に基づいて複数のソート方法を指定することもできます。

ScoreSort

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new ScoreSort())));

PrimaryKeySort

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

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort()))); // クエリ結果を昇順にソートします。
//searchQuery.setSort(new Sort(Arrays.asList(new PrimaryKeySort(SortOrder.DESC)))); // クエリ結果を降順にソートします。

FieldSort

FieldSort を使用して、1 つ以上の特定の列の値に基づいてクエリ結果をソートできます。

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(new FieldSort("col", SortOrder.ASC))));

SearchQuery searchQuery = new SearchQuery();
searchQuery.setSort(new Sort(Arrays.asList(
    new FieldSort("col1", SortOrder.ASC), new FieldSort("col2", SortOrder.ASC))));

/**
* Col_Long 列の値に基づいてクエリ結果を降順にソートします。 Long 型の Col_Long 列のデータがない場合は、同じデータ型の Col_Long_sec 列をソート用の補助列として使用できます。
*/
SearchQuery searchQuery = new SearchQuery();
FieldSort fieldSort = new FieldSort("Col_Long");
// Col_Long 列のデータがない場合のソート用の補助列として、Col_Long_sec 列を指定します。
fieldSort.setMissingField("Col_Long_sec");
fieldSort.setOrder(SortOrder.DESC); 

// doc1 行と doc2 行には、Array 型の field1 列が含まれています。 doc1 行の field1 列の値は [2,3] で、doc2 行の field1 列の値は [1,3,4] です。
// mode パラメーターを指定して、2 つの行をソートするために使用される 2 つの行の Array フィールドの要素を決定できます。
{
    // mode パラメーターを SortMode.MAX に設定すると、Array フィールドの最大要素を使用して行がソートされます。 この例では、doc1 行の 3 と doc2 行の 4 を使用して 2 つの行がソートされ、ソート結果は doc2 と doc1 になります。
    FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
    fieldSort.setMode(SortMode.MAX);
}
{
    // mode パラメーターを SortMode.MIN に設定すると、Array フィールドの最小要素を使用して行がソートされます。 この例では、doc1 行の 2 と doc2 行の 1 を使用して 2 つの行がソートされ、ソート結果は doc1 と doc2 になります。
    FieldSort fieldSort = new FieldSort("field1", SortOrder.DESC);
    fieldSort.setMode(SortMode.MIN);
}

// doc1 行と doc2 行には、Nested 型の field1 列が含まれています。
// doc1 行の field1 列の値は [{"name":"b", "age":1},{"name":"a", "age":7}] です。
// doc2 行の field1 列の値は [{"name":"a", "age":1},{"name":"c", "age":1},{"name":"d", "age":5}] です。

{
    // mode パラメーターを指定して、子行をソートするために使用される 2 つの行の Nested フィールドの要素を決定できます。
    // mode パラメーターを SortMode.MAX に設定すると、Nested フィールドの最大要素を使用して行がソートされます。 この例では、doc1 行の 7 と doc2 行の 5 を使用して、age 列で 2 つの行がソートされ、ソート結果は doc1 と doc2 になります。
    FieldSort fieldSort = new FieldSort("field1.age", SortOrder.DESC);
    fieldSort.setMode(SortMode.MAX);
    String path = "field1";
    NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.matchAll().build());
    fieldSort.setNestedFilter(nestedFilter);
}
{
    // mode パラメーターを指定して、age 列の値が 1 である子行をソートするために使用される 2 つの行の Nested フィールドの要素を決定できます。
    {
        // mode パラメーターを SortMode.MAX に設定すると、Nested フィールドの最大要素を使用して行がソートされます。 この例では、doc1 行の "b" と doc2 行の "a" を使用して、name 列で 2 つの行がソートされ、ソート結果は doc2 と doc1 になります。
        FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
        fieldSort.setMode(SortMode.MAX);
        String path = "field1";
        NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
        fieldSort.setNestedFilter(nestedFilter);
    }
    {
        // mode パラメーターを SortMode.MIN に設定すると、Nested フィールドの最小要素を使用して行がソートされます。 この例では、doc1 行の "b" と doc2 行の "a" を使用して、name 列で 2 つの行がソートされ、ソート結果は doc1 と doc2 になります。
        FieldSort fieldSort = new FieldSort("field1.name", SortOrder.DESC);
        fieldSort.setMode(SortMode.MIN);
        String path = "field1";
        NestedFilter nestedFilter = new NestedFilter(path, QueryBuilders.term("students.age",1).build());
        fieldSort.setNestedFilter(nestedFilter);
    }
}

GeoDistanceSort

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

SearchQuery searchQuery = new SearchQuery();
// GEOPOINT geo列の値から座標ペア (0, 0) までの距離に基づいて結果をソートします。
Sort.Sorter sorter = new GeoDistanceSort("geo", Arrays.asList("0, 0"));
searchQuery.setSort(new Sort(Arrays.asList(sorter)));

ページング方法を指定する

レスポンスの行をページングするには、limit パラメーターと offset パラメーターを設定するか、トークンを使用します。

limit パラメーターと offset パラメーターを設定する

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

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

トークンを使用する

この方法ではページングの深さに制限がないため、ディープページングにはトークンを使用することをお勧めします。

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

デフォルトでは、トークンを使用する場合、後方へのページングのみ可能です。ただし、トークンはクエリ中は有効であるため、前のトークンをキャッシュして使用することで前方へページングできます。

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

private static void readMoreRowsWithToken(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    searchQuery.setQuery(new MatchAllQuery());
    searchQuery.setGetTotalCount(true);// クエリ条件を満たす行の総数が返されるように指定します。
    // データテーブルの名前を指定します。例：sampleTable。次に、検索インデックスの名前を指定します。例：sampleSearchIndex。検索インデックス名を取得するには、Tablestore コンソールまたは Tablestore SDK を使用して検索インデックスのリストをクエリします。 Tablestore コンソールで検索インデックスのリストをクエリする場合は、「テーブルの管理」ページの「インデックス」タブでリストを表示できます。
    SearchRequest searchRequest = new SearchRequest("sampleTable", "sampleSearchIndex", searchQuery);

    SearchResponse resp = client.search(searchRequest);
    if (!resp.isAllSuccess()) {
        throw new RuntimeException("not all success");
    }
    List<Row> rows = resp.getRows();
    while (resp.getNextToken()!=null) { // レスポンスの nextToken 値が null の場合、すべてのデータが読み取られます。
        // nextToken 値をクエリします。
        byte[] nextToken = resp.getNextToken();

        {
            // nextToken を永続化する場合、または nextToken をフロントエンド ページに転送する場合は、Base64 を使用して nextToken を文字列にエンコードできます。
            // トークンは文字列ではありません。 new String(nextToken) を使用してトークンを文字列にエンコードすると、トークンに関する情報が失われます。
            String tokenAsString = Base64.toBase64String(nextToken);
            // 文字列をバイトにデコードします。
            byte[] tokenAsByte = Base64.fromBase64String(tokenAsString);
        }

        // このリクエストのトークンを前のレスポンスの nextToken 値に設定します。
        searchRequest.getSearchQuery().setToken(nextToken);
        resp = client.search(searchRequest);
        if (!resp.isAllSuccess()) {
            throw new RuntimeException("not all success");
        }
        rows.addAll(resp.getRows());
    }
    System.out.println("RowSize: " + rows.size());
    System.out.println("TotalCount: " + resp.getTotalCount());// 返された行数ではなく、クエリ条件を満たす行の総数が表示されるように指定します。
}