Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Entities

Overview

Aggregations are useful for collecting summary information across large sets of data, but in some cases you may wish to retrieve the names & ID's of those entities which matched each group or facet. In these cases the "Entities" aggregate function can be used.

Syntax

Plain form:

Code Block
languagenone
Entities

Form with a set limit of results per node (if no value supplied, it will default to 50):

Code Block
languagenone
Entities(20)

Form which will return any number of results:

Code Block
languagenone
Entities(Max)

Note: Be careful when using this option, it is not a good idea unless you absolutely need all the results, because results are not fetched in pages.

These queries may take a long time to execute when there is a large amount of data.

Examples

Group by the status of all entities in a particular project, displaying the entities matching each status:

Code Block
languagenone
GROUP BY Status { Entities } WHERE Project = 'Project X'

Here is the output of executing the above query:

Note: Nodes can be clicked on to view the associated record, and hovering over the node will show the Type, Name and ID of that node.