全部產品
Search
文件中心

:巢狀型別查詢

更新時間:Oct 17, 2024

NestedQuery用於查詢巢狀型別欄位中子行的資料。巢狀型別不能直接查詢,需要通過NestedQuery封裝,NestedQuery中需要指定巢狀型別欄位的路徑和一個子查詢,其中子查詢可以是任意Query類型。

前提條件

參數

參數

說明

tableName

資料表名稱。

indexName

多元索引名稱。

path

路徑名,巢狀型別的列的樹狀路徑。例如news.title表示巢狀型別的news列中的title子列。

query

巢狀型別的列中子列上的查詢,子列上的查詢可以是任意Query類型。

scoreMode

當列存在多個值時基於哪個值計算分數。

InnerHits

巢狀型別欄位的子列的配置參數。包括如下配置項:

  • sort:Nested子行返回時的定序。

  • offset:當Nested列包含多個子行時,子行返回的起始位置。

  • limit:當Nested列包含多個子行時,返回子行的數量。預設值為3。

  • highlight:Nested子列高亮參數配置。具體參數配置說明請參見摘要與高亮

樣本

單層級巢狀型別查詢樣本

以下樣本用於查詢Col_Nested.Sub_Col_Keyword為"開心"的資料。其中Col_Nested為巢狀型別欄位,子行中包含Sub_Col_Keyword列。

/**
 * 嵌套資料樣本Col_Nested: '[{Sub_Col_Keyword: "開心"},{Sub_Col_Keyword: "晴天"}]'
 */
client.search({
    tableName: "<TABLE_NAME>",
    indexName: "<SEARCH_INDEX_NAME>",
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了擷取行數,無需擷取具體資料,可以設定limit=0,即不返回任意一行資料。
        query: { //設定查詢類型為TableStore.QueryType.NESTED_QUERY。
            queryType: TableStore.QueryType.NESTED_QUERY,
            query: {
                path: "Col_Nested",
                query: {
                    queryType: TableStore.QueryType.TERM_QUERY,
                    query: {
                        fieldName: "Col_Nested.Sub_Col_Keyword",
                        term: "開心"
                    }
                },
            }
        },
        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));
});

巢狀型別查詢使用查詢摘要與高亮樣本

以下樣本用於使用NestedQuery功能查詢表中Col_Nested巢狀型別欄位中Sub_Col_Text子列的值能夠匹配tablestore的資料,並在返回結果中對查詢詞進行高亮顯示。

client.search({
    tableName: "<TABLE_NAME>",
    indexName: "<SEARCH_INDEX_NAME>",
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了擷取行數,無需擷取具體資料,可以設定limit=0,即不返回任意一行資料。
        query: { //設定查詢類型為TableStore.QueryType.NESTED_QUERY。
            queryType: TableStore.QueryType.NESTED_QUERY,
            query: {
                path: "Col_Nested",
                query: {
                    queryType: TableStore.QueryType.MATCH_QUERY,
                    query: {
                        fieldName: "Col_Nested.Sub_Col_Text",
                        text: "tablestore"
                    }
                },
                innerHits: {
                    sort: {
                        sorters: [
                            {
                                scoreSort: {
                                    order: TableStore.SortOrder.SORT_ORDER_DESC
                                }
                            },
                            {
                                docSort: {
                                    order: TableStore.SortOrder.SORT_ORDER_ASC
                                }
                            },
                        ],
                    },
                    highlight: {
                        highlightParameters: [
                            {
                                fieldName:"Col_Nested.Sub_Col_Text",
                                preTag: "<b>",
                                postTag: "</b>",
                                fragmentsOrder: TableStore.HighlightFragmentOrder.TEXT_SEQUENCE,
                                fragmentSize: 20,
                                numberOfFragments: 3,
                            }
                        ]
                    }
                },
            }
        },
        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.rows, null, 2));

    printSearchHit(data.searchHits, "");
});

/**
 * 列印searchHit內容。
 * @param searchHits searchHits
 * @param prefix Nested結構輸出時,增加首碼以列印層次資訊。
 */
function printSearchHit(searchHits, prefix) {
    TableStore.util.arrayEach(searchHits, function (searchHit) {
        if (searchHit.highlightResultItem != null) {
            console.log(prefix + "Highlight: \n");
            var strBuilder = ""
            for  (const [key,val]  of searchHit.highlightResultItem.highlightFields.entries()) {
                strBuilder += key + ":[";
                strBuilder += val.fragments.join(",") + "]\n";
                console.log(strBuilder);
            }
        }
        for  (const [key,val]  of searchHit.searchInnerHits.entries()) {
            console.log(prefix + "Path: " + key + "\n");
            console.log(prefix + "InnerHit: \n");
            printSearchHit(val.subSearchHits, prefix + "    ");
        }
    });
}

常見問題

相關文檔