全部產品
Search
文件中心

:範圍查詢

更新時間:Jul 24, 2024

RangeQuery根據範圍條件查詢表中的資料。對於Text類型欄位,只要Text類型欄位值分詞後的詞條中有詞條滿足範圍條件即可。

前提條件

參數

參數

說明

tableName

資料表名稱。

indexName

多元索引名稱。

offset

本次查詢的開始位置。

limit

本次查詢需要返回的最大數量。

如果只為了擷取行數,無需擷取具體資料,可以設定limit=0,即不返回任意一行資料。

queryType

設定查詢類型為TableStore.QueryType.RANGE_QUERY。

fieldName

要匹配的欄位。

rangeFrom

起始位置的值。

rangeTo

結束位置的值。

includeLower

結果中是否需要包括rangeFrom值,類型為Boolean。

includeUpper

結果中是否需要包括rangeTo值,類型為Boolean。

getTotalCount

是否返回匹配的總行數,預設為false,表示不返回。

返回匹配的總行數會影響查詢效能。

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)的資料,結果按照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, //包括下邊界(即大於等於1)。
                rangeTo: 10,
                includeUpper: false //不包括上邊界(即小於10)。
            }
        },
        getTotalCount: true //結果中的TotalCount可以表示表中資料的總行數,預設為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));
});

常見問題

常見問題

相關文檔