Flow PHP

ParquetExtractor implements BatchableExtractor, Extractor, FileExtractor, MetadataColumnsExtractor, SplittableExtractor

FinalYes

Interfaces

BatchableExtractor
Extractor
FileExtractor
MetadataColumnsExtractor
SplittableExtractor

Methods

__construct()  : mixed
__destruct()  : mixed
batchSize()  : int<1, max>
extract()  : Generator<Signal|null, void>
isRepeatable()  : bool
partitionSchema()  : Schema
partitionTypes()  : static
prunes()  : bool
reader()  : FileSplitReader
refresh()  : void
schema()  : Schema
source()  : Path
splits()  : array<int, FileSplit>
Byte windows over every admitted file; a row group belongs to the window holding its midpoint.
statistics()  : Statistics
unionByName()  : self
Reconcile every listed file's schema instead of trusting the first one.
withBatchSize()  : static
withByteOrder()  : self
withColumns()  : self
withEngine()  : self
withMetadataColumns()  : static
withOptions()  : self
withSchema()  : static

Methods

__construct()

public __construct(Path $path[, Filesystem $filesystem = new NativeLocalFilesystem() ]) : mixed
Parameters
$path : Path
$filesystem : Filesystem = new NativeLocalFilesystem()

extract()

public extract(Backend $backend, Criteria $criteria) : Generator<Signal|null, void>
Parameters
$backend : Backend
$criteria : Criteria
Return values
Generator<Signal|null, void>

partitionSchema()

public partitionSchema() : Schema
Return values
Schema

partitionTypes()

public partitionTypes(PartitionTypes $types) : static
Parameters
$types : PartitionTypes
Return values
static

prunes()

public prunes(ScalarFunction $conjunct) : bool
Parameters
$conjunct : ScalarFunction
Return values
bool

reader()

public reader() : FileSplitReader
Return values
FileSplitReader

splits()

Byte windows over every admitted file; a row group belongs to the window holding its midpoint.

public splits(Criteria $criteria, int $targetSplitBytes) : array<int, FileSplit>
Parameters
$criteria : Criteria
$targetSplitBytes : int
Return values
array<int, FileSplit>

unionByName()

Reconcile every listed file's schema instead of trusting the first one.

public unionByName([bool $union = true ]) : self
Parameters
$union : bool = true
Return values
self

withBatchSize()

public withBatchSize(int $batchSize) : static
Parameters
$batchSize : int
Return values
static

withByteOrder()

public withByteOrder(ByteOrder $byteOrder) : self
Parameters
$byteOrder : ByteOrder
Return values
self

withColumns()

public withColumns(array<string|int, string> $columns) : self
Parameters
$columns : array<string|int, string>
Return values
self

withEngine()

public withEngine(ParquetEngine|null $engine) : self
Parameters
$engine : ParquetEngine|null
Return values
self

withMetadataColumns()

public withMetadataColumns(bool $addMetadataColumns) : static
Parameters
$addMetadataColumns : bool
Return values
static

withOptions()

public withOptions(Options $options) : self
Parameters
$options : Options
Return values
self

withSchema()

public withSchema(Schema $schema) : static
Parameters
$schema : Schema
Return values
static
On this page

Search results