DomainAggregateSpec<TColumn, TGroup, TAlias>
Defined in: js-api/src/domains.ts:1186
Spec for domain table aggregate: a DomainReadScope (the rows aggregated —
search and deleted narrow it exactly as they narrow DomainQuerySpec) plus the
grouping.
Extends
DomainReadScope<TColumn>
Type Parameters
| Type Parameter | Default type |
|---|---|
TColumn extends string | string |
TGroup extends string | string |
TAlias extends string | string |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
deleted? | "exclude" | "include" | "only" | Soft-deleted rows: 'exclude' (the default — only live rows), 'include' (both) or 'only' (the trash). Anything but 'exclude' also projects ~is_deleted (DOMAIN_SERVICE_COLUMNS); a deleted row is read-only until DomainTableClient.restore brings it back. Needs DomainSupport.deleted. | DomainReadScope.deleted | js-api/src/domains.ts:1129 |
expand? | string[] | Master-FK expands ('<fk_column>'); groupBy/measures may then use '<fk>.<col>' (§13.2). | - | js-api/src/domains.ts:1198 |
filter? | DomainFilter<TColumn> | Smart-filter string (same grammar as entity search, e.g. barcode starts "P-1"), a single condition, or the canonical condition tree — values are bound server-side. Row caps: JSON query 10k, d42 queryDf 10M. | DomainReadScope.filter | js-api/src/domains.ts:1120 |
groupBy? | DomainColumnRef<TColumn> & TGroup[] | Column names to group by; omit for a single-row grand total. | - | js-api/src/domains.ts:1190 |
limit? | number | The group-row cap. | - | js-api/src/domains.ts:1196 |
measures | DomainAggregateMeasure<TColumn, TAlias>[] | The measures computed per group. | - | js-api/src/domains.ts:1192 |
search? | string | Case-insensitive substring over the table's searchable columns — those declared searchable: true, else the name column (DomainTableInfo.searchableColumns); a table with neither rejects with a filter error. ANDed with filter. | DomainReadScope.search | js-api/src/domains.ts:1124 |
sort? | string | Comma-separated output names (group columns or measure aliases); ! prefix for descending. | - | js-api/src/domains.ts:1194 |