Flow PHP

Footer

Read onlyYes
FinalYes

Properties

$metadata  : Metadata
$partitions  : array<string|int, mixed>
$schema  : array<string|int, mixed>
$sections  : array<string|int, mixed>
$totalRows  : int
$version  : int
$writer  : string

Methods

__construct()  : mixed
filePartitions()  : array<int, Partition>
The single combination of a single-combination file, in the order it was written (the PARTITIONS frame / table entry preserves it). A zero-section value keeps only its combination in the table, so it is recovered from the last non-empty table entry.
fromArray()  : self
fromJson()  : self
normalize()  : array{version: int, writer: string, schema: array>, sections: array, partitions: array>, totalRows: int, metadata: array}
partitionsFor()  : array<string, string>
reconstructRows()  : Rows
Rebuilds Rows from already-decoded (un-partitioned) rows, reattaching the file's single partition combination in its original order.
schema()  : Schema
schemaBody()  : string
toJson()  : string

Properties

$partitions

public array<string|int, mixed> $partitions

$schema

public array<string|int, mixed> $schema

$sections

public array<string|int, mixed> $sections

$totalRows

public int $totalRows

Methods

__construct()

public __construct(int $version, string $writer, array<int, array<string, mixed>> $schema, array<int, Section$sections, array<int, array<string, string>> $partitions, int $totalRows, Metadata $metadata) : mixed
Parameters
$version : int
$writer : string
$schema : array<int, array<string, mixed>>

normalized file schema (a file carries exactly one)

$sections : array<int, Section>
$partitions : array<int, array<string, string>>

deduped PARTITIONS frame combinations, index = partitionsId

$totalRows : int
$metadata : Metadata

filePartitions()

The single combination of a single-combination file, in the order it was written (the PARTITIONS frame / table entry preserves it). A zero-section value keeps only its combination in the table, so it is recovered from the last non-empty table entry.

public filePartitions() : array<int, Partition>
Tags
throws
FloeException
Return values
array<int, Partition>

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Tags
throws
FloeException
Return values
self

fromJson()

public static fromJson(string $json) : self
Parameters
$json : string
Tags
throws
FloeException
Return values
self

normalize()

public normalize() : array{version: int, writer: string, schema: array>, sections: array, partitions: array>, totalRows: int, metadata: array}
Return values
array{version: int, writer: string, schema: array>, sections: array, partitions: array>, totalRows: int, metadata: array}

partitionsFor()

public partitionsFor(int $partitionsId) : array<string, string>
Parameters
$partitionsId : int
Tags
throws
FloeException
Return values
array<string, string>

reconstructRows()

Rebuilds Rows from already-decoded (un-partitioned) rows, reattaching the file's single partition combination in its original order.

public reconstructRows(array<int, Row$rows) : Rows
Parameters
$rows : array<int, Row>
Tags
throws
FloeException
Return values
Rows

schemaBody()

public schemaBody() : string
Return values
string

toJson()

public toJson() : string
Tags
throws
JsonException
Return values
string
On this page

Search results