Flow PHP

TextExtractor implements BatchableExtractor, Extractor, FileExtractor, MetadataColumnsExtractor, SplittableExtractor

FinalYes

Interfaces

BatchableExtractor
Extractor
FileExtractor
MetadataColumnsExtractor
SplittableExtractor

Methods

__construct()  : 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>
One split per admitted file: line-delimited text is cut per file for now.
statistics()  : Statistics
withBatchSize()  : static
withMetadataColumns()  : static
withSchema()  : static

Methods

__construct()

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

batchSize()

public batchSize() : int<1, max>
Return values
int<1, max>

extract()

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

isRepeatable()

public isRepeatable() : bool
Return values
bool

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()

One split per admitted file: line-delimited text is cut per file for now.

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

statistics()

public statistics() : Statistics
Return values
Statistics

withBatchSize()

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

withMetadataColumns()

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

withSchema()

public withSchema(Schema $schema) : static
Parameters
$schema : Schema
Tags
throws
InvalidArgumentException

when $schema has no "text" column, the one the lines are read into

Return values
static
On this page

Search results