Flow PHP

Backend

Methods

add()  : Column
adopt()  : Column
The same values in this backend's storage: $column itself when this backend owns it, otherwise one copy through builder($definition)->appendTake(). For producers that build columns outside the configured backend.
allocatedBytes()  : int
Bytes this backend holds outside PHP's memory manager (invisible to memory_get_usage() and memory_limit).
builder()  : ColumnBuilder
compare()  : Column
constant()  : Column
$value is logical or raw and is cast once through the Definition exactly like ColumnBuilder::append().
decode()  : Column
Child node lengths and null counts are derived from the buffers, so only the top node travels.
decodeFrame()  : Rows
A Floe BATCH frame body as Rows under $schema. $codec decodes the buffers stored with a length prefix (a prefix of -1 is a raw buffer). The refusals are the frame's: truncated directory, counts other than the schema's, a column of another row count, a buffer outside the area, a column whose buffers the backend refuses.
encodeFrame()  : string
$rows as one Floe BATCH frame body: the directory, then every column's buffers in schema order, each stored raw (prefix -1) or through $codec with its raw length as prefix when that is shorter, 8-byte padded. The exact bytes decodeFrame() reads back.
groupedCounts()  : GroupedCounts
groupedTotals()  : GroupedTotals
groupTable()  : GroupTable
isNotNull()  : Column
isNull()  : Column
modulo()  : Column
multiply()  : Column
sort()  : Rows
subtract()  : Column

Methods

adopt()

The same values in this backend's storage: $column itself when this backend owns it, otherwise one copy through builder($definition)->appendTake(). For producers that build columns outside the configured backend.

public adopt(Definition<string|int, mixed> $definition, Column $column) : Column
Parameters
$definition : Definition<string|int, mixed>
$column : Column
Tags
throws
ColumnMismatchException

a null under NOT NULL on the copy path (an own column passes through unchecked; Rows::fromColumns checks NOT NULL)

Return values
Column

allocatedBytes()

Bytes this backend holds outside PHP's memory manager (invisible to memory_get_usage() and memory_limit).

public allocatedBytes() : int
Return values
int

compare()

public compare(Column $left, Operator $operator, Column $right, string $leftName, string $rightName) : Column
Parameters
$left : Column
$operator : Operator
$right : Column
$leftName : string
$rightName : string
Tags
throws
EvaluationException

a value that does not cast to the type the pair compares in, named by $leftName or $rightName

InvalidArgumentException

for Operator::DIFFERENT and Operator::SPACE_SHIP

Return values
Column

constant()

$value is logical or raw and is cast once through the Definition exactly like ColumnBuilder::append().

public constant(Definition<string|int, mixed> $definition, mixed $value, int $count) : Column
Parameters
$definition : Definition<string|int, mixed>
$value : mixed
$count : int
Return values
Column

decode()

Child node lengths and null counts are derived from the buffers, so only the top node travels.

public decode(Definition<string|int, mixed> $definition, array<int, string> $buffers, int $count, int $nullCount) : Column
Parameters
$definition : Definition<string|int, mixed>
$buffers : array<int, string>

the column's subtree buffers as Column::encode() produced them ('' = omitted validity)

$count : int
$nullCount : int
Return values
Column

decodeFrame()

A Floe BATCH frame body as Rows under $schema. $codec decodes the buffers stored with a length prefix (a prefix of -1 is a raw buffer). The refusals are the frame's: truncated directory, counts other than the schema's, a column of another row count, a buffer outside the area, a column whose buffers the backend refuses.

public decodeFrame(string $body, Schema $schema, Codec $codec) : Rows
Parameters
$body : string
$schema : Schema
$codec : Codec
Tags
throws
FloeException
Return values
Rows

encodeFrame()

$rows as one Floe BATCH frame body: the directory, then every column's buffers in schema order, each stored raw (prefix -1) or through $codec with its raw length as prefix when that is shorter, 8-byte padded. The exact bytes decodeFrame() reads back.

public encodeFrame(Rows $rows, Codec $codec) : string
Parameters
$rows : Rows
$codec : Codec
Tags
throws
OffsetOverflow

a column whose offsets do not fit the frame's u32 range

FrameTooLarge

a body past the 4 GiB frame length

Return values
string
On this page

Search results