DbalKeySetExtractor implements BatchableExtractor, Extractor
FinalYes
Keyset pagination over a Doctrine DBAL query; the keys must be indexed, non-null and unique together, and the query must carry no ORDER BY, setMaxResults() or setFirstResult().
Interfaces
- BatchableExtractor
- Extractor
Methods
- __construct() : mixed
- batchSize() : int<1, max>
- extract() : Generator<Signal|null, void>
- isRepeatable() : bool
- schema() : Schema
- statistics() : Statistics
- withBatchSize() : static
- withKeyAliasSuffix() : self
- withMaximum() : $this
- Sets the maximum number of rows to fetch.
- withSchema() : $this
- Sets the schema for the extracted rows.
Methods
__construct()
public
__construct(Connection $connection, QueryBuilder $queryBuilder, KeySet $keySet) : mixed
Parameters
- $connection : Connection
- $queryBuilder : QueryBuilder
- $keySet : KeySet
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
boolschema()
public
schema() : Schema
Return values
Schemastatistics()
public
statistics() : Statistics
Return values
StatisticswithBatchSize()
public
withBatchSize(int $batchSize) : static
Parameters
- $batchSize : int
Return values
staticwithKeyAliasSuffix()
public
withKeyAliasSuffix(string $keyAliasSuffix) : self
Parameters
- $keyAliasSuffix : string
Return values
selfwithMaximum()
Sets the maximum number of rows to fetch.
public
withMaximum(int $maximum) : $this
Parameters
- $maximum : int
-
the maximum number of rows (must be > 0)
Tags
Return values
$thiswithSchema()
Sets the schema for the extracted rows.
public
withSchema(Schema $schema) : $this
Parameters
- $schema : Schema
-
the schema to apply to rows