只有当数据满足列判断条件时,才能对数据表中的数据进行更新;当数据不满足列判断条件时,数据更新失败。
前提条件
已初始化Client,具体操作,请参见初始化OTSClient。
使用方法
在通过PutRow、UpdateRow、DeleteRow和BatchWriteRow接口操作表中数据时,可以使用条件更新检查行存在性条件和列条件,只有满足条件时才能成功更新。
条件更新包括行存在性条件和列条件。
行存在性条件:包括IGNORE、EXPECT_EXIST和EXPECT_NOT_EXIST,分别代表忽略、期望存在和期望不存在。
对数据表进行更改操作时,系统会先检查行存在性条件,如果不满足行存在性条件,则更改失败并给用户报错。
列条件:包括RelationalCondition和CompositeCondition,是基于某一列或者某些列的列值进行条件判断。
列条件中支持使用关系运算(=、!=、>、>=、<、<=)和逻辑运算(NOT、AND、OR),单个更新条件中最多支持设置10个列条件。
RelationalCondition支持一列(可以是主键列)和一个常量比较。不支持两列或者两个常量相比较。
CompositeCondition的内节点为逻辑运算,子条件可以是RelationalCondition或CompositeCondition。
条件更新可以实现乐观锁功能,即在更新某行时,先获取某列的值,假设为列A,值为1,然后设置条件列A=1,更新行使列A=2。如果更新失败,表示有其他客户端已成功更新该行。
参数
参数 | 说明 |
RowExistenceExpectation | 对数据表进行更改操作时,系统会先检查行存在性条件,如果不满足行存在性条件,则更改失败并给用户报错。 行存在性条件包括IGNORE、EXPECT_EXIST和EXPECT_NOT_EXIST。
|
ColumnName | 列的名称。 |
ColumnValue | 列的对比值。 |
Operator | 对列值进行比较的关系运算符,类型详情请参见ComparatorType。 关系运算符包括EQUAL(=)、NOT_EQUAL(!=)、GREATER_THAN(>)、GREATER_THAN(>=)、LESS_THAN(<)和LESS_EQUAL(<=)。 |
LogicOperator | 对多个条件进行组合的逻辑运算符,类型详情请参见LogicalOperator。 逻辑运算符包括NOT、AND和OR。 逻辑运算符不同可以添加的子条件个数不同。
|
PassIfMissing | 当列在某行中不存在时,条件检查是否通过。类型为bool值,默认值为true,表示如果列在某行中不存在时,则条件检查通过,该行满足更新条件。 当设置PassIfMissing为false时,如果列在某行中不存在时,则条件检查不通过,该行不满足更新条件。 |
LatestVersionsOnly | 当列存在多个版本的数据时,是否只使用最新版本的值做比较。类型为bool值,默认值为true,表示如果列存在多个版本的数据时,则只使用该列最新版本的值进行比较。 当设置LatestVersionsOnly为false时,如果列存在多个版本的数据时,则会使用该列的所有版本的值进行比较,此时只要有一个版本的值满足条件,就条件检查通过,该行满足更新条件。 |
示例
以下示例用于更新满足指定条件的数据。当col0列的值不等于5时更新数据成功,当col0列的值等于5时更新数据失败。
//定义行的主键,必须与创建表时的TableMeta中定义的一致。
PrimaryKey primaryKey = new PrimaryKey();
primaryKey.Add("pk0", new ColumnValue(0));
primaryKey.Add("pk1", new ColumnValue("abc"));
//定义行的属性列。
AttributeColumns attribute = new AttributeColumns();
attribute.Add("col0", new ColumnValue(0));
attribute.Add("col1", new ColumnValue("a"));
attribute.Add("col2", new ColumnValue(true));
PutRowRequest request = new PutRowRequest(tableName, new Condition(RowExistenceExpectation.IGNORE), primaryKey, attribute);
//不带condition时putrow,预期更新成功。
try
{
otsClient.PutRow(request);
Console.WriteLine("Put row succeeded.");
} catch (Exception ex)
{
Console.WriteLine("Put row failed. error:{0}", ex.Message);
}
//当col0列的值不等于5,将再次putrow,覆盖原有值,预期更新成功。
try
{
request.Condition.ColumnCondition = new RelationalCondition("col0",
CompareOperator.NOT_EQUAL,
new ColumnValue(5));
otsClient.PutRow(request);
Console.WriteLine("Put row succeeded.");
} catch (Exception ex)
{
Console.WriteLine("Put row failed. error:{0}", ex.Message);
}
//当col0列的值等于5,将再次putrow,覆盖原有值,预期更新失败。
try
{
//新增col0列的值等于5条件。
request.Condition.ColumnCondition = new RelationalCondition("col0",
CompareOperator.EQUAL,
new ColumnValue(5));
otsClient.PutRow(request);
Console.WriteLine("Put row succeeded.");
}
catch (OTSServerException)
{
//由于条件不满足,抛出OTSServerException。
Console.WriteLine("Put row failed because condition check failed. but expected");
}
catch (Exception ex)
{
Console.WriteLine("Put row failed. error:{0}", ex.Message);
}