FloeLoader implements Closure, Discardable, FileLoader, Loader
FinalYes
Interfaces
- Closure
- Loaders implementing this adapter will be additionally notified by the pipeline about the last set of Rows processed by the pipeline.
- Discardable
- Loaders implementing this adapter will be notified by the pipeline when a run ends without reaching its last set of Rows - it threw, or the caller walked away from the generator - and when their own closure() threw.
- FileLoader
- Loader
Methods
- __construct() : mixed
- closure() : void
- commit() : FileCommit|null
- The job commit of this write as $tasks tasks of run $run; null when the save mode does not admit the destination.
- describe() : null|Description
- destination() : Path
- discard() : void
- fromDescription() : static
- inTask() : static
- A new loader, every setting copied, writing as task $task of a job that commits it; this instance is untouched.
- load() : void
- partitionBy() : static
- partitioning() : Partitioning
- What partitionBy() set; Partitioning::none() by default.
- saveMode() : static
- withSchema() : static
Methods
__construct()
public
__construct(Path $path[, Metadata|null $metadata = null ][, Options $options = new Options() ][, Filesystem $filesystem = new NativeLocalFilesystem() ]) : mixed
Parameters
closure()
public
closure() : void
commit()
The job commit of this write as $tasks tasks of run $run; null when the save mode does not admit the destination.
public
commit(string $run, int $tasks) : FileCommit|null
Parameters
- $run : string
- $tasks : int
Return values
FileCommit|nulldescribe()
public
describe() : null|Description
Return values
null|Description —null when this instance cannot cross a process boundary (a live client, a custom collaborator)
destination()
public
destination() : Path
Return values
Pathdiscard()
public
discard() : void
fromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild
Return values
staticinTask()
A new loader, every setting copied, writing as task $task of a job that commits it; this instance is untouched.
public
inTask(Part $task) : static
Parameters
- $task : Part
Return values
staticload()
public
load(Rows $rows, Backend $backend) : void
Parameters
partitionBy()
public
partitionBy(Partitioning $partitioning) : static
Parameters
- $partitioning : Partitioning
Return values
staticpartitioning()
What partitionBy() set; Partitioning::none() by default.
public
partitioning() : Partitioning
Return values
PartitioningsaveMode()
public
saveMode(SaveMode $mode) : static
Parameters
- $mode : SaveMode
Return values
staticwithSchema()
public
withSchema(Schema $schema) : static
Parameters
- $schema : Schema