.NET SDK使用過濾器返回符合條件資料行 - Tablestore

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

前提條件

已初始化Client。具體操作，請參見初始化OTSClient。
已建立資料表並寫入資料。具體操作，請參見建立資料表和寫入資料。

使用方法

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

過濾器目前包括RelationalCondition和CompositeCondition。

RelationalCondition：只判斷某個參考列的列值。
CompositeCondition：根據多個參考列的列值的判斷結果進行邏輯組合，決定是否過濾某行。

說明

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

限制

過濾器的條件支援關係運算（=、!=、>、>=、<、<=）和邏輯運算（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（<=）。
LogicOperator	過濾器中的邏輯運算子，類型詳情請參見LogicalOperator。邏輯運算子包括NOT、AND和OR。
PassIfMissing	當參考列在某行中不存在時，是否返回該行。類型為bool值，預設值為true，表示如果參考列在某行中不存在，則返回該行。當設定PassIfMissing為false時，如果參考列在某行中不存在，則不返回該行。
LatestVersionsOnly	當參考列存在多個版本的資料時，是否只使用最新版本的值做比較。類型為bool值，預設值為true，表示如果參考列存在多個版本的資料時，則只使用該列最新版本的值進行比較。當設定LatestVersionsOnly為false時，如果參考列存在多個版本的資料時，則會使用該列的所有版本的值進行比較，此時只要有一個版本的值滿足條件，就返回該行。

樣本

使用RelationalCondition過濾資料

以下樣本用於讀取資料表中資料，根據col0列的值過濾資料。

public void GetRowWithRelationalCondition(OTSClient otsClient)
{
    //定義行的主鍵，必須與建立表時的TableMeta中定義的一致。
    PrimaryKey primaryKey = new PrimaryKey
    {
        { "pk0", new ColumnValue(0) },
        { "pk1", new ColumnValue("abc") }
    };

    var rowQueryCriteria = new SingleRowQueryCriteria(TableName)
    {
        RowPrimaryKey = primaryKey
    };

    //只返回col0的值等於5的行。
    var filter = new RelationalCondition("col0",CompareOperator.EQUAL,new ColumnValue(5))
    {
        PassIfMissing = true
    };

    rowQueryCriteria.Filter = filter.ToFilter();
    rowQueryCriteria.AddColumnsToGet("col0");
    rowQueryCriteria.AddColumnsToGet("col1");

    GetRowRequest request = new GetRowRequest(rowQueryCriteria); 

    //查詢。
    GetRowResponse response = otsClient.GetRow(request);
    PrimaryKey primaryKeyRead = response.PrimaryKey;
    AttributeColumns attributesRead = response.Attribute;

    Console.WriteLine("Primary key read: ");
    foreach (KeyValuePair<string, ColumnValue> entry in primaryKeyRead)
    {
        Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
    }

    Console.WriteLine("Attributes read: ");
    foreach (KeyValuePair<string, ColumnValue> entry in attributesRead)
    {
        Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
    }

    Console.WriteLine("Get row with filter succeed.");
}

使用CompositeCondition過濾資料

以下樣本用於當滿足條件col0==0 OR col1=="ff" 時讀取資料表中資料。

public void GetRowWithCompositeCondition(OTSClient otsClient)
{
    //定義行的主鍵，必須與建立表時的TableMeta中定義的一致。
    PrimaryKey primaryKey = new PrimaryKey
    {
        { "pk0", new ColumnValue(0) },
        { "pk1", new ColumnValue("abc") }
    };

    var rowQueryCriteria = new SingleRowQueryCriteria(TableName)
    {
        RowPrimaryKey = primaryKey
        };

    //只返回col0的值等於5的行或者col1不等於ff的行。
    var filter1 = new RelationalCondition("col0",
                                          CompareOperator.EQUAL,
                                          new ColumnValue(5));

    var filter2 = new RelationalCondition("col1", CompareOperator.NOT_EQUAL, new ColumnValue("ff"));

    var filter = new CompositeCondition(LogicOperator.OR);
    filter.AddCondition(filter1);
    filter.AddCondition(filter2);

    rowQueryCriteria.Filter = filter.ToFilter();
    rowQueryCriteria.AddColumnsToGet("col0");
    rowQueryCriteria.AddColumnsToGet("col1");

    GetRowRequest request = new GetRowRequest(rowQueryCriteria); 

    //查詢。
    GetRowResponse response = otsClient.GetRow(request);
    PrimaryKey primaryKeyRead = response.PrimaryKey;
    AttributeColumns attributesRead = response.Attribute;

    Console.WriteLine("Primary key read: ");
    foreach (KeyValuePair<string, ColumnValue> entry in primaryKeyRead)
    {
        Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
    }

    Console.WriteLine("Attributes read: ");
    foreach (KeyValuePair<string, ColumnValue> entry in attributesRead)
    {
        Console.WriteLine(entry.Key + ":" + PrintColumnValue(entry.Value));
    }

    Console.WriteLine("Get row with filter succeed.");
}

Tablestore：過濾器

前提條件

使用方法

限制

參數

樣本

使用RelationalCondition過濾資料

使用CompositeCondition過濾資料

相關文檔