0 follower

Final Class Yiisoft\Db\Query\BatchQueryResult

All Classes | Methods
InheritanceYiisoft\Db\Query\BatchQueryResult
ImplementsYiisoft\Db\Query\BatchQueryResultInterface

Represents the result of a batch query execution.

A batch query is a group of many SQL statements that are executed together as a single unit.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\Query\BatchQueryResult
batchSize() Yiisoft\Db\Query\BatchQueryResult
current() Yiisoft\Db\Query\BatchQueryResult
getBatchSize() Yiisoft\Db\Query\BatchQueryResult
getQuery() Yiisoft\Db\Query\BatchQueryResult
indexBy() Yiisoft\Db\Query\BatchQueryResult
key() Yiisoft\Db\Query\BatchQueryResult
next() Yiisoft\Db\Query\BatchQueryResult
resultCallback() Yiisoft\Db\Query\BatchQueryResult
rewind() Yiisoft\Db\Query\BatchQueryResult
valid() Yiisoft\Db\Query\BatchQueryResult

Method Details

Hide inherited methods

__construct() public method

public __construct( Yiisoft\Db\Query\QueryInterface $query ): mixed
$query Yiisoft\Db\Query\QueryInterface 

                public function __construct(private readonly QueryInterface $query) {}
batchSize() public method

public batchSize( integer $value ): Yiisoft\Db\Query\BatchQueryResult
$value integer 

                public function batchSize(int $value): static
{
    $this->batchSize = $value;
    return $this;
}
current() public method

public current( ): array

                public function current(): array
{
    if ($this->index === -1) {
        $this->next();
    }
    return $this->batch;
}
getBatchSize() public method

public getBatchSize( ): integer

                public function getBatchSize(): int
{
    return $this->batchSize;
}
getQuery() public method

public getQuery( ): Yiisoft\Db\Query\QueryInterface

                public function getQuery(): QueryInterface
{
    return $this->query;
}
indexBy() public method

public indexBy( Closure|string|null $indexBy ): Yiisoft\Db\Query\BatchQueryResult
$indexBy Closure|string|null 

                public function indexBy(Closure|string|null $indexBy): static
{
    $this->indexBy = $indexBy;
    return $this;
}
key() public method

public key( ): integer

                public function key(): int
{
    if ($this->index === -1) {
        $this->next();
    }
    return $this->index;
}
next() public method

public next( ): void

                public function next(): void
{
    $this->batch = $this->fetchData();
    ++$this->index;
}
resultCallback() public method

public resultCallback( Closure|null $callback ): Yiisoft\Db\Query\BatchQueryResult
$callback Closure|null 

                public function resultCallback(?Closure $callback): static
{
    $this->resultCallback = $callback;
    return $this;
}
rewind() public method

public rewind( ): void

                public function rewind(): void
{
    if ($this->index === 0) {
        return;
    }
    $this->dataReader = null;
    $this->batch = $this->fetchData();
    $this->index = 0;
}
valid() public method

public valid( ): boolean

                public function valid(): bool
{
    if ($this->index === -1) {
        $this->next();
    }
    return !empty($this->batch);
}