すべてのプロダクト
Search

このプロダクト

    Tablestore:プレフィックスクエリ

    ドキュメントセンター

    Tablestore:プレフィックスクエリ

    最終更新日:Dec 28, 2024

    プレフィックスクエリを実行して、指定したプレフィックスに一致するデータをクエリできます。プレフィックス条件の照合に使用される列が TEXT 列の場合、その列はトークン化されます。少なくとも 1 つのトークンに指定されたプレフィックスが含まれている場合、行はクエリ条件を満たします。

    前提条件

    パラメーター

    パラメーター

    説明

    field_name

    クエリする列の名前。

    prefix

    プレフィックス。

    プレフィックス条件の照合に使用される列が TEXT 列の場合、その列はトークン化されます。少なくとも 1 つのトークンに指定されたプレフィックスが含まれている場合、行はクエリ条件を満たします。

    query

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

    table_name

    データテーブルの名前。

    index_name

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

    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 列の値が 'tablestore' で始まる行をクエリする方法を示しています。

    • Python V5.2.1 以降の Tablestore SDK を使用してプレフィックスクエリを実行する

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

      query = PrefixQuery('Col_Keyword', 'tablestore')
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 = PrefixQuery('Col_Keyword', 'tablestore')
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 より前のバージョンの Python 用 Tablestore SDK を使用してプレフィックスクエリを実行する

      V5.2.1 より前のバージョンの Python 用 Tablestore SDK を使用してプレフィックスクエリを実行すると、デフォルトで TUPLE タイプの結果が返されます。次のサンプルコードはリクエストの例を示しています。

      query = PrefixQuery('Col_Keyword', 'tablestore')
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

    関連情報