過濾器 - Tablestore

前提條件

已初始化Client，詳情請參見初始化。
已建立資料表並寫入資料。

使用方法

在通過GetRow、BatchGetRow或GetRange介面查詢資料時，可以使用過濾器只返回合格資料行。

過濾器目前包括SingleColumnValueFilter、SingleColumnValueRegexFilter和CompositeColumnValueFilter。

SingleColumnValueFilter：只判斷某個參考列的列值。
SingleColumnValueRegexFilter：支援對類型為String的列值，使用Regex進行子字串匹配，然後根據實際將匹配到的子字串轉換為String、Integer或者Double類型，再對子值使用過濾器進行過濾。
CompositeColumnValueFilter：根據多個參考列的列值的判斷結果進行邏輯組合，決定是否過濾某行。

说明關於過濾器的更多資訊，請參見功能介紹中的過濾器。

限制

過濾器的條件支援關係運算（=、!=、>、>=、<、<=）和邏輯運算（NOT、AND、OR），最多支援10個條件的組合。
過濾器中的參考列必須在讀取的結果內。如果指定的要讀取的列中不包含參考列，則過濾器無法擷取參考列的值。
在GetRow、BatchGetRow和GetRange介面中使用過濾器不會改變介面的原生語義和限制項。
使用GetRange介面時，一次掃描資料的行數不能超過5000行或者資料大小不能超過4 MB。

當在該次掃描的5000行或者4 MB資料中沒有滿足過濾器條件的資料時，得到的Response中的Rows為空白，但是NextStartPrimaryKey可能不為空白，此時需要使用NextStartPrimaryKey繼續讀取資料，直到NextStartPrimaryKey為空白。

參數


參數	說明
ColumnName	過濾器中參考列的名稱。
ColumnValue	過濾器中參考列的對比值。
ComparatorType	過濾器中的關係運算子，類型詳情請參見ComparatorType。關係運算子包括EQUAL（=）、NOT_EQUAL（!=）、GREATER_THAN（>）、GREATER_EQUAL（>=）、LESS_THAN（<）和LESS_EQUAL（<=），分別用tablestore.CT_EQUAL、tablestore.CT_NOT_EQUAL、tablestore.CT_GREATER_THAN、tablestore.CT_GREATER_EQUAL、tablestore.CT_LESS_THAN、tablestore.CT_LESS_EQUAL表示。
LogicOperator	過濾器中的邏輯運算子，類型詳情請參見LogicalOperator。邏輯運算子包括NOT、AND和OR，分別用tablestore.LO_NOT、tablestore.LO_AND、tablestore.LO_OR表示。
FilterIfMissing	當參考列在某行中不存在時，是否返回該行。類型為bool值，預設值為true，表示如果參考列在某行中不存在，則返回該行。當設定FilterIfMissing為false時，如果參考列在某行中不存在，則不返回該行。
LatestVersionOnly	當參考列存在多個版本的資料時，是否只使用最新版本的值做比較。類型為bool值，預設值為true，表示如果參考列存在多個版本的資料時，則只使用該列最新版本的值進行比較。當設定LatestVersionsOnly為false時，如果參考列存在多個版本的資料時，則會使用該列的所有版本的值進行比較，此時只要有一個版本的值滿足條件，就返回該行。

樣本

構造SingleColumnValueFilter。

func GetRowWithFilter(client *tablestore.TableStoreClient, tableName string) {
    fmt.Println("begin to get row")
    pk := new(tablestore.PrimaryKey)
    pk.AddPrimaryKeyColumn("pk1", "pk1value1")
    pk.AddPrimaryKeyColumn("pk2", int64(2))
    pk.AddPrimaryKeyColumn("pk3", []byte("pk3"))

    //設定條件為c1 == "浙江"，FilterIfMissing = true。
    condition := tablestore.NewSingleColumnCondition("c1", tablestore.ComparatorType(tablestore.CT_EQUAL), "浙江")
    condition.FilterIfMissing = true

    criteria := &tablestore.SingleRowQueryCriteria{
        TableName:     tableName,
        PrimaryKey:    pk,
        MaxVersion:    1,
        Filter:        condition,
    }

    getResp, err := client.GetRow(&tablestore.GetRowRequest{SingleRowQueryCriteria: criteria})
    if err != nil {
        fmt.Println("getrow failed with error:", err)
    } else {
        colMap := getResp.GetColumnMap()
        fmt.Println("length is ", len(colMap.Columns))
        fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
    }
}

構造CompositeColumnValueFilter。

func GetRowWithCompositeColumnValueFilter(client *tablestore.TableStoreClient, tableName string) {
    fmt.Println("begin to get row")
    pk := new(tablestore.PrimaryKey)
    pk.AddPrimaryKeyColumn("pk1", "pk1value1")
    pk.AddPrimaryKeyColumn("pk2", int64(2))
    pk.AddPrimaryKeyColumn("pk3", []byte("pk3"))

    //設定條件為(c1 == "浙江") AND (c2 == "杭州")。
    filter := tablestore.NewCompositeColumnCondition(tablestore.LO_AND)
    filter1 := tablestore.NewSingleColumnCondition("c1", tablestore.CT_EQUAL, "浙江")
    filter2 := tablestore.NewSingleColumnCondition("c2", tablestore.CT_EQUAL, "杭州")
    filter.AddFilter(filter2)
    filter.AddFilter(filter1)

    criteria := &tablestore.SingleRowQueryCriteria{
        TableName:  tableName,
        PrimaryKey: pk,
        MaxVersion: 1,
        Filter:     filter,
    }

    getResp, err := client.GetRow(&tablestore.GetRowRequest{SingleRowQueryCriteria: criteria})
    if err != nil {
        fmt.Println("getrow failed with error:", err)
    } else {
        colMap := getResp.GetColumnMap()
        fmt.Println("length is ", len(colMap.Columns))
        fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
    }
}