storage/mozIStorageAggregateFunction.idl
author Michael Kelly <mkelly@mozilla.com>
Tue, 05 Jun 2018 08:58:45 -0700
changeset 421822 e6d89c09bc10800ddc6a7f544da7809ad1105a56
parent 244595 ad01543457e739b4eee7a245e16734a3ecfd10ad
child 475219 020c8c871c0d3b3920fe95935cfef06501976c0f
permissions -rw-r--r--
Bug 1464521: Process collected browser JS errors during idle. r=kmag testFetchArguments and the add-on ID mangling tests already cover error collection end-to-end, so no new tests are needed to cover testing the idle callback. MozReview-Commit-ID: DJrqT5jCq44

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface mozIStorageConnection;
interface mozIStorageValueArray;
interface nsIArray;
interface nsIVariant;

/**
 * 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.
 */
[scriptable, uuid(763217b7-3123-11da-918d-000347412e16)]
interface mozIStorageAggregateFunction : nsISupports {
  /**
   * onStep is called when next value should be passed to
   * a custom function.
   * 
   * @param aFunctionArguments    The arguments passed in to the function
   */
  void onStep(in mozIStorageValueArray aFunctionArguments);

  /**
   * Called when all tuples in a group have been processed and the engine
   * needs the aggregate function's value.
   *
   * @returns aggregate result as Variant.
   */
  nsIVariant onFinal();
};