AbleCloud PHP SDK
1.8.x
PHP SDK of AbleCloud API
|
Public 成员函数 | |
__construct ($name, $partitionKeyValues=NULL, $storeName='', $storeVersion=1, $context=NULL) | |
getName () | |
getVersion () | |
getContext () | |
getClassName () | |
select (... $columnNames) | |
clearSelection () | |
where ($complicatedFilter) | |
whereExt ($filter) | |
andWhere ($filter) | |
orWhere ($filter) | |
clearWhere () | |
addOrderBy ($columnName, $asc) | |
clearOrderBy () | |
groupBy (... $columnNames) | |
clearGroupBy () | |
offset ($number) | |
limit ($number) | |
clearOffsetAndLimit () | |
count () | |
sum ($columnName) | |
avg ($columnName) | |
max ($columnName) | |
min ($columnName) | |
clearAggregates () | |
execute () | |
setACStore ($serviceName, $serviceVersion, $acContext) | |
toScanParam () | |
![]() | |
__construct ($name, $version, $context) | |
getName () | |
getVersion () | |
getContext () | |
getLastError () | |
额外继承的成员函数 | |
![]() | |
resetLastError ($errCode=0, $errMessage='') | |
AbleCloud数据存储服务的查询工具。
ACStoreScanner::__construct | ( | $name, | |
$partitionKeyValues = NULL , |
|||
$storeName = '' , |
|||
$storeVersion = 1 , |
|||
$context = NULL |
|||
) |
构造函数。
$name | string 字符串。要被查询的数据集的名字。 |
$partitionKeyValues | array 以键值对的方式(如关联数组等)描述的查询数据集时所使用的分区键的值。如果数据集没有分区,则使用NULL。 |
$storeName | string 数据存储服务的名字。 |
$storeVersion | int 数据存储服务的版本。 |
$context | ACContext ACContext对象,表示访问该远程服务所依赖的环境信息。 |
ACStoreScanner::addOrderBy | ( | $columnName, | |
$asc | |||
) |
增加对查询结果进行排序的列及方式。
$columnName | 字符串,是用作排序的列的名字。如该名字与之前添加过的列重名,则以最后一次设置的排序方式为准。 |
$asc | 布尔值,为true时表示依据$columnName升序排序,否则表示以降序排序。 |
ACStoreScanner::andWhere | ( | $filter | ) |
以逻辑“与”的关系添加一个查询条件或条件的组合。
该方法应该在调用了ACStoreScanner::where方法或ACStoreScanner::whereExt之后再调用。
$filter | ACStoreFilter或ACStoreComplicatedFilter对象,表示新添加的查询条件或条件的组合。 如果是ACStoreFilter,那该条件将会被添加至已存在的第一个组合条件中;如果是组合条件,则组合条件将会跟已存在的组合条件并列组合起来。 |
ACStoreScanner::avg | ( | $columnName | ) |
添加聚集函数AVG()为查询结果列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。
$columnName | AVG()函数作用的目标数据列。 |
ACStoreScanner::clearAggregates | ( | ) |
清除Aggregate参数。
ACStoreScanner::clearGroupBy | ( | ) |
清除分组参数。
ACStoreScanner::clearOffsetAndLimit | ( | ) |
清除Offset及Limit参数。
ACStoreScanner::clearOrderBy | ( | ) |
清除排序条件。
ACStoreScanner::clearSelection | ( | ) |
清除要查询的目标列。
ACStoreScanner::clearWhere | ( | ) |
清除查询条件。
ACStoreScanner::count | ( | ) |
添加聚集函数COUNT()为查询结果列。
ACStoreScanner::execute | ( | ) |
执行查询,返回查询结果。
ACStoreScanner::getClassName | ( | ) |
取要查询的数据集的名字。
ACStoreScanner::getContext | ( | ) |
取访问该服务所依赖的环境信息。
ACStoreScanner::getName | ( | ) |
取服务的名字。
ACStoreScanner::getVersion | ( | ) |
取服务的主版本值。
ACStoreScanner::groupBy | ( | $columnNames | ) |
设置查询结果集的分组数据列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。
$columnNames | 字符串,是分组所依据的数据列的名字。 |
ACStoreScanner::limit | ( | $number | ) |
设置查询结果集的最大记录数。
$number | 非负整数,指定查询结果集中的最大记录数。其取值范围限制为闭区间[0, 1000]。如果为0(缺省值),其效果等于取值为1000。 |
ACStoreScanner::max | ( | $columnName | ) |
添加聚集函数MAX()为查询结果列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。
$columnName | MAX()函数作用的目标数据列。 |
ACStoreScanner::min | ( | $columnName | ) |
添加聚集函数MIN()为查询结果列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。
$columnName | MIN()函数作用的目标数据列。 |
ACStoreScanner::offset | ( | $number | ) |
设置置扫描的offset,默认为0。
$number | 非负整数。 |
ACStoreScanner::orWhere | ( | $filter | ) |
以逻辑“或”的关系添加一个查询条件或条件的组合。
该方法应该在调用了ACStoreScanner::where方法或ACStoreScanner::whereExt之后再调用。
$filter | ACStoreFilter或ACStoreComplicatedFilter对象,表示新添加的查询条件或条件的组合。 如果是ACStoreFilter,那该条件将会被添加至已存在的第一个组合条件中;如果是组合条件,则组合条件将会跟已存在的组合条件并列组合起来。 |
ACStoreScanner::select | ( | $columnNames | ) |
设置要被查询的数据列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。 该方法的调用方式,如查询单列:$scanner->select('deviceId');或查询多列:$scanner->select('deviceId', 'time', 'message')。
$columnNames | 字符串,表示要被查询的数据列的名字。 |
ACStoreScanner::setACStore | ( | $serviceName, | |
$serviceVersion, | |||
$acContext | |||
) |
设置访问ACStore服务的参数。
调用ACStoreScanner::execute之前需要调用本方法配置ACStore的访问信息。
$serviceName | 字符串,是ACStore服务的名字。 |
$serviceVersion | 整数,是ACStore服务的主版本号。 |
$acContext | ACContext对象,是访问ACStore服务的上下文环境。 |
ACStoreScanner::sum | ( | $columnName | ) |
添加聚集函数SUM()为查询结果列。该方法可被多次调用,每次调用指定的数据列将被添加至之前设置的集合中。
$columnName | SUM()函数作用的目标数据列。 |
ACStoreScanner::toScanParam | ( | ) |
将本对象转换为AbleCloud存储服务的scanParam结构。
ACStoreScanner::where | ( | $complicatedFilter | ) |
设置查询条件。该方法如果被多次调用,则后续调用传入的参数将覆盖之前设置的所有查询条件。
$complicatedFilter | ACStoreComplicatedFilter对象,表示查询的过滤条件。 |
ACStoreScanner::whereExt | ( | $filter | ) |
设置查询条件。该方法如果被多次调用,则后续调用传入的参数将覆盖之前设置的所有查询条件。
$filter | ACStoreFilter或ACStoreComplicatedFilter对象,表示查询条件。 如果是ACStoreFilter对象,将先生成一个组合条件,并将该对象放置在组合条件中,然后再设置为过滤条件。 |