全部產品
Search
文件中心

:匹配查詢

更新時間:Jul 24, 2024

MatchQuery採用近似匹配的方式查詢表中的資料。Table Store會先對Text類型的列值和查詢關鍵詞按照設定好的分詞器做切分,然後按照切分好後的詞去查詢。對於使用模糊分詞的Text類型的列,建議使用MatchPhraseQuery實現高效能的模糊查詢。

前提條件

參數

參數

說明

tableName

資料表名稱。

indexName

多元索引名稱。

offset

本次查詢的開始位置。

limit

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

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

queryType

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

fieldName

要匹配的列。

匹配查詢可應用於Text類型。

text

查詢關鍵詞,即要匹配的值。

當要匹配的列為Text類型時,查詢關鍵詞會被切分成多個詞,分詞類型為建立多元索引時設定的分詞器類型。如果建立多元索引時未設定分詞器類型,則預設分詞類型為單字分詞。

例如當要匹配的列為Text類型時,分詞類型為單字分詞,則查詢詞為"this is",可以匹配到“...,this is tablestore”、“is this tablestore”、“tablestore is cool”、“this"、“is”等。

operator

邏輯運算子。預設為OR,表示當分詞後的多個詞只要有部分匹配時,則行資料滿足查詢條件。

如果設定operator為AND,則只有分詞後的所有詞都在列值中時,才表示行資料滿足查詢條件。

minimumShouldMatch

最小匹配個數。

只有當某一行資料的fieldName列的值中至少包括最小匹配個數的詞時,才會返回該行資料。

說明

minimumShouldMatch需要與邏輯運算子OR配合使用。

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_Keyword列的值能夠匹配"hangzhou"的資料。

/**
 * 查詢表中Col_Keyword列的值能夠匹配"hangzhou"的資料,返回匹配到的總行數和一些匹配成功的行。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只為了取行數,但不需要具體資料,可以設定limit=0,即不返回任意一行資料。
        query: { //設定查詢類型為MatchQuery。
            queryType: TableStore.QueryType.MATCH_QUERY,
            query: {
                fieldName: "Col_Keyword", //設定要匹配的列。
                text: "hangzhou" //設定要匹配的值。
            }
        },
        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));
});

常見問題

相關文檔