すべてのプロダクト
Search
ドキュメントセンター

Tablestore:Terms クエリ

最終更新日:Dec 28, 2024

terms クエリは、term クエリに似ています。 terms クエリは複数の用語をサポートしています。キーワードの少なくとも 1 つが列の値と完全に一致する場合、データの行が返されます。 terms クエリは、SQL ステートメントの IN 演算子と同じ方法で使用できます。

前提条件

パラメーター

パラメーター

説明

query_type

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

field_name

クエリ対象の列の名前。

terms

terms クエリの実行時に列の値と照合するために使用されるキーワード。

キーワードの少なくとも 1 つが列の値と完全に一致する場合、データの行が返されます。

table_name

データテーブルの名前。

index_name

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

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 列の値が 'key000'、'key100'、'key888'、'key999'、'key908'、'key1000' のいずれかと完全に一致する行をクエリする方法を示しています。

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

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

    query = TermsQuery('Col_Keyword', ['key000', 'key100', 'key888', 'key999', 'key908', 'key1000'])
    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 = TermsQuery('Col_Keyword', ['key000', 'key100', 'key888', 'key999', 'key908', 'key1000'])
    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 を使用して terms クエリを実行する

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

    query = TermsQuery('Col_Keyword', ['key000', 'key100', 'key888', 'key999', 'key908', 'key1000'])
    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

参考資料

  • 検索インデックスを使用してデータをクエリする場合、次のクエリメソッドを使用できます: term クエリterms クエリmatch all クエリmatch クエリmatch phrase クエリprefix クエリrange クエリwildcard クエリgeo クエリBoolean クエリKNN ベクタークエリnested クエリexists クエリ。ビジネス要件に基づいて、検索インデックスが提供するクエリメソッドを使用して、複数のディメンションからデータをクエリできます。

    並べ替え機能とページング機能を使用して、クエリ条件を満たす行を並べ替えたり、ページネーションしたりできます。詳細については、並べ替えとページングを参照してください。

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

  • データテーブルのデータを分析する場合は、Search オペレーションの集計機能を使用するか、SQL ステートメントを実行できます。たとえば、最小値、最大値、合計、行の総数などを取得できます。詳細については、集計SQL クエリを参照してください。

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