GroupBy
FinalYes
Methods
- __construct() : mixed
- aggregate() : void
- aggregatedRow() : Row
- aggregations() : Aggregators
- isGlobal() : bool
- isPivot() : bool
- keyValues() : GroupKey
- outputSchema() : Schema
- The aggregate operator's declared output schema, computed once per run. Group-key definitions come from the input schema unchanged: a key is null only when the input column was already nullable. A key the batch schema does not declare refuses at bind - inventing a column would put a value in row storage that no schema-driven reader can see.
- pivot() : void
- pivotedBy() : Pivot|null
- references() : array<int, Reference>
Methods
__construct()
public
__construct(string|Reference ...$entries) : mixed
Parameters
- $entries : string|Reference
aggregate()
public
aggregate(AggregatingFunction ...$aggregator) : void
Parameters
- $aggregator : AggregatingFunction
aggregatedRow()
public
aggregatedRow(GroupKey $key, Aggregators $aggregators, Schema $output) : Row
Parameters
- $key : GroupKey
- $aggregators : Aggregators
- $output : Schema
Return values
Rowaggregations()
public
aggregations() : Aggregators
Return values
AggregatorsisGlobal()
public
isGlobal() : bool
Return values
boolisPivot()
public
isPivot() : bool
Return values
boolkeyValues()
public
keyValues(Row $row, Schema $input) : GroupKey
Parameters
Return values
GroupKeyoutputSchema()
The aggregate operator's declared output schema, computed once per run. Group-key definitions come from the input schema unchanged: a key is null only when the input column was already nullable. A key the batch schema does not declare refuses at bind - inventing a column would put a value in row storage that no schema-driven reader can see.
public
outputSchema(Schema $input, Aggregators $bound) : Schema
Parameters
- $input : Schema
- $bound : Aggregators
Return values
Schemapivot()
public
pivot(Reference $ref, DeclaredPivotValues $values) : void
Parameters
- $ref : Reference
- $values : DeclaredPivotValues
pivotedBy()
public
pivotedBy() : Pivot|null
Return values
Pivot|nullreferences()
public
references() : array<int, Reference>