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

说明 关于使用过程中可能出现的错误信息,请参见错误码参考

前提条件

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

使用方法

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

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

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

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

  • 列条件:包括SingleColumnCondition和CompositeColumnCondition,是基于某一列或者某些列的列值进行条件判断。
    • SingleColumnCondition支持一列(可以是主键列)和一个常量比较。不支持两列或者两个常量相比较。
    • CompositeColumnCondition的内节点为逻辑运算,子条件可以是SingleColumnCondition或CompositeColumnCondition。

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

限制

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

参数

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

行存在性条件包括IGNORE、EXPECT_EXIST和EXPECT_NOT_EXIST,分别用RowExistenceExpectation_IGNORE、RowExistenceExpectation_EXPECT_EXIST、RowExistenceExpectation_EXPECT_NOT_EXIST表示。

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

关系运算符包括EQUAL(=)、NOT_EQUAL(!=)、GREATER_THAN(>)、GREATER_EQUAL(>=)、LESS_THAN(<)和LESS_EQUAL(<=),分别用CT_EQUAL、CT_NOT_EQUAL、CT_GREATER_THAN、CT_GREATER_EQUAL、CT_LESS_THAN、CT_LESS_EQUAL表示。

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

逻辑运算符包括NOT、AND和OR,分别用LO_NOT、LO_AND、LO_OR表示。

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

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

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

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

示例

根据指定主键更新一行,只有同时满足行存在和“age”列值为20条件时,才能更新成功,否则更新失败。

primary_key = [('gid',1), ('uid',"101")]
update_of_attribute_columns = {
    'PUT' : [('name','David'), ('address','Hongkong')],
    'DELETE' : [('address', None, 1488436949003)],
    'DELETE_ALL' : [('mobile'), ('age')],
    'INCREMENT' : [('counter', -1)]
}
row = Row(primary_key, update_of_attribute_columns)

# 指定Condition必须同时满足如下2个条件,才能更新成功,否则更新失败。
# (1)指定的行存在。
# (2)“age”列值为20。
condition = Condition(RowExistenceExpectation.EXPECT_EXIST, SingleColumnCondition("age", 20, ComparatorType.EQUAL)) # 只有当行存在时,更新该行。

consumed, return_row = client.update_row(table_name, row, condition)