WindowProcessor implements Processor
FinalYes
Applies window functions over partitioned and ordered data.
Interfaces
- Processor
- Unlike a Transformer, receives the whole upstream generator, not one batch.
Properties
- $bound : BoundWindow|null
- $column : string|Definition
- $function : WindowFunction
Methods
- __construct() : mixed
- bind() : BoundStep<string|int, Processor>
- breaks() : bool
- True when process() needs every input row before it emits one: the processor ends its pipeline.
- describe() : null|Description
- fromDescription() : static
- process() : Generator<string|int, Rows>
- Process a stream of Rows and return a new stream.
Properties
$bound read-only
public
BoundWindow|null
$bound
= null
$column read-only
public
string|Definition
$column
$function read-only
public
WindowFunction
$function
Methods
__construct()
public
__construct(Definition<string|int, mixed>|string $column, WindowFunction $function[, BoundWindow|null $bound = null ]) : mixed
Parameters
- $column : Definition<string|int, mixed>|string
- $function : WindowFunction
- $bound : BoundWindow|null = null
bind()
public
bind(Schema $input) : BoundStep<string|int, Processor>
Parameters
- $input : Schema
Return values
BoundStep<string|int, Processor>breaks()
True when process() needs every input row before it emits one: the processor ends its pipeline.
public
breaks() : bool
Return values
booldescribe()
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
Tags
Return values
staticprocess()
Process a stream of Rows and return a new stream.
public
process(Generator $rows, Backend $backend) : Generator<string|int, Rows>
Parameters
- $rows : Generator
- $backend : Backend