PHP SDK for Tablestore を使用して一致クエリを実行する - Tablestore

一致クエリを使用すると、おおよその一致に基づいてテーブル内のデータをクエリできます。Tablestore は、TEXT 型の列の値と、指定したアナライザーに基づいて一致クエリを実行するために使用するキーワードをトークン化します。そのため、Tablestore はトークンに基づいて一致クエリを実行できます。あいまいなトークン化が使用されている列に対しては、MatchPhraseQuery オペレーションを呼び出して一致フレーズクエリを実行し、高性能なあいまいクエリを実現することをお勧めします。

前提条件

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

パラメーター

パラメーター	説明
table_name	データテーブルの名前。
index_name	検索インデックスの名前。
offset	現在のクエリが開始される位置。
limit	現在のクエリで返される最大行数。行の具体的なデータをクエリせずに、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
get_total_count	クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値は false で、クエリ条件を満たす行の総数は返されません。このパラメーターを true に設定すると、クエリのパフォーマンスが低下します。
query_type	クエリのタイプ。このパラメーターを `QueryTypeConst::MATCH_QUERY` に設定します。
field_name	クエリ対象の列の名前。列は TEXT 型にすることができます。
text	一致クエリを実行するときに列の値と照合するために使用されるキーワード。クエリ対象の列が TEXT 型の場合、キーワードは、検索インデックスの作成時に指定したアナライザータイプに基づいて複数のトークンにトークン化されます。検索インデックスの作成時にアナライザータイプを指定しない場合、デフォルトでは単一単語トークン化が実行されます。たとえば、クエリ対象の列が TEXT 型で、アナライザータイプが単一単語トークン化の場合、「this is」というフレーズを使用して一致クエリを実行すると、「..., this is tablestore」、「is this tablestore」、「tablestore is cool」、「this」、「is」などのクエリ結果が返されます。
operator	論理演算子。デフォルトでは、OR が論理演算子として使用されます。これは、列の値に少なくとも最小数のトークンが含まれている場合、行がクエリ条件を満たすことを指定します。演算子を AND に設定した場合、列の値にすべてのトークンが含まれている場合にのみ、行はクエリ条件を満たします。
minimum_should_match	列の値に含まれる一致するトークンの最小数。行のクエリ対象列の値に、少なくとも最小数の一致するトークンが含まれている場合にのみ、行が返されます。説明 minimum_should_match パラメーターは、OR 論理演算子と組み合わせて使用する必要があります。
columns_to_get	クエリ条件を満たす行のすべての列を返すかどうかを指定します。return_type パラメーターと return_names パラメーターを指定できます。 return_type を `ColumnReturnTypeConst::RETURN_SPECIFIED` に設定した場合、return_names を使用して返す列を指定できます。 return_type パラメーターを `ColumnReturnTypeConst::RETURN_ALL` に設定すると、すべての列が返されます。 return_type を `ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX` に設定すると、検索インデックス内のすべての列が返されます。 return_type パラメーターを `ColumnReturnTypeConst::RETURN_NONE` に設定すると、プライマリキー列のみが返されます。

例

次のサンプルコードは、データテーブル内の text 列の値が「ots text php keyword」と一致する行をクエリする方法を示しています。

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 2,
        'get_total_count' => true,
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_QUERY,
            'query' => array(
                'field_name' => 'text',
                'text' => 'ots text php keyword',
//              'operator' => QueryOperatorConst::PBAND,
                'operator' => QueryOperatorConst::PBOR,// minimum_should_match パラメーターは OR 論理演算子と共に使用します。
                'minimum_should_match' => 3
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('text')
    )
);
$response = $otsClient->search($request);

FAQ

参考資料

検索インデックスを使用してデータをクエリする場合、次のクエリメソッドを使用できます。用語クエリ、複数用語クエリ、すべて一致クエリ、一致クエリ、一致フレーズクエリ、プレフィックスクエリ、範囲クエリ、ワイルドカードクエリ、ブールクエリ、地理クエリ、ネストされたクエリ、存在クエリ。ビジネス要件に基づいて、さまざまなクエリメソッドを使用して複数のディメンションからデータをクエリできます。
クエリ条件を満たす行をソートまたはページ分割する場合は、ソートおよびページ分割機能を使用できます。詳細については、ソートとページ分割をご参照ください。
特定の列に基づいて結果セットを折りたたむ場合は、折りたたみ（重複排除）機能を使用できます。このようにして、指定されたタイプのデータはクエリ結果に一度だけ表示されます。詳細については、折りたたみ（重複排除）をご参照ください。
データテーブル内のデータ（極値、合計、行の総数など）を分析する場合は、集計操作を実行するか、SQL ステートメントを実行できます。詳細については、集計およびSQL クエリをご参照ください。
行をソートする必要なく、クエリ条件を満たすすべての行をすばやく取得する場合は、ParallelScan および ComputeSplits オペレーションを呼び出して並列スキャン機能を使用できます。詳細については、並列スキャンをご参照ください。