在服務端對讀取結果再進行一次過濾，根據過濾器（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.");
}