Flow PHP

JsonFileBatches implements FileBatches

Read onlyYes
FinalYes

Interfaces

FileBatches

Methods

__construct()  : mixed
batches()  : Generator<mixed, void>
close()  : void
describe()  : Description|null
fromDescription()  : static
open()  : JsonOpenSource

Methods

__construct()

public __construct(Filesystem $filesystem, JsonFileReader $reader[, null|FlowPhpExtension $extension = null ][, SchemaInference|null $inference = null ]) : mixed
Parameters
$filesystem : Filesystem
$reader : JsonFileReader
$extension : null|FlowPhpExtension = null

the flow_php extension the Rust source needs; null detects it, never described

$inference : SchemaInference|null = null

batches()

public batches(FileRead $read, Criteria $criteria, SourceFile $source, Schema $body, Backend $backend, ReadWindow $window) : Generator<mixed, void>
Parameters
$read : FileRead
$criteria : Criteria
$source : SourceFile
$body : Schema
$backend : Backend
$window : ReadWindow
Return values
Generator<mixed, void>

describe()

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

fromDescription()

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

open()

public open(SourceFile $source[, null|FileSplit $split = null ]) : JsonOpenSource
Parameters
$source : SourceFile
$split : null|FileSplit = null

the byte window of the one file this read covers; null reads the whole file

Return values
JsonOpenSource
On this page

Search results