在服務端對讀取結果再進行一次過濾,根據過濾器(Filter)中的條件決定返回的行。使用過濾器後,只返回合格資料行。
前提條件
使用方法
在通過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(<=)。 |
LogicOperator | 過濾器中的邏輯運算子,類型詳情請參見LogicalOperator。 邏輯運算子包括NOT、AND和OR。 |
passIfMissing | 當參考列在某行中不存在時,是否返回該行。類型為bool值,取值範圍如下:
|
latestVersionOnly | 當參考列存在多個版本的資料時,是否只使用最新版本的值做比較。類型為bool值。取值範圍如下:
|
樣本
使用SingleColumnValueFilter過濾資料
以下樣本用於讀取資料表中col1="Table Store"的資料。
function getRowWithCondition() {
//當col1=Table Store時,返回該行。當passIfMissing設定為true時,如果該列不存在,則返回該行;當passIfMissing設定為false時,如果該列不存在,則不返回該行。
var condition = new TableStore.SingleColumnCondition('col1', 'Table Store', TableStore.ComparatorType.EQUAL,true);
params.columnFilter = condition;
client.getRow(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
}
使用CompositeColumnValueFilter過濾資料
以下樣本用於讀取col1 = "Table Store"且col5 = 123456789時的資料。
function getRowWithCompositeCondition() {
//設定過濾器,當col1 = Table Store且col5 = 123456789時,返回該行。
var condition = new TableStore.CompositeCondition(TableStore.LogicalOperator.AND);
condition.addSubCondition(new TableStore.SingleColumnCondition('col1', 'Table Store', TableStore.ComparatorType.EQUAL));
condition.addSubCondition(new TableStore.SingleColumnCondition('col5', Long.fromNumber(123456789), TableStore.ComparatorType.EQUAL));
params.columnFilter = condition;
client.getRow(params, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', data);
});
}