Class: AggregateCall

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:23

Container for aggregate calls used in GroupBy.

Wraps a single aggregate function invocation, including its argument expressions and the optional pre-aggregation pipeline (postGroupOp) applied to each partition.

Implements

• PlanOperator

Constructors

Constructor

new AggregateCall(lang, args, impl, fieldName): AggregateCall

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:38

Parameters

Parameter	Type	Description
lang	Lowercase<string>	PlanOperator.lang
args	(Calculation | ASTIdentifier)[]	Argument expressions passed to the aggregate function.
impl	AggregateFn	Aggregate function implementation.
fieldName	ASTIdentifier	name of this aggregate in its GroupBy operator

Returns

AggregateCall

Properties

_postGSource

protected _postGSource: PlanTupleOperator

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:34

Backing store for postGroupSource.

---

args

args: (Calculation | ASTIdentifier)[]

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:42

Argument expressions passed to the aggregate function.

---

fieldName

fieldName: ASTIdentifier

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:46

name of this aggregate in its GroupBy operator

---

impl

impl: AggregateFn

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:44

Aggregate function implementation.

---

lang

lang: Lowercase<string>

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:40

PlanOperator.lang

Implementation of

PlanOperator.lang

---

parent

parent: PlanOperator

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:36

PlanOperator.parent

Implementation of

PlanOperator.parent

---

postGroupOp

postGroupOp: PlanTupleOperator

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:28

Before a partition is piped into the aggregate function, it will be passed through this operator.

Accessors

postGroupSource

Get Signature

get postGroupSource(): PlanTupleOperator

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:30

The leaf TupleSource at the bottom of postGroupOp; holds the partition rows.

Returns

PlanTupleOperator

Methods

accept()

accept<Ret, Arg>(visitors, arg?): Ret

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:58

PlanOperator.accept

Type Parameters

Type Parameter
Ret
Arg

Parameters

Parameter	Type
visitors	Record<string, PlanVisitor<Ret, Arg>>
arg?	Arg

Returns

Ret

Implementation of

PlanOperator.accept

---

clone()

clone(meta?): AggregateCall

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:84

Clone this FnCall

Parameters

Parameter	Type	Description
meta?	ArgMeta[]	provided by cloned Calculation, should be modified in-place to reflect new locations of arguments

Returns

AggregateCall

Implementation of

PlanOperator.clone

---

getChildren()

getChildren(): PlanOperator[]

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:75

PlanOperator.getChildren

Returns

PlanOperator[]

Implementation of

PlanOperator.getChildren

---

getDependencies()

getDependencies(): IdSet

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:114

PlanOperator.getDependencies

Returns

IdSet

Implementation of

PlanOperator.getDependencies

---

replaceChild()

replaceChild(current, replacement): void

Defined in: packages/core/src/plan/operators/item/aggregate-call.ts:65

PlanOperator.replaceChild

Parameters

Parameter	Type
current	PlanOperator
replacement	PlanOperator

Returns

void

Implementation of

PlanOperator.replaceChild