AbleCloud PHP SDK  1.8.x
PHP SDK of AbleCloud API
Public 成员函数 | 所有成员列表
ACStoreBatchUpdate类 参考
类 ACStoreBatchUpdate 继承关系图:
Inheritance graph
[图例]
ACStoreBatchUpdate 的协作图:
Collaboration graph
[图例]

Public 成员函数

 __construct ($name, $version, $context, $className, $partitionKeyValues=NULL)
 
 getClassName ()
 
 where ($filter)
 
 andWhere ($filter)
 
 orWhere ($filter)
 
 clearWhere ()
 
 set ($column, $value)
 
 inc ($column, $value)
 
 dec ($column, $value)
 
 clearColumns ()
 
 execute ()
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

- Protected 成员函数 继承自 ACService
 resetLastError ($errCode=0, $errMessage='')
 

详细描述

AbleCloud数据存储服务的批量更新工具。

构造及析构函数说明

◆ __construct()

ACStoreBatchUpdate::__construct (   $name,
  $version,
  $context,
  $className,
  $partitionKeyValues = NULL 
)

构造函数。

参数
$namestring 数据存储服务的名字。
$versionint 数据存储服务的版本。
$contextACContext ACContext对象,表示访问该远程服务所依赖的环境信息。
$classNamestring 字符串。要操作的数据集的名字。
$partitionKeyValuesarray 以键值对的方式(关联数组)描述的操作数据集时所使用的分区键的值。如果数据集没有分区,则使用NULL。

成员函数说明

◆ andWhere()

ACStoreBatchUpdate::andWhere (   $filter)

以逻辑“与”的关系添加一个更新条件或条件的组合。

该方法应该在调用了ACStoreBatchDelete::where方法之后再调用。

参数
$filterACStoreFilter | ACStoreComplicatedFilter ACStoreFilter或ACStoreComplicatedFilter对象,表示新添加的更新条件或条件的组合。如果是组合条件,则组合条件将会被括号组合在一起。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ clearColumns()

ACStoreBatchUpdate::clearColumns ( )

清除更新值。

返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ clearWhere()

ACStoreBatchUpdate::clearWhere ( )

清除更新条件。

返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ dec()

ACStoreBatchUpdate::dec (   $column,
  $value 
)

将某一列减去一个值。

参数
$columnstring 是列名。如果之前设置过该列,则之前设置的值会被覆盖。
$valuemixed 是值,其类型与列的类型要匹配。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ execute()

ACStoreBatchUpdate::execute ( )

执行更新操作。

返回
bool 返回TRUE或FALSE。返回FALSE表示有错误发生。此时可调用getLastError()方法获取错误消息。

◆ getClassName()

ACStoreBatchUpdate::getClassName ( )

取要操作的数据集的名字。

返回
string 要操作的数据集的名字。

◆ inc()

ACStoreBatchUpdate::inc (   $column,
  $value 
)

将某一列加上一个值。

参数
$columnstring 是列名。如果之前设置过该列,则之前设置的值会被覆盖。
$valuemixed 是值,其类型与列的类型要匹配。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ orWhere()

ACStoreBatchUpdate::orWhere (   $filter)

以逻辑“或”的关系添加一个更新条件或条件的组合。

该方法应该在调用了ACStoreBatchDelete::where方法之后再调用。

参数
$filterACStoreFilter | ACStoreComplicatedFilter ACStoreFilter或ACStoreComplicatedFilter对象,表示新添加的更新条件或条件的组合。如果是组合条件,则组合条件将会被括号组合在一起。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ set()

ACStoreBatchUpdate::set (   $column,
  $value 
)

将某一列设置为一个值。

参数
$columnstring 是列名。如果之前设置过该列,则之前设置的值会被覆盖。
$valuemixed 是值,其类型与列的类型要匹配。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

◆ where()

ACStoreBatchUpdate::where (   $filter)

设置更新条件。该方法如果被多次调用,则后续调用传入的参数将覆盖之前设置的所有删除条件。

参数
$filterACStoreFilter | ACStoreComplicatedFilter ACStoreFilter或ACStoreComplicatedFilter对象,表示删除条件。
返回
ACStoreBatchUpdate 本ACStoreBatchUpdate对象。

该类的文档由以下文件生成: