只有满足条件时,才能对数据表中的数据进行更新;当不满足条件时,更新失败并给用户报错。

前提条件

  • 已初始化OTSClient。具体操作,请参见初始化
  • 已创建数据表并写入数据。

使用方法

在通过PutRow、UpdateRow、DeleteRow或BatchWriteRow接口更新数据时,可以使用条件更新检查行存在性条件和列条件,只有满足条件时才能更新成功。

条件更新包括行存在性条件和列条件。

  • 行存在性条件:包括IGNORE、EXPECT_EXIST和EXPECT_NOT_EXIST,分别代表忽略、期望存在和期望不存在。

    对数据表进行更改操作时,系统会先检查行存在性条件,如果不满足行存在性条件,则更改失败并给用户报错。

  • 列条件:包括SingleColumnValueCondition和CompositeColumnValueCondition,是基于某一列或者某些列的列值进行条件判断。如果不满足列条件,则更改失败并给用户报错。
    • SingleColumnValueCondition支持一列和一个常量比较。不支持两列或者两个常量相比较。
    • CompositeColumnValueCondition的内节点为逻辑运算,子条件可以是SingleColumnValueCondition或CompositeColumnValueCondition。

条件更新可以实现乐观锁功能,即在更新某行时,先获取某列的值,假设为列A,值为1,然后设置条件列A=1,更新行使列A=2。如果更新失败,表示有其他客户端已成功更新该行。

限制

条件更新的列条件支持关系运算(=、!=、>、>=、<、<=)和逻辑运算(NOT、AND、OR),最多支持10个条件的组合。

参数

参数 说明
RowExistenceExpectation 对数据表进行更改操作时,系统会先检查行存在性条件,如果不满足行存在性条件,则更改失败并给用户报错。

行存在性条件包括IGNORE、EXPECT_EXIST和EXPECT_NOT_EXIST。

  • IGNORE:表示忽略,不做任何存在性检查。
  • EXPECT_EXIST:表示期望存在,如果该行存在,则满足条件;如果该行不存在,则不满足条件。
  • EXPECT_NOT_EXIST:期望行不存在,如果该行不存在,则满足条件;如果该行存在,则不满足条件。
ColumnName 列的名称。
ColumnValue 列的对比值。
CompareOperator 对列值进行比较的关系运算符。关于类型的更多信息,请参见ComparatorType

关系运算符包括EQUAL(=)、NOT_EQUAL(!=)、GREATER_THAN(>)、GREATER_EQUAL(>=)、LESS_THAN(<)和LESS_EQUAL(<=)。

LogicOperator 对多个条件进行组合的逻辑运算符。关于类型的更多信息,请参见LogicalOperator

逻辑运算符包括NOT、AND和OR。

逻辑运算符不同可以添加的子条件个数不同。
  • 当逻辑运算符为NOT时,只能添加一个子条件。
  • 当逻辑运算符为AND或OR时,必须至少添加两个子条件。
PassIfMissing 当列在某行中不存在时,条件检查是否通过。类型为bool值,默认值为true,表示如果列在某行中不存在时,则条件检查通过,该行满足更新条件。

当设置PassIfMissing为false时,如果列在某行中不存在时,则条件检查不通过,该行不满足更新条件。

LatestVersionsOnly 当列存在多个版本的数据时,是否只使用最新版本的值做比较。类型为bool值,默认值为true,表示如果列存在多个版本的数据时,则只使用该列最新版本的值进行比较。

当设置LatestVersionsOnly为false时,如果列存在多个版本的数据时,则会使用该列的所有版本的值进行比较,此时只要有一个版本的值满足条件,就条件检查通过,该行满足更新条件。

示例

使用列判断条件和乐观锁的示例代码如下:

  • 构造SingleColumnValueCondition。
     //设置条件为Col0==0。
     SingleColumnValueCondition singleColumnValueCondition = new SingleColumnValueCondition("Col0",
             SingleColumnValueCondition.CompareOperator.EQUAL, ColumnValue.fromLong(0));
     //如果不存在Col0列,条件检查不通过。
     singleColumnValueCondition.setPassIfMissing(false);
     //只判断最新版本。
     singleColumnValueCondition.setLatestVersionsOnly(true);
                        
  • 构造CompositeColumnValueCondition。
     //composite1的条件为(Col0 == 0) AND (Col1 > 100)。
     CompositeColumnValueCondition composite1 = new CompositeColumnValueCondition(CompositeColumnValueCondition.LogicOperator.AND);
     SingleColumnValueCondition single1 = new SingleColumnValueCondition("Col0",
             SingleColumnValueCondition.CompareOperator.EQUAL, ColumnValue.fromLong(0));
     SingleColumnValueCondition single2 = new SingleColumnValueCondition("Col1",
             SingleColumnValueCondition.CompareOperator.GREATER_THAN, ColumnValue.fromLong(100));
     composite1.addCondition(single1);
     composite1.addCondition(single2);
    
     //composite2的条件为( (Col0 == 0) AND (Col1 > 100) ) OR (Col2 <= 10)。
     CompositeColumnValueCondition composite2 = new CompositeColumnValueCondition(CompositeColumnValueCondition.LogicOperator.OR);
     SingleColumnValueCondition single3 = new SingleColumnValueCondition("Col2",
             SingleColumnValueCondition.CompareOperator.LESS_EQUAL, ColumnValue.fromLong(10));
     composite2.addCondition(composite1);
     composite2.addCondition(single3);     
                        
  • 通过Condition实现乐观锁机制,递增一列。
     private static void updateRowWithCondition(SyncClient client, String pkValue) {
         //构造主键。
         PrimaryKeyBuilder primaryKeyBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
         primaryKeyBuilder.addPrimaryKeyColumn(PRIMARY_KEY_NAME, PrimaryKeyValue.fromString(pkValue));
         PrimaryKey primaryKey = primaryKeyBuilder.build();
    
         //读取一行数据。
         SingleRowQueryCriteria criteria = new SingleRowQueryCriteria(TABLE_NAME, primaryKey);
         criteria.setMaxVersions(1);
         GetRowResponse getRowResponse = client.getRow(new GetRowRequest(criteria));
         Row row = getRowResponse.getRow();
         long col0Value = row.getLatestColumn("Col0").getValue().asLong();
    
         //条件更新Col0列,使列值加1。
         RowUpdateChange rowUpdateChange = new RowUpdateChange(TABLE_NAME, primaryKey);
         Condition condition = new Condition(RowExistenceExpectation.EXPECT_EXIST);
         ColumnCondition columnCondition = new SingleColumnValueCondition("Col0", SingleColumnValueCondition.CompareOperator.EQUAL, ColumnValue.fromLong(col0Value));
         condition.setColumnCondition(columnCondition);
         rowUpdateChange.setCondition(condition);
         rowUpdateChange.put(new Column("Col0", ColumnValue.fromLong(col0Value + 1)));
    
         try {
             client.updateRow(new UpdateRowRequest(rowUpdateChange));
         } catch (TableStoreException ex) {
             System.out.println(ex.toString());
         }
     }