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

Public 成员函数

 __construct ($name, $version, $context)
 
 createClass ($classDef)
 
 listClasses ()
 
 dropClass ($name)
 
 clearClass ($name)
 
 create ($name, $row)
 
 delete ($name, $row)
 
 update ($name, $row)
 
 find ($name, $primaryKeyValues, $select=NULL)
 
 scan ($scanner)
 
 scanExt ($name, $partitionKeyValues=NULL)
 
 batchDelete ($name, $partitionKeyValues=NULL)
 
 batchUpdate ($name, $partitionKeyValues=NULL)
 
 modify ($name)
 
- Public 成员函数 继承自 ACService
 __construct ($name, $version, $context)
 
 getName ()
 
 getVersion ()
 
 getContext ()
 
 getLastError ()
 

额外继承的成员函数

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

详细描述

AbleCloud数据存储服务。

构造及析构函数说明

◆ __construct()

ACStore::__construct (   $name,
  $version,
  $context 
)

构造函数。

参数
$namestring 数据存储服务的名字。
$versionint 数据存储服务的版本。
$contextACContext ACContext对象,表示访问该远程服务所依赖的环境信息。

成员函数说明

◆ batchDelete()

ACStore::batchDelete (   $name,
  $partitionKeyValues = NULL 
)

批量删除数据。

参数
$namestring 字符串。要被操作的数据集的名字。
$partitionKeyValuesarray 以键值对的方式(关联数组)描述的操作数据集时所使用的分区键的值。如果数据集没有分区,则使用NULL。
返回
ACStoreBatchDelete 返回一个ACStoreBatchDelete对象,以便于设置删除参数,执行操作。

◆ batchUpdate()

ACStore::batchUpdate (   $name,
  $partitionKeyValues = NULL 
)

批量更新数据。

参数
$namestring 字符串。要被操作的数据集的名字。
$partitionKeyValuesarray 以键值对的方式(关联数组)描述的操作数据集时所使用的分区键的值。如果数据集没有分区,则使用NULL。
返回
ACStoreBatchUpdate 返回一个ACStoreBatchUpdate对象,以便于设置更新参数,执行操作。

◆ clearClass()

ACStore::clearClass (   $name)

清除指定数据集中的数据。仅测试环境支持该方法。

参数
$namestring 要清除其数据的数据集的名字。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ create()

ACStore::create (   $name,
  $row 
)

在数据集中添加一条数据记录。

参数
$namestring 要添加数据的数据集的名字。
$rowarray 以键值对的方式(关联数组)描述的要添加的数据记录。其中,至少应包含所有主键的值。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ createClass()

ACStore::createClass (   $classDef)

创建数据集。仅测试环境支持该方法。

参数
$classDefACStoreClass ACStoreClass对象,表示数据集的定义。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ delete()

ACStore::delete (   $name,
  $row 
)

从数据集中删除指定的记录。

参数
$namestring 要删除数据的数据集的名字。
$rowarray 以键值对的方式(关联数组)描述的要被删除的记录。$row参数应指定所有主键的值,删除操作将删除主键值与$row匹配的记录。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ dropClass()

ACStore::dropClass (   $name)

删除指定的数据集。仅测试环境支持该方法。

参数
$namestring 字符串,表示要被删除的数据集的名字。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

◆ find()

ACStore::find (   $name,
  $primaryKeyValues,
  $select = NULL 
)

查询指定的记录。

参数
$namestring 要查询的数据集的名字。
$primaryKeyValuesarray 以键值对方式(如关联数组等)描述的要查询的记录的主键值。
$selectarray 字符串数组,记录了查询结果中应显示的数据列的集合。可选。如为NULL,则表示要查询所有数据列。
返回
array 操作成功时返回一个关联数组,记录查询结果。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ listClasses()

ACStore::listClasses ( )

查询已创建的数据集。

返回
array 返回ACStoreClass数组,表示已定义的数据集。操作失败时返回NULL,并且可调用getLastError()方法获取错误消息。

◆ modify()

ACStore::modify (   $name)

更新单条记录。

参数
$namestring 字符串,是要被操作的数据集的名字。
返回
ACStoreModify 返回一个ACStoreModify对象,以便于设置更新参数,执行操作。

◆ scan()

ACStore::scan (   $scanner)

查询分区内的数据。兼容v1.3.x之前的版本。

参数
$scannerACStoreScanner ACStoreScanner对象,表示查询条件。
返回
ACStoreIterator 返回一个ACStoreIterator对象,用于遍历查询结果集合中的数据。返回NULL时表示操作失败,此时可调用getLastError()方法获取错误消息。

◆ scanExt()

ACStore::scanExt (   $name,
  $partitionKeyValues = NULL 
)

查询数据。

参数
$namestring 字符串。要被查询的数据集的名字。
$partitionKeyValuesarray 以键值对的方式(如关联数组等)描述的查询数据集时所使用的分区键的值。如果数据集没有分区,则使用NULL。
返回
ACStoreScanner 返回一个ACStoreScanner对象,以便于设置查询参数,执行查询,获取查询结果。

◆ update()

ACStore::update (   $name,
  $row 
)

更新数据集中指定的记录。

参数
$namestring 要更新的数据所属的数据集的名字。
$rowarray 以键值对的方式(关联数组)描述的要被更新的记录,以及更新后的值。$row参数应指定所有主键的值,用于定位要被更新的记录;$row中记录的其它列的值用于更新该记录:只更新原数据记录中已经存在的字段。如果主键指定的记录不存在,本方法将会在数据集中新建一条对应的记录。
返回
bool 操作成功返回TRUE;否则返回FALSE,并且可调用getLastError()方法获取错误消息。

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