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

複数値完全一致検索は、指定された複数の値のいずれかと列の値が完全に一致する行を返します。これは SQL の IN 演算子と同等です。完全一致検索とは異なり、複数値完全一致検索では複数の一致値を受け入れます。

前提条件

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

パラメーター

パラメーター	説明
query_type	クエリの種類です。`TermsQuery` に設定します。
field_name	クエリ対象の列名です。
terms	列の値と照合する用語のリストです。行の列値がリスト内の少なくとも 1 つの用語と完全に一致する場合、その行が返されます。
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 列の値が key000、key100、key888、key999、key908、または key1000 のいずれかと完全に一致する行をクエリします。

注： get_total_count を true に設定すると、クエリのパフォーマンスが低下します。正確な一致件数が必要な場合にのみ、このオプションを有効にしてください。

SDK for Python V5.2.1 以降

SDK for Python V5.2.1 以降では、デフォルトで 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))

代わりにタプル形式で結果を取得するには、以下のようにします。

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()

SDK for Python V5.2.1 より前のバージョン

SDK for Python V5.2.1 より前のバージョンでは、デフォルトでタプル形式の結果が返されます。

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)
)

よくある質問

参照

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