プレフィックスクエリ - Tablestore SDK for Python - Tablestore

前提条件

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

説明

プレフィックスクエリは、クエリ文字列で始まるフィールド値またはトークンに一致します。 Keyword フィールドの場合、完全なフィールド値がクエリ文字列で始まる必要があります。 Text フィールドの場合、1 つのトークンがクエリ文字列で始まっていれば、行は一致します。クエリ文字列はトークン化されません。照合では大文字と小文字が区別されます。 search メソッドを呼び出す際に、クエリタイプを PrefixQuery に設定します。フィールドタイプの詳細については、「文字列タイプ」をご参照ください。

PrefixQuery(field_name, prefix, weight=None)

次の例では、category フィールドが book- で始まる行を検索し、最大 10 件の行と、一致した行の総数を返します。

query = PrefixQuery("category", "book-")
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 (必須)	`文字列`	データテーブルの名前。
index_name (必須)	`str`	検索インデックスの名前。
search_query (必須)	`SearchQuery`	クエリ条件と共通のクエリ設定。
columns_to_get (任意)	`ColumnsToGet`	返す列の設定。このパラメーターが指定されていない場合、プライマリキー列のみが返されます。
routing_keys (任意)	`list`	カスタムルーティングフィールドのプライマリキー値のリスト。カスタムルーティングが設定されていない場合、このパラメーターを指定する必要はありません。
timeout_s (任意)	`int`	リクエストのタイムアウト (秒単位)。このパラメーターが指定されていない場合、クライアントレベルのタイムアウトが使用されます。

クエリ設定

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

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

クエリ条件

search_query.query は PrefixQuery タイプで、以下のパラメーターが含まれています。

名前	タイプ	説明
field_name (必須)	`str`	クエリ対象の `Keyword` または `Text` フィールドの名前。
prefix (必須)	`文字列`	クエリ文字列。 `Keyword` フィールドの場合、フィールド値はこの文字列で始まる必要があります。 `Text` フィールドの場合、いずれかのトークンがこの文字列で始まる必要があります。この文字列はトークン化されません。マッチングでは大文字と小文字が区別されます。
weight (任意)	`float`	クエリ条件の関連性の重みです。値は正の浮動小数点数である必要があります。このパラメーターはマッチングや返される行数には影響しませんが、関連性スコアによって結果がソートされる場合にのみ順序に影響します。デフォルト値は `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()