すべてのプロダクト
Search
ドキュメントセンター

Tablestore:プレフィックスクエリ

最終更新日:Dec 28, 2024

プレフィックスクエリを実行して、指定したプレフィックスに一致するデータをクエリできます。プレフィックス条件の照合に使用される列がTEXT列の場合、その列はトークン化されます。少なくとも1つのトークンに指定されたプレフィックスが含まれている場合、行はクエリ条件を満たします。

前提条件

パラメータ

パラメータ

説明

table_name

データテーブルの名前。

index_name

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

offset

現在のクエリが開始される位置。

limit

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

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

get_total_count

クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値:false。falseの値は、クエリ条件を満たす行の総数が返されないことを指定します。

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

query_type

クエリタイプ。プレフィックスクエリを使用するには、このパラメータをQueryTypeConst::PREFIX_QUERYに設定します。

field_name

クエリする列の名前。

prefix

プレフィックス。

プレフィックス条件の照合に使用される列がTEXT列の場合、その列はトークン化されます。少なくとも1つのトークンに指定されたプレフィックスが含まれている場合、行はクエリ条件を満たします。

sort

レスポンス内の行をソートするために使用するメソッド。詳細については、ソートとページングをご参照ください。

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に設定すると、プライマリキー列のみが返されます。

次のサンプルコードは、データテーブルのkeyword列にプレフィックス「key」が含まれるすべての行をクエリする方法を示しています。

$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::PREFIX_QUERY,
            'query' => array(
                'field_name' => 'keyword',
                'prefix' => 'key'
            )
        ),
        'sort' => array(
            array(
                'field_sort' => array(
                    'field_name' => 'keyword',
                    'order' => SortOrderConst::SORT_ORDER_ASC
                )
            ),
        )
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_ALL,
        'return_names' => array('keyword')
    )
);
$response = $otsClient->search($request);

FAQ

参考資料