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

Public 成员函数

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

额外继承的成员函数

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

详细描述

AbleCloud数据存储服务的批量删除工具。

构造及析构函数说明

◆ __construct()

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

构造函数。

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

成员函数说明

◆ andWhere()

ACStoreBatchDelete::andWhere (   $filter)

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

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

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

◆ clearWhere()

ACStoreBatchDelete::clearWhere ( )

清除删除条件。

返回
ACStoreBatchDelete 本ACStoreBatchDelete对象。

◆ execute()

ACStoreBatchDelete::execute ( )

执行删除操作。

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

◆ getClassName()

ACStoreBatchDelete::getClassName ( )

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

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

◆ orWhere()

ACStoreBatchDelete::orWhere (   $filter)

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

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

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

◆ where()

ACStoreBatchDelete::where (   $filter)

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

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

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