Public Member Functions

mozIStorageAggregateFunction Interface Reference

mozIStorageAggregateFunction represents aggregate SQL function. More...

import "mozIStorageAggregateFunction.idl";

List of all members.

Public Member Functions

void onStep (in mozIStorageValueArray aFunctionArguments)
 onStep is called when next value should be passed to a custom function.
nsIVariant onFinal ()
 Called when all tuples in a group have been processed and the engine needs the aggregate function's value.

Detailed Description

mozIStorageAggregateFunction represents aggregate SQL function.

Common examples of aggregate functions are SUM() and COUNT().

An aggregate function calculates one result for a given set of data, where a set of data is a group of tuples. There can be one group per request or many of them, if GROUP BY clause is used or not.


Member Function Documentation

nsIVariant mozIStorageAggregateFunction::onFinal (  ) 

Called when all tuples in a group have been processed and the engine needs the aggregate function's value.

Returns:
aggregate result as Variant.
void mozIStorageAggregateFunction::onStep ( in mozIStorageValueArray  aFunctionArguments  ) 

onStep is called when next value should be passed to a custom function.

Parameters:
aFunctionArguments The arguments passed in to the function

The documentation for this interface was generated from the following file: