AggregationSpec

@webda/models

---

Interface: AggregationSpec<T, G, M>

Defined in: packages/models/src/aggregation.ts:36

Typed aggregation request

Type Parameters

T

T extends object

G

G extends readonly PropertyPaths<T>[]

M

M extends Record<string, MetricSpec<T>>

Properties

filter?

optional filter?: WebdaQLString<T>

Defined in: packages/models/src/aggregation.ts:44

WebdaQL filter, optionally with ? / :name placeholders; no ORDER BY / LIMIT / OFFSET

---

groupBy?

optional groupBy?: G

Defined in: packages/models/src/aggregation.ts:45

---

limit?

optional limit?: number

Defined in: packages/models/src/aggregation.ts:48

---

metrics

metrics: M

Defined in: packages/models/src/aggregation.ts:46

---

orderBy?

optional orderBy?: object[]

Defined in: packages/models/src/aggregation.ts:47

direction

direction: "ASC" | "DESC"

key

key: G[number] | Extract<keyof M, string>