全部產品
Search
文件中心

Tablestore:過濾器

更新時間:Jun 30, 2024

在服務端對讀取結果再進行一次過濾,根據過濾器(Filter)中的條件決定返回的行。使用過濾器後,只返回合格資料行。

前提條件

  • 已初始化Client。具體操作,請參見初始化OTSClient

  • 已建立資料表並寫入資料。

使用方法

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

過濾器目前包括SingleColumnValueFilter和CompositeColumnValueFilter。

  • SingleColumnValueFilter:只判斷某個參考列的列值。

  • CompositeColumnValueFilter:根據多個參考列的列值的判斷結果進行邏輯組合,決定是否過濾某行。

說明

關於過濾器的更多資訊,請參見功能介紹中的過濾器

注意事項

  • 過濾器的條件支援關係運算(=、!=、>、>=、<、<=)和邏輯運算(NOT、AND、OR),最多支援10個條件的組合。

  • 過濾器中的參考列必須在讀取的結果內。如果指定的要讀取的列中不包含參考列,則過濾器無法擷取參考列的值。

  • 使用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_EQUALtablestore.CT_NOT_EQUALtablestore.CT_GREATER_THANtablestore.CT_GREATER_EQUALtablestore.CT_LESS_THANtablestore.CT_LESS_EQUAL表示。

LogicOperator

過濾器中的邏輯運算子,類型詳情請參見LogicalOperator

邏輯運算子包括NOT、AND和OR,分別用tablestore.LO_NOTtablestore.LO_ANDtablestore.LO_OR表示。

FilterIfMissing

當參考列在某行中不存在時,是否返回該行。類型為bool值。取值範圍如下:

  • false(預設):如果參考列在某行中不存在時,則返回該行。

  • true:如果參考列在某行中不存在時,則不返回該行。

LatestVersionOnly

當參考列存在多個版本的資料時,是否只使用最新版本的值做比較。類型為bool值。取值範圍如下:

  • true(預設):如果參考列存在多個版本的資料時,則只使用該列最新版本的值進行比較。

  • false:如果參考列存在多個版本的資料時,則會使用該列的所有版本的值進行比較,此時只要有一個版本的值滿足條件,就返回該行。

樣本

使用SingleColumnValueFilter過濾資料

以下樣本用於讀取資料表中的一行資料,設定讀取最新版本的資料,並根據c1列的值過濾資料。

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為false。
    condition := tablestore.NewSingleColumnCondition("c1", tablestore.ComparatorType(tablestore.CT_EQUAL), "浙江")
    condition.FilterIfMissing = false

    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()
        if len(colMap.Columns) > 0 {
            fmt.Println("length is ", len(colMap.Columns))
            fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
        } else {
            fmt.Println("No data that meets the conditions.")
        }
    }
}

使用CompositeColumnValueFilter過濾資料

以下樣本用於讀取資料表中的一行資料,當c1列值等於浙江且c2列值等於杭州時返回該行資料。

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列值等於浙江且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()
        if len(colMap.Columns) > 0 {
            fmt.Println("length is ", len(colMap.Columns))
            fmt.Println("get row col0 result is ", getResp.Columns[0].ColumnName, getResp.Columns[0].Value)
        } else {
            fmt.Println("No data that meets the conditions.")
        }
    }
}

相關文檔

  • 當某些應用需要使用不同屬性作為查詢條件來執行資料查詢時,您可以通過將這些屬性作為二級索引的主鍵列實現按照屬性快速查詢資料的需求。更多資訊,請參見二級索引

  • 當日常業務中有非主鍵列查詢、多列組合查詢、模糊查詢等多維查詢需求以及求最值、統計行數、資料分組等資料分析需求時,您可以將這些屬性作為多元索引中的欄位並使用多元索引查詢與分析資料。 更多資訊,請參見多元索引

  • 您還可以通過SQL查詢與分析表中資料。更多資訊,請參見查詢資料