Flow PHP

DbalQueryExtractor implements BatchableExtractor, Extractor

FinalYes

batchSize() caps yields, not fetches: the whole result set materialises per parameter set.

Interfaces

BatchableExtractor
Extractor

Methods

__construct() : mixed
batchSize() : int<1, max>
extract() : Generator<Signal|null, void>
isRepeatable() : bool
schema() : Schema
single() : self
statistics() : Statistics: One plan per parameter set, summed; past EXPLAINED_PARAMETER_SETS the explained sets are scaled to all of them, so planning never pays a round trip per set.
withBatchSize() : static
withParameters() : self
withSchema() : static
withTypes() : self

__construct()


    public
                    __construct(Connection $connection, string $query) : mixed

Parameters

$connection : Connection
$query : string

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

schema()


    public
                    schema() : Schema

Return values

Schema

single()


    public
            static        single(Connection $connection, string $query[, array<string, mixed>|array<int, mixed> $parameters = [] ][, array<int<0, max>|string, ArrayParameterType|ParameterType|string|Type> $types = [] ]) : self

Parameters

$connection : Connection
$query : string
$parameters : array<string, mixed>|array<int, mixed> = []
$types : array<int<0, max>|string, ArrayParameterType|ParameterType|string|Type> = []

Return values

self

statistics()

One plan per parameter set, summed; past EXPLAINED_PARAMETER_SETS the explained sets are scaled to all of them, so planning never pays a round trip per set.


    public
                    statistics() : Statistics

Return values

Statistics

withBatchSize()


    public
                    withBatchSize(int $batchSize) : static

Parameters

$batchSize : int

Return values

static

withParameters()


    public
                    withParameters(ParametersSet $parametersSet) : self

Parameters

$parametersSet : ParametersSet

Return values

self

withSchema()


    public
                    withSchema(Schema $schema) : static

Parameters

$schema : Schema

Return values

static

withTypes()


    public
                    withTypes(array<int<0, max>|string, ArrayParameterType|ParameterType|string|Type> $types) : self

Parameters

$types : array<int<0, max>|string, ArrayParameterType|ParameterType|string|Type>

Return values

self