Tablestore SDK for Python を使用して完全一致検索を実行する - Tablestore

完全一致検索を使用して、フィールド値が指定されたキーワードと完全に一致する行を検索します。TEXT フィールドの場合、Tablestore はフィールド値をトークン化し、各トークンをキーワードと照合します。いずれかのトークンが一致した場合、その行が返されます。キーワード自体はトークン化されません。

前提条件

OTSClient インスタンスが初期化済みです。詳細については、「Tablestore クライアントの初期化」をご参照ください。
データテーブルが作成され、データがデータテーブルに書き込まれます。詳細については、「データテーブルを作成する」および「データを書き込む」をご参照ください。
データテーブルの検索インデックスが作成されます。詳細については、「検索インデックスを作成する」をご参照ください。

パラメーター

パラメーター	説明
query_type	クエリの種類です。TermQuery に設定します。
field_name	クエリ対象のフィールド名です。
term	フィールド値と照合するキーワードです。キーワードはトークン化されず、全体として照合されます。 TEXT フィールドの場合、Tablestore はフィールド値をトークン化し、各トークンをキーワードと照合します。いずれかのトークンが完全に一致した場合、その行が返されます。たとえば、TEXT フィールドに "tablestore is cool" という値が含まれている場合、この値は "tablestore"、"is"、"cool" の 3 つのトークンに分割されます。"tablestore"、"is"、または "cool" のいずれかでクエリを実行すると、該当の行が返されます。
table_name	データテーブルの名前です。
index_name	検索インデックスの名前。
limit	返される行の最大数です。行データを返さずに件数のみ取得する場合は、0 を設定します。
get_total_count	一致する行の総数を返すかどうかを指定します。デフォルトは false です。 true に設定すると、クエリのパフォーマンスが低下します。
columns_to_get	一致する各行に対して返すカラムを指定します。return_type および column_names を必要に応じて設定します。 ColumnReturnType.SPECIFIED：column_names にリストされたカラムのみを返します。 ColumnReturnType.ALL：すべてのカラムを返します。 ColumnReturnType.NONE：プライマリキー列のみを返します。

使用例

以下の例では、Col_Keyword フィールドの値が "tablestore" と完全に一致する行を検索します。

Tablestore SDK for Python V5.2.1 以降

SDK for Python V5.2.1 以降では、デフォルトで SearchResponse オブジェクトが返されます。以下の例は、基本的な完全一致検索を示しています：

query = TermQuery('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 形式で結果を取得するには、.v1_response() を呼び出します：

query = TermQuery('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()

Tablestore SDK for Python 5.2.1 より前のバージョン

SDK for Python 5.2.1 より前のバージョンでは、デフォルトで Tuple 形式で結果が返されます：

query = TermQuery('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)
)

よくある質問

参照

多次元インデックスを使用してデータをクエリする際は、以下のクエリ方法を利用できます：完全一致検索、複数値完全一致検索、完全一致検索、一致検索、フレーズ一致検索、プレフィックス検索、範囲クエリ、ワイルドカード検索、ジオクエリ、ブール値クエリ、KNN ベクタークエリ、ネストされたクエリ、および exists クエリ。ビジネス要件に応じて、多次元インデックスが提供するこれらのクエリ方法を使用して、多角的にデータをクエリできます。
クエリ条件を満たす行に対して、ソートおよびページング機能を使用して並べ替えやページ分割が可能です。詳細については、「ソートとページング」をご参照ください。
折りたたみ (distinct) 機能を使用して、特定のカラムに基づいて結果セットを折りたたむことができます。これにより、指定されたタイプのデータがクエリ結果に一度だけ表示されます。詳細については、「折りたたみ (distinct)」をご参照ください。
データテーブル内のデータを分析したい場合は、Search 操作の集約機能を使用するか、SQL ステートメントを実行します。たとえば、最小値、最大値、合計値、行の総数を取得できます。詳細については、「集約」および「SQL クエリ」をご参照ください。
クエリ条件を満たすすべての行を取得する必要があり、かつ行のソートが不要な場合は、ParallelScan 操作および ComputeSplits 操作を呼び出して並列スキャン機能を使用できます。詳細については、「並列スキャン」をご参照ください。