Tablestore:ソートとページング

シナリオ

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

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

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

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

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

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

ScoreSort

'sort' => array(
    array(
        'score_sort' => array(
            'order' => SortOrderConst::SORT_ORDER_DESC // 降順にソート
        )
    ),
)

PrimaryKeySort

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

'sort' => array(
    array(
        'pk_sort' => array(
            'order' => SortOrderConst::SORT_ORDER_ASC // 昇順にソート
        )
    ),
)

FieldSort

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

'sort' => array(
    array(
        'field_sort' => array(
            'field_name' => 'keyword', // ソート対象のフィールド名
            'order' => SortOrderConst::SORT_ORDER_ASC, // 昇順にソート
            'mode' => SortModeConst::SORT_MODE_AVG, // ソートモード
        )
    ),
)

GeoDistanceSort

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

'sort' => array(
    array(
        'geo_distance_sort' => array(
            'field_name' => 'geo', //地理位置情報を含むフィールド名
            'order' => SortOrderConst::SORT_ORDER_ASC, // 昇順にソート (近い順)
            'distance_type' => GeoDistanceTypeConst::GEO_DISTANCE_PLANE, // 距離計算方法
            'points' => array('0.6,0.6') // 中心点の座標
        )
    ),
)

複数のソート方法の組み合わせ

一致するデータが返される順序を決定するために、2 つの列の値に基づいて特定の順序でクエリ結果をソートできます。

'sort' => array(
    array(
        'field_sort' => array(
            'field_name' => 'keyword', // 第一ソートキー
            'order' => SortOrderConst::SORT_ORDER_ASC, // 昇順にソート
            'mode' => SortModeConst::SORT_MODE_AVG,
        )
    ),
    array(
        'pk_sort' => array( // 第二ソートキー (第一ソートキーが同じ場合に適用)
            'order' => SortOrderConst::SORT_ORDER_ASC // 昇順にソート
        )
    ),
)

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

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

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

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

$request = array(
    'table_name' => 'php_sdk_test', // テーブル名
    'index_name' => 'php_sdk_test_search_index', // インデックス名
    'search_query' => array(
        'offset' => 10, // オフセット (11 番目からのデータを取得)
        'limit' => 10, // 取得するデータの数
        'get_total_count' => true, // 総件数を取得するかどうか
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_ALL_QUERY // 全てのドキュメントにマッチするクエリ
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword', // ソート対象のフィールド
                    'order' => SortOrderConst::SORT_ORDER_ASC // 昇順にソート
                )
            ),
        ),
        'token' => null, // トークン (使用しない場合は null)
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED, // 指定したカラムのみを取得
        'return_names' => array('col1', 'col2') // 取得するカラム名
    )
);
$response = $otsClient->search($request);

トークンを使用する

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

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

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

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

$request = array(
    'table_name' => 'php_sdk_test', // テーブル名
    'index_name' => 'php_sdk_test_search_index', // インデックス名
    'search_query' => array(
        'offset' => 0, // オフセット
        'limit' => 10, // 取得件数
        'get_total_count' => true, // 合計件数を取得するかどうか
        'query' => array(
            'query_type' => QueryTypeConst::FUNCTION_SCORE_QUERY, // 関数スコアクエリ
            'query' => array(
                'query' => array(
                    'query_type' => QueryTypeConst::TERM_QUERY, // タームクエリ
                    'query' => array(
                        'field_name' => 'keyword', // フィールド名
                        'term' => 'keyword' // 検索語
                    )
                ),
                'field_value_factor' => array(
                    'field_name' => 'long' // スコアに影響を与えるフィールド
                )
            )
        ),
        'sort' => array(
            array(
                'score_sort' => array(
                    'order' => SortOrderConst::SORT_ORDER_DESC // スコアの降順でソート
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED, // 指定したカラムのみを取得
        'return_names' => array('keyword', 'long') // 取得するカラム名
    )
);

$response = $otsClient->search($request);
print "total_hits: " . $response['total_hits'] . "\n"; // ヒット件数を出力
print json_encode($response['rows'], JSON_PRETTY_PRINT); // 結果を出力

while($response['next_token'] != null) {
    $request['search_query']['token'] = $response['next_token']; // next_token を設定
    $request['search_query']['sort'] = null; // next_token が含まれる場合、トークンにソート情報が含まれているため、ソート方法を指定できません。
    $response = $otsClient->search($request);
    print json_encode($response['rows'], JSON_PRETTY_PRINT); // 結果を出力
}

FAQ

• Search オペレーションを呼び出してもデータが見つからない場合はどうすればよいですか？

• 検索インデックス機能の Search オペレーションを呼び出してデータをクエリする際に、limit パラメーターの値を 1000 に増やすにはどうすればよいですか？

• 検索インデックスベースのクエリでページネーションを使用すると、トークンが無効になるのはなぜですか？

参考資料

• 検索インデックスを使用してデータをクエリする場合、次のクエリ方法を使用できます。 タームクエリ、複数タームクエリ、すべて一致クエリ、一致クエリ、一致フレーズクエリ、プレフィックスクエリ、範囲クエリ、ワイルドカードクエリ、ブールクエリ、地理クエリ、ネストされたクエリ、存在クエリ。ビジネス要件に基づいて、さまざまなクエリ方法を使用して複数のディメンションからデータをクエリできます。

  クエリ条件を満たす行をソートまたはページングする場合は、ソートおよびページング機能を使用できます。詳細については、ソートとページングを参照してください。

  特定の列に基づいて結果セットを折りたたむ場合は、折りたたみ (個別) 機能を使用できます。このようにして、指定されたタイプのデータはクエリ結果に一度だけ表示されます。詳細については、折りたたみ (個別)を参照してください。

• データテーブルのデータ (極値、合計、行の総数など) を分析する場合は、集計操作を実行するか、SQL ステートメントを実行できます。詳細については、集計とSQL クエリを参照してください。

• 行をソートする必要なく、クエリ条件を満たすすべての行をすばやく取得する場合は、ParallelScan オペレーションと ComputeSplits オペレーションを呼び出して、パラレル スキャン機能を使用できます。詳細については、パラレル スキャンを参照してください。