Joiner
FinalYes
Methods
- __construct() : mixed
- join() : Generator<string|int, Rows>
- keys() : null|JoinKeys
Methods
__construct()
public
__construct(Expression $expression, Join $type[, EntryFactory $entryFactory = new EntryFactory() ][, int<1, max> $batchSize = 1000 ]) : mixed
Parameters
- $expression : Expression
- $type : Join
- $entryFactory : EntryFactory = new EntryFactory()
- $batchSize : int<1, max> = 1000
-
- size of output batches emitted for unmatched right side rows
join()
public
join(Generator<string|int, Rows> $left, Generator<string|int, Rows> $right[, null|Row $nullLeftRow = null ][, null|Row $nullRightRow = null ][, bool $buildLeft = false ]) : Generator<string|int, Rows>
Parameters
- $left : Generator<string|int, Rows>
- $right : Generator<string|int, Rows>
- $nullLeftRow : null|Row = null
-
- pre-computed row used to null-pad unmatched right rows, collected from left rows when null
- $nullRightRow : null|Row = null
-
- pre-computed row used to null-pad unmatched left rows, collected from right rows when null
- $buildLeft : bool = false
-
- build the hash table from the left side and stream the right one, memory is then bounded by the left side
Tags
Return values
Generator<string|int, Rows>keys()
public
keys() : null|JoinKeys
Return values
null|JoinKeys —null when the join expression is not a conjunction of equalities