ArxAggregateInfo

Definition

Namespace

ARX.SDK.Query

Package

ARX.SDK

public class ArxAggregateInfo

Constructor

• ArxAggregateInfo()

  An empty aggregate: add columns with AddAggregateColumn and group-by columns with AddGroupByColumn.

Properties

• List<ArxAggregateColumn> AggregateColumns { get; set; }

  The aggregate columns: each has an alias (its name in the result), an attribute and an operator.

• List<string> GroupByColumns { get; set; }

  The columns the rows are grouped by. Each one is also returned in the result.

Methods

• void AddAggregateColumn(ArxAggregateColumn column)

  Adds an aggregate column (an alias, the attribute and the operator).

  Parameter	Type	Description
  column	ArxAggregateColumn	The aggregate: its alias, column and operator.

• void AddAggregateColumn(string aliasName, string attributeName, ArxAggregateOperator aggregateOperator)

  Adds an aggregate column: aliasName is the name the result holds the value under.

  Parameter	Type	Description
  aliasName	string	The attribute the result is read into, on each group's record.
  attributeName	string	The column to aggregate (alias.column for a link's); empty for a Count of rows.
  aggregateOperator	ArxAggregateOperator	The aggregate: Count, CountDistinct, Sum, Avg, Min, Max and the others.

• void AddGroupByColumn(string column)

  Groups the aggregates by this attribute.

  Parameter	Type	Description
  column	string	The column to group by (alias.column for a link's); each group's record carries it.

• void AddGroupByColumns(params string[] columns)

  Groups the aggregates by these attributes, in order.

  Parameter	Type	Description
  columns	params string[]	The columns to group by, in order (alias.column for a link's).

Usage

var query = new ArxQueryExpression("contact") { AggregateInfo = new ArxAggregateInfo() };

Read your own writes in an ARX transaction, scenario 2

Used in:

• Read your own writes in an ARX transactionRetrieve
• A report: accounts by industryRetrieveMultiple
• Link entities in depth: chains, branches, criteria per level, recursionRetrieveMultiple
• Read other row sources: a view in a schema, a summary view, a table with no idRetrieveMultiple