Flow PHP

CSVExtractor implements BatchableExtractor, Extractor, FileExtractor, InfersSchema, LimitPushDown, MetadataColumnsExtractor, RewindableExtractor uses Batches, PushesLimit, FileReading

FinalYes

Interfaces

BatchableExtractor
Extractor
FileExtractor
InfersSchema
LimitPushDown
MetadataColumnsExtractor
RewindableExtractor

Methods

__construct()  : mixed
extract()  : Generator<Signal|null, void>
inferSchema()  : static
isRepeatable()  : bool
schema()  : Schema
source()  : Path
withBOMRemoval()  : self
withCharactersReadInLine()  : self
withEmptyToNull()  : self
withEnclosure()  : self
withEscape()  : self
withHeader()  : self
withSchema()  : static
withSeparator()  : self

Methods

__construct()

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

extract()

public extract(FlowContext $context) : Generator<Signal|null, void>
Parameters
$context : FlowContext
Return values
Generator<Signal|null, void>

inferSchema()

public inferSchema(SchemaInferenceBuilder $builder) : static
Parameters
$builder : SchemaInferenceBuilder
Return values
static

isRepeatable()

public isRepeatable() : bool
Return values
bool

withBOMRemoval()

public withBOMRemoval(bool $removeBOM) : self
Parameters
$removeBOM : bool
Return values
self

withCharactersReadInLine()

public withCharactersReadInLine(int $charactersReadInLine) : self
Parameters
$charactersReadInLine : int
  • bytes read per step from a remote stream (S3, Azure); never splits a line
Return values
self

withEmptyToNull()

public withEmptyToNull(bool $emptyToNull) : self
Parameters
$emptyToNull : bool
Return values
self

withEnclosure()

public withEnclosure(string $enclosure) : self
Parameters
$enclosure : string
Return values
self

withEscape()

public withEscape(string $escape) : self
Parameters
$escape : string
Return values
self

withHeader()

public withHeader(bool $withHeader) : self
Parameters
$withHeader : bool
Return values
self

withSchema()

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

withSeparator()

public withSeparator(string $separator) : self
Parameters
$separator : string
Return values
self
On this page

Search results