すべてのプロダクト
Search

このプロダクト

    Tablestore:一致フレーズクエリ

    ドキュメントセンター

    Tablestore:一致フレーズクエリ

    最終更新日:Dec 28, 2024

    一致フレーズクエリは、一致クエリと似ていますが、一致フレーズクエリはトークンの位置を評価する点が異なります。行がクエリ条件を満たすのは、行内のトークンの順序と位置が、キーワードに含まれるトークンの順序と位置に一致する場合のみです。クエリ対象の列のトークン化方法がファジートークン化の場合、一致フレーズクエリはワイルドカードクエリよりも低いレイテンシで実行されます。

    前提条件

    パラメーター

    パラメーター

    説明

    field_name

    クエリ対象の列の名前。

    TEXT 列で一致クエリを実行できます。

    text

    一致フレーズクエリを実行するときに、列の値と照合するために使用されるキーワード。

    クエリ対象の列が TEXT 列の場合、キーワードは、検索インデックスの作成時に指定したアナライザータイプに基づいて複数のトークンにトークン化されます。検索インデックスの作成時にアナライザータイプを指定しない場合、デフォルトでは単一単語のトークン化が実行されます。

    たとえば、「this is」というフレーズを使用して一致フレーズクエリを実行すると、「...、this is tablestore」と「this is a table」が返されます。「this table is ...」や「is this a table」は返されません。

    query

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

    table_name

    データテーブルの名前。

    index_name

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

    limit

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

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

    get_total_count

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

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

    columns_to_get

    クエリ条件を満たす各行のすべての列を返すかどうかを指定します。

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

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

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

    例

    次の例では、一致フレーズクエリを使用して、Col_Text 列の値が「this is」フレーズに順番に一致する行をクエリする方法について説明します。

    • Python SDK V5.2.1 以降を使用して一致フレーズクエリを実行する

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

      query = MatchPhraseQuery('Col_Text', 'this is')
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 = MatchPhraseQuery('Col_Text', 'this is')
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()

    • Python SDK 5.2.1 より前のバージョンを使用して一致フレーズクエリを実行する

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

      query = MatchPhraseQuery('Col_Text', 'this is')
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

    関連情報