# Aggregations

## Overview

An Aggregation is a dynamic data provider that represents a database [Column](https://docs.servoy.com/guides/develop/application-design/data-modeling/databases/tables/columns) that is aggregated over a set of records, therefore it belongs to a [Table](https://docs.servoy.com/guides/develop/application-design/ui-components/grids/table).

Just like real database columns, calculations may be placed as fields on forms, used as data providers for different components, and requested programmatically.

## Get Started

To work with Aggregations you need to open the Table where you will add them using the [Table Editor](https://docs.servoy.com/reference/servoy-developer/object-editors/table-editor).

## Add an Aggregation

<figure><img src="https://3933488479-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjpWd52BKwABWxF2lScUK%2Fuploads%2Fgit-blob-f81749510920438c96be847e986b2fe0596123d9%2FGuide%20Aggregations%20-%20Add%20Aggregation.gif?alt=media" alt=""><figcaption><p>Add Aggregation</p></figcaption></figure>

1. In the Table Editor, select the Aggregations tab at the bottom after all the Columns
2. Select the solution where you want to add the Aggregation and click the Add button
3. Set the Name[^1] property with a valid name
4. Select the Type of the Aggregation, the available options are
   1. `Count`, the number of records in an entire [Foundset](https://docs.servoy.com/reference/servoycore/dev-api/database-manager/jsfoundset) containing a non-null value for a column
   2. `Count distinct`, same as `Count` but count unique values
   3. `Maximum`, the largest value for a numeric column in an entire foundset
   4. `Minimum`, the smallest value for a numeric column in an entire Foundset
   5. `Average`, the average value for a numeric column in an entire Foundset
   6. `Sum`, the sum of all the values for a numeric column in an entire Foundset
5. Select the Column that will be aggregated
6. Save the editor

{% hint style="info" %}
An aggregation is declared at the [Solution](https://docs.servoy.com/reference/servoycore/object-model/solution) level and is available throughout the solution in which it is declared. If it's declared in a [Module](https://docs.servoy.com/reference/servoy-developer/solution-explorer/all-solutions/active-solution/modules/module), it will be available in all solutions that include the module
{% endhint %}

## Edit an Aggregation

Similar to adding an Aggregation, open the Aggregations tab in the Table Editor, select the one you need to edit, and change any of the three properties: Name, Type, or Column then Save the editor

## Delete an Aggregation

Similar to editing an Aggregation, open the Table Editor, select the one you need to delete, and click on the button "Remove" at the bottom of the list (you will be prompted to confirm)

{% hint style="warning" %}
**Unresolved Data Bindings**\
When you edit the name of an Aggregation or delete it, you may also create errors in your application if you have objects bound to it, such as a field on a form. These errors can be resolved in Servoy Developer.
{% endhint %}

## Remarks

{% hint style="info" %}
The scope of an Aggregation is the entire Foundset using a SQL query which means that the result will consider only the records represented by the WHERE clause of the Foundset.

For example, an Aggregation could be applied to a related Foundset, `products_to_order_details.sum_quantity`, to return the total number of product units ordered.
{% endhint %}

{% hint style="warning" %}
Because Aggregations are derived from SQL queries, they may not reflect data changes in the client not yet committed to the database. Aggregations will refresh after outstanding changes are committed
{% endhint %}

{% hint style="warning" %}
SQL Aggregate Functions may be expensive operations, depending on the size and structure of a database table and the nature of the aggregation. Developers are encouraged to use discretion when working with aggregations. For example, when an aggregation is shown in a [Grid](https://docs.servoy.com/reference/servoyextensions/ui-components/grids), it may result in a query for each record displayed and performance may degrade.
{% endhint %}

[^1]: **Name**

    This is the name or **dataProviderID** of the calculation. Different from a column name, it can be mixed-case.

    Type: [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)\\

    Required: `true`