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

Tablestore:範囲クエリ

最終更新日:Dec 28, 2024

指定した範囲内のデータに対して範囲クエリを実行できます。フィールドのタイプが TEXT の場合、フィールド値はトークン化されます。行内のトークンの少なくとも 1 つがクエリ範囲と一致する場合、その行はクエリ条件を満たします。

前提条件

パラメーター

パラメーター

説明

tableName

データテーブルの名前。

indexName

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

offset

現在のクエリの開始位置。

limit

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

特定のデータではなく、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。

queryType

クエリのタイプ。範囲クエリを使用するには、このパラメーターを TableStore.QueryType.RANGE_QUERY に設定します。

fieldName

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

rangeFrom

クエリが開始する値。

rangeTo

クエリが終了する値。

includeLower

レスポンスに rangeFrom の値を含めるかどうかを指定します。値のタイプはブール値です。

includeUpper

レスポンスに rangeTo の値を含めるかどうかを指定します。値のタイプはブール値です。

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_Long 列の値が 1 以上 10 未満の行をクエリする方法の例を示しています。この例では、クエリ条件を満たす行は、Col_Long 列の値に基づいて降順で返されます。

/**
 * テーブルで、Col_Long 列の値が 1 から 10 の範囲にある行を検索します。範囲には 1 が含まれ、10 は含まれません。Tablestore は、これらの行を Col_Long 列の値に基づいて降順にソートします。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータではなく、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: { // クエリタイプを TableStore.QueryType.RANGE_QUERY に設定します。
            queryType: TableStore.QueryType.RANGE_QUERY,
            query: {
                fieldName: "Col_Long",
                rangeFrom: 1,
                includeLower: true, // 範囲に rangeFrom の値を含めます。
                rangeTo: 10,
                includeUpper: false // 範囲から rangeTo の値を除外します。
            }
        },
        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

FAQ

参照