Flow PHP

GroupBy implements Describable

Read onlyYes
FinalYes

Interfaces

Describable

Methods

__construct()  : mixed
aggregations()  : Aggregators
describe()  : null|Description
fromDescription()  : static
groupTable()  : GroupTable
isGlobal()  : bool
isPivot()  : bool
keyValues()  : array<string, array<int, mixed>>
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.
pivotedBy()  : Pivot|null
pivotSchema()  : Schema
readColumns()  : null|array<int, string>
refs()  : References
The columns rows are grouped by.
requiredInputColumns()  : RequiredColumns

Methods

describe()

public describe() : null|Description
Return values
null|Description —

null when this instance cannot cross a process boundary (a live client, a custom collaborator)

fromDescription()

public static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
$data : array<string|int, mixed>
$rebuild : Rebuild
Return values
static

isGlobal()

public isGlobal() : bool
Return values
bool

isPivot()

public isPivot() : bool
Return values
bool

keyValues()

public keyValues(Rows $rows, Schema $input, array<int, int> $rowsOfGroups) : array<string, array<int, mixed>>
Parameters
$rows : Rows
$input : Schema
$rowsOfGroups : array<int, int>
Return values
array<string, array<int, mixed>> —

the key values of those rows, by key column

outputSchema()

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
Schema

readColumns()

public readColumns() : null|array<int, string>
Return values
null|array<int, string> —

the columns the grouping and every aggregation read; null when an aggregation does not name the columns it reads

On this page

Search results