GoogleSheetExtractor implements BatchableExtractor, Extractor, InfersSchema, MetadataColumnsExtractor, CorruptedRecordsRouter
FinalYes
Tags
Interfaces
- BatchableExtractor
- Extractor
- InfersSchema
- MetadataColumnsExtractor
- CorruptedRecordsRouter
Methods
- __construct() : mixed
- batchSize() : int<1, max>
- corruptedRecordsLoader() : Loader|null
- extract() : Generator<Signal|null, void>
- inferSchema() : static
- isRepeatable() : bool
- schema() : Schema
- statistics() : Statistics
- The grid's allocated rows bound the populated ones; they come from the sample schema inference already fetched, and without one nothing is declared - no request is made just for them. The Sheets API reports no byte size.
- withBatchSize() : static
- withCorruptedRecords() : static
- withEmptyToNull() : self
- withHeader() : self
- withMetadataColumns() : static
- withMissingColumnsAsNull() : self
- withOptions() : self
- withRowsPerPage() : self
- withSchema() : static
Methods
__construct()
public
__construct(Sheets $service, string $spreadsheetId, Columns $columnRange) : mixed
Parameters
- $service : Sheets
- $spreadsheetId : string
- $columnRange : Columns
batchSize()
public
batchSize() : int<1, max>
Return values
int<1, max>corruptedRecordsLoader()
public
corruptedRecordsLoader() : Loader|null
Return values
Loader|nullextract()
public
extract(Backend $backend, Criteria $criteria) : Generator<Signal|null, void>
Parameters
- $backend : Backend
- $criteria : Criteria
Return values
Generator<Signal|null, void>inferSchema()
public
inferSchema(SchemaInferenceBuilder $builder) : static
Parameters
- $builder : SchemaInferenceBuilder
Return values
staticisRepeatable()
public
isRepeatable() : bool
Return values
boolschema()
public
schema() : Schema
Return values
Schemastatistics()
The grid's allocated rows bound the populated ones; they come from the sample schema inference already fetched, and without one nothing is declared - no request is made just for them. The Sheets API reports no byte size.
public
statistics() : Statistics
Return values
StatisticswithBatchSize()
public
withBatchSize(int $batchSize) : static
Parameters
- $batchSize : int
Return values
staticwithCorruptedRecords()
public
withCorruptedRecords(Loader|null $loader) : static
Parameters
- $loader : Loader|null
Return values
staticwithEmptyToNull()
public
withEmptyToNull(bool $emptyToNull) : self
Parameters
- $emptyToNull : bool
Return values
selfwithHeader()
public
withHeader(bool $withHeader) : self
Parameters
- $withHeader : bool
Return values
selfwithMetadataColumns()
public
withMetadataColumns(bool $addMetadataColumns) : static
Parameters
- $addMetadataColumns : bool
Return values
staticwithMissingColumnsAsNull()
public
withMissingColumnsAsNull(bool $missingColumnsAsNull) : self
Parameters
- $missingColumnsAsNull : bool
Return values
selfwithOptions()
public
withOptions(GoogleSheetOptions $options) : self
Parameters
- $options : GoogleSheetOptions
Return values
selfwithRowsPerPage()
public
withRowsPerPage(int $rowsPerPage) : self
Parameters
- $rowsPerPage : int
Return values
selfwithSchema()
public
withSchema(Schema $schema) : static
Parameters
- $schema : Schema