すべてのプロダクト
Search

このプロダクト

    Tablestore:範囲クエリ

    ドキュメントセンター

    Tablestore:範囲クエリ

    最終更新日:Dec 28, 2024

    指定した範囲内のデータをクエリするために、範囲クエリを実行できます。列の型が TEXT の場合、Tablestore は文字列をトークン化し、そのトークンを使用してキーワードを照合します。行内の少なくとも 1 つのトークンがクエリ範囲と一致する場合、その行はクエリ条件を満たします。

    前提条件

    パラメータ

    パラメータ

    説明

    field_name

    クエリ対象の列の名前。

    range_from

    クエリを開始する値。

    range_to

    クエリを終了する値。

    include_lower

    レスポンスに range_from パラメータの値を含めるかどうかを指定します。このパラメータの値はブール型です。

    include_upper

    レスポンスに range_to パラメータの値を含めるかどうかを指定します。このパラメータの値はブール型です。

    table_name

    データテーブルの名前。

    index_name

    検索インデックスの名前。

    query

    クエリのタイプ。このパラメータを RangeQuery に設定します。

    limit

    現在のクエリで返される最大行数。

    行の特定のデータをクエリせずに、クエリ条件を満たす行の数のみをクエリするには、limit パラメータを 0 に設定します。

    get_total_count

    クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値は false で、クエリ条件を満たす行の総数は返されません。

    このパラメータを true に設定すると、クエリのパフォーマンスが低下します。

    columns_to_get

    クエリ条件を満たす各行のすべての列を返すかどうかを指定します。このパラメータには、return_type フィールドと column_names フィールドを指定できます。

    • return_type フィールドを ColumnReturnType.SPECIFIED に設定する場合は、column_names フィールドを使用して返す列を指定します。

    • return_type フィールドを ColumnReturnType.ALL に設定すると、すべての列が返されます。

    • return_type フィールドを ColumnReturnType.NONE に設定すると、プライマリキー列のみが返されます。

    例

    次の例は、Col_Keyword 列の値が 'key100' と 'key200' の間にある行をクエリする方法を示しています。

    • Python V5.2.1 以降の Tablestore SDK を使用して範囲クエリを実行する

      Python V5.2.1 以降の Tablestore SDK を使用して範囲クエリを実行する場合、デフォルトで SearchResponse オブジェクトが返されます。次のコードはリクエストの例です。

      query = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
search_response = client.search(
    '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)
print('request_id : %s' % search_response.request_id)
print('is_all_succeed : %s' % search_response.is_all_succeed)
print('total_count : %s' % search_response.total_count)
print('rows : %s' % search_response.rows)

# # 深いページングが必要な場合は、next_token パラメータを使用することをお勧めします。この方法はページングの深さに制限がありません。
# all_rows = []
# next_token = None
# # 最初のラウンド
# search_response = client.search(
#     '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
#     SearchQuery(query, next_token=next_token, limit=100, get_total_count=True),
#     columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
# all_rows.extend(search_response.rows)
# 
# # ループ
# while search_response.next_token:
#     search_response = client.search(
#         '<TABLE_NAME>', '<SEARCH_INDEX_NAME>',
#         SearchQuery(query, next_token=search_response.next_token, limit=100, get_total_count=True),
#         columns_to_get=ColumnsToGet(return_type=ColumnReturnType.ALL))
#     all_rows.extend(search_response.rows)
# print('Total rows:%s' % len(all_rows))

      Tuple 型の結果を返すには、次のサンプルリクエストを使用できます。

      query = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
rows, next_token, total_count, is_all_succeed, agg_results, group_by_results = client.search(
    '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
).v1_response()

    • 5.2.1 より前のバージョンの Tablestore SDK for Python を使用して範囲クエリを実行する

      5.2.1 より前のバージョンの Tablestore SDK for Python を使用して範囲クエリを実行する場合、デフォルトで TUPLE 型の結果が返されます。次のサンプルコードはリクエストの例です。

      query = RangeQuery('Col_Keyword', 'key100', 'key200', include_lower=False, include_upper=False)
rows, next_token, total_count, is_all_succeed = client.search(
    '<TABLE_NAME>', '<SEARCH_INDEX_NAME>', 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)

    FAQ

    関連情報