Tablestore:ソートとページング

シナリオ

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

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

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

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

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

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

ScoreSort

searchQuery := search.NewSearchQuery()
searchQuery.SetSort(&search.Sort{
    []search.Sorter{
        &search.ScoreSort{
            Order: search.SortOrder_DESC.Enum(), // クエリ結果をスコアの降順でソートします。
        },
    },
})

PrimaryKeySort

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

searchQuery := search.NewSearchQuery()
searchQuery.SetSort(&search.Sort{
    []search.Sorter{
        &search.PrimaryKeySort{
            Order: search.SortOrder_ASC.Enum(),
        },
    },
})

FieldSort

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

// Col_Long列の値に基づいてクエリ結果を降順でソートします。
searchQuery.SetSort(&search.Sort{
    []search.Sorter{
        &search.FieldSort{
            FieldName: "Col_Long",
            Order:     search.SortOrder_DESC.Enum(),
        },
    },
})

searchQuery.SetSort(&search.Sort{
    []search.Sorter{
        &search.FieldSort{
            FieldName: "col1",
            Order:     search.SortOrder_ASC.Enum(),
        },
        &search.FieldSort{
            FieldName: "col2",
            Order:     search.SortOrder_DESC.Enum(),
        },
    },
})

GeoDistanceSort

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

searchQuery.SetSort(&search.Sort{
    []search.Sorter{
        &search.GeoDistanceSort{
            FieldName: "location",   // GEOPOINTフィールドの名前を指定します。
            Points:    []string{"40,-70"}, // 中心点の座標ペアを指定します。
        },
    },
})

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

LimitパラメーターとOffsetパラメーターを設定するか、トークンを使用して、レスポンスの行をページングできます。

LimitパラメーターとOffsetパラメーターに基づくページング

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

searchQuery := search.NewSearchQuery()
searchQuery.SetLimit(10)
searchQuery.SetOffset(10) 

トークンに基づくページング

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

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

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

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

/**
 * トークンを使用してデータをページごとに読み取ります。
 * SearchResponseにNextTokenが含まれている場合は、このトークンを使用して次のクエリを開始できます。
 * NextTokenの値がnilの場合、クエリ条件を満たすすべてのデータが返されます。
 */
func QueryRowsWithToken(client *tablestore.TableStoreClient, tableName string, indexName string) {
    querys := []search.Query{
        &search.MatchAllQuery{},
        &search.TermQuery{
            FieldName: "Col_Keyword",
            Term:      "tablestore",
        },
    }
    for _, query := range querys {
        fmt.Printf("テストクエリ: %#v\n", query)
        searchRequest := &tablestore.SearchRequest{}
        searchRequest.SetTableName(tableName)
        searchRequest.SetIndexName(indexName)
        searchQuery := search.NewSearchQuery()
        searchQuery.SetQuery(query)
        searchQuery.SetLimit(10)
        searchQuery.SetGetTotalCount(true)
        searchRequest.SetSearchQuery(searchQuery)
        searchResponse, err := client.Search(searchRequest)
        if err != nil {
            fmt.Printf("%#v", err)
            return
        }
        rows := searchResponse.Rows
        requestCount := 1
        for searchResponse.NextToken != nil {           
            {  
	              // NextTokenを永続化する場合、またはNextTokenをフロントエンドページに転送する場合は、Base64を使用してNextTokenを文字列にエンコードできます。
	              // トークンは文字列ではありません。string(NextToken)を使用してトークンを文字列にエンコードすると、トークンに関する情報が失われます。
	              tokenAsString := base64.StdEncoding.EncodeToString(searchResponse.NextToken)
	              // 文字列をバイトにデコードします。
	              tokenAsByte, err := base64.StdEncoding.DecodeString(tokenAsString)
	              if err != nil {
		                fmt.Printf("len:%d, %#v",len(tokenAsByte), err)
		                return
	              }
            }
            searchQuery.SetToken(searchResponse.NextToken)
            searchResponse, err = client.Search(searchRequest)
            if err != nil {
                fmt.Printf("%#v", err)
                return
            }
            requestCount++
            for _, r := range searchResponse.Rows {
                rows = append(rows, r)
            }
        }
        fmt.Println("IsAllSuccess: ", searchResponse.IsAllSuccess)
        fmt.Println("TotalCount: ", searchResponse.TotalCount)
        fmt.Println("RowsSize: ", len(rows))
        fmt.Println("RequestCount: ", requestCount)
    }
}