FileSplitReader implements Describable, Reader, CorruptedRecordsRouter
Read onlyYes
FinalYes
Interfaces
Methods
- __construct() : mixed
- corruptedRecordsLoader() : Loader|null
- describe() : null|Description
- extract() : Generator<null|Signal, void>
- The read of a source with every state resolved (schema, options, inference): the whole plan scan in-process, one split of it in a worker. A record that cannot become a row is yielded as its CorruptedRecordException.
- fromDescription() : static
- withCorruptedRecords() : static
- Corrupted records routed to $loader; null refuses them, the default.
Methods
__construct()
public
__construct(FileRead $read, FileBatches $batches[, Loader|null $corruptedRecordsLoader = null ]) : mixed
Parameters
- $read : FileRead
- $batches : FileBatches
- $corruptedRecordsLoader : Loader|null = null
corruptedRecordsLoader()
public
corruptedRecordsLoader() : Loader|null
Return values
Loader|nulldescribe()
public
describe() : null|Description
Return values
null|Description —null when this instance cannot cross a process boundary (a live client, a custom collaborator)
extract()
The read of a source with every state resolved (schema, options, inference): the whole plan scan in-process, one split of it in a worker. A record that cannot become a row is yielded as its CorruptedRecordException.
public
extract(Backend $backend, Criteria $criteria) : Generator<null|Signal, void>
Parameters
Return values
Generator<null|Signal, void>fromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild
Return values
staticwithCorruptedRecords()
Corrupted records routed to $loader; null refuses them, the default.
public
withCorruptedRecords(Loader|null $loader) : static
Parameters
- $loader : Loader|null