Term クエリ - Tablestore SDK for Python - Tablestore - Alibaba Cloud ドキュメントセンター

前提条件

Tablestore SDK for Python をインストールし、クライアントを初期化します。

説明

term クエリは、クエリ値と完全に同じ内容に一致します。Keyword や Long などのテキスト以外のフィールドの場合、フィールド値はクエリ値と完全に一致する必要があります。Text フィールドの場合、1 つのトークンがクエリ値と完全に一致すると、その行は一致したとみなされます。クエリ値はトークン化されません。トークン化は、アナライザーの設定、アルゴリズムの更新、および言語によって異なる場合があります。Text フィールド内の完全な文字列に一致させるために term クエリを使用しないでください。search メソッドを呼び出すときは、クエリタイプを TermQuery に設定します。フィールドタイプについては、「文字列型」をご参照ください。

TermQuery(field_name, column_value, weight=None)

次の例では、category フィールドが book-python と完全に一致する行をクエリし、最大 10 行と一致する行の総数を返します。

query = TermQuery("category", "book-python")
search_query = SearchQuery(
    query,
    limit=10,
    get_total_count=True,
)
response = client.search(
    "example_table",
    "example_index",
    search_query,
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
print(response.total_count)
for row in response.rows:
    print(row)

パラメーター

検索リクエスト

search メソッドには、次のパラメーターが含まれています。

名前	タイプ	説明
table_name (必須)	`str`	データテーブルの名前。
index_name (必須)	`str`	検索インデックスの名前。
search_query (必須)	`SearchQuery`	クエリ条件と共通のクエリ設定。
columns_to_get (オプション)	`ColumnsToGet`	取得する列の設定。このパラメーターが指定されていない場合、プライマリキー列のみが返されます。
routing_keys (オプション)	`list`	カスタムルーティングフィールドのプライマリキー値のリスト。カスタムルーティングが設定されていない場合、このパラメーターを指定する必要はありません。
timeout_s (オプション)	`int`	リクエストのタイムアウト (秒単位) 。このパラメーターが指定されていない場合、クライアントレベルのタイムアウトが使用されます。

クエリ設定

search_queryは SearchQuery 型で、次のパラメーターが含まれています。

名前	タイプ	説明
query (必須)	`クエリ`	クエリ条件。このパラメーターには `TermQuery` を設定します。
sort (オプション)	`ソート`	クエリ結果のソート順。詳細については、「結果のソートとページ分割」をご参照ください。
get_total_count (オプション)	`bool`	一致する行の総数を返すかどうかを指定します。デフォルト値： `False`。このパラメーターを `True` に設定すると、クエリのオーバーヘッドが増加します。
next_token (オプション)	`バイト`	ページネーショントークン。次のページを取得するには、このパラメーターを前のレスポンスの`next_token`に設定します。詳細については、「結果のソートとページネーション」をご参照ください。
offset (オプション)	`int`	クエリ結果の開始オフセット。このパラメーターは、シャローページネーションに使用します。
limit (オプション)	`int`	返す最大行数。このパラメーターが `0` に設定されている場合、行データは返されません。
aggs (オプション)	`list[Agg]`	アグリゲーション設定。詳細については、「アグリゲーション」をご参照ください。
group_bys (オプション)	`list[BaseGroupBy]`	グループ化設定。詳細については、「アグリゲーション」をご参照ください。
collapse_field (オプション)	`折りたたみ`	結果の折りたたみ設定。指定されたフィールドに基づいて重複した結果を削除します。詳細については、「クエリ結果の折りたたみ」をご参照ください。
highlight (オプション)	`ハイライト`	`Text` フィールドの要約とハイライトの設定。詳細については、「要約とハイライト」をご参照ください。

クエリ条件

search_query.query は TermQuery 型で、以下のパラメーターを含みます。

名前	タイプ	説明
field_name (必須)	`str`	クエリ対象のインデックス付きフィールドの名前。
column_value (必須)	`str / int / float / bool`	クエリ値です。`Text` フィールドの場合、値は完全なトークンとして使用され、トークン化されません。
weight (オプション)	`float`	クエリ条件の関連性の重みです。値は正の浮動小数点数である必要があります。値が大きいほど、BM25 関連性スコアへの貢献度が高くなります。このパラメーターは、マッチングや返される行数には影響しません。結果が関連性スコアでソートされる場合にのみ、順序に影響します。デフォルト値: `1.0`。

取得する列

columns_to_get は ColumnsToGet 型で、以下のパラメーターを含みます。

名前	タイプ	説明
column_names (オプション)	`list[str]`	返す属性列の名前。 `return_type` が `SPECIFIED` の場合にのみ、このパラメーターを指定します。
return_type (オプション)	`ColumnReturnType`	戻り列モード。 `NONE` (デフォルト) はプライマリキー列のみを返し、`SPECIFIED` は `column_names` の属性列を返し、`ALL` はテーブルのすべての属性列を返し、`ALL_FROM_INDEX` はインデックス付きのすべての属性列を返します。

レスポンス

search メソッドは SearchResponse を返します。以下の表では、主要なフィールドについて説明します。

フィールド	タイプ	説明
rows	`list[Row]`	現在のクエリによって返された行。行数は `limit` を超えません。
next_token	`バイト`	次のページを取得するためのトークン。このフィールドが空でない場合、次のリクエストでこの値を渡すことで読み取りを続行できます。
total_count	`int`	一致する行の数。値は `get_total_count` の設定によって異なります。
is_all_succeed	`bool`	すべてのインデックスパーティションがクエリされたかどうかを示します。値が `False` の場合、部分的な結果が返され、`total_count` は一致する行の実際の数より少なくなる可能性があります。
agg_results	`list[AggResult]`	集計結果。`aggs` が設定されていない場合は空になります。
group_by_results	`list[GroupByResult]`	グルーピング結果です。`group_bys` が設定されていない場合、このフィールドは空になります。
search_hits	`list[SearchHit]`	検索結果の詳細情報。関連度スコア、ハイライト、一致した子行などの拡張情報を含みます。

タプル互換レスポンス

Tablestore SDK for Python 5.2.0 以降、検索 API はタプルの代わりにレスポンスオブジェクトを返すようになりました。バージョン 5.1.0 以前ではタプルが直接返されます。バージョン 5.2.1 以降では、SearchResponse.v1_response() を呼び出すことで、以前のバージョンと互換性のあるタプルを取得できます。新しいコードでは、レスポンスフィールドが拡張された場合にアンパックエラーが発生するのを回避するため、SearchResponse の属性に直接アクセスすることを推奨します。

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()