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

Tablestore:一致フレーズクエリ

最終更新日:Dec 28, 2024

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

前提条件

パラメーター

パラメーター

説明

tableName

データテーブルの名前。

indexName

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

offset

クエリを開始する位置。

limit

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

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

queryType

クエリタイプ。一致フレーズクエリを使用するには、このパラメーターを TableStore.QueryType.MATCH_PHRASE_QUERY に設定します。

fieldName

一致させるフィールドの名前。

一致フレーズクエリは TEXT フィールドに適用されます。

text

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

一致させるフィールドが TEXT フィールドの場合、キーワードは、検索インデックスの作成時に指定したアナライザータイプに基づいて複数のトークンにトークン化されます。検索インデックスの作成時にアナライザータイプを指定しない場合、デフォルトでは単一単語トークン化が実行されます。詳細については、トークン化を参照してください。

たとえば、「this is」というフレーズに基づく一致フレーズクエリは、「...、this is tablestore」と「this is a table」に一致し、「this table is ...」または「is this a table」という値には一致しません。

getTotalCount

クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値: false。

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

columnToGet

クエリ条件を満たす各行のすべての列を返すかどうかを指定します。このパラメーターには returnType と returnNames を設定できます。

  • returnType を TableStore.ColumnReturnType.RETURN_SPECIFIED に設定した場合、returnNames を設定して返す列を指定する必要があります。

  • returnType パラメーターを TableStore.ColumnReturnType.RETURN_ALL に設定すると、すべての列が返されます。

  • returnType パラメーターを TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX に設定すると、検索インデックス内のすべての列が返されます。

  • returnType パラメーターを TableStore.ColumnReturnType.RETURN_NONE に設定すると、プライマリキー列のみが返されます。

次のサンプルコードは、一致フェーズクエリを実行して、Col_Text の値が「hangzhou shanghai」フェーズに一致する行を検索する方法の例を示しています。

/**
 * テーブルを検索して、Col_Text の値が「hangzhou shanghai」というフレーズ全体に順番に一致する行を見つけます。
 * Tablestore は、このクエリでフレーズと一致する行の数と、一致した行の一部を返します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータを返さずに、クエリ条件を満たす行の数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: {// クエリタイプを TableStore.QueryType.MATCH_PHRASE_QUERY に設定します。
            queryType: TableStore.QueryType.MATCH_PHRASE_QUERY,
            query: {
                fieldName: "Col_Text", // 一致させる列を指定します。
                text: "hangzhou shanghai" // 一致させるフレーズを指定します。
            }
        },
        getTotalCount: true // クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値: false。
    },
    columnToGet: { // 返す列を指定します。パラメーターを RETURN_SPECIFIED に設定して指定した列を返すか、RETURN_ALL に設定してすべての列を返すか、RETURN_ALL_FROM_INDEX に設定して検索インデックス内のすべての列を返すか、RETURN_NONE に設定してプライマリキー列のみを返すことができます。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

FAQ

参照

参照