Spec-Zone.ru › Laravel 9

DatabaseBatchRepository

class DatabaseBatchRepository implements PrunableBatchRepository (View source)

Свойства

protected BatchFactory $factory

Экземпляр фабрики задач.

protected Connection $connection

Экземпляр подключения к базе данных.

protected string $table

Таблица базы данных для хранения информации о задачах.

Методы

__construct(BatchFactory $factory, Connection $connection, string $table)

Создать новый экземпляр хранилища партий.

Batch[] get(int $limit = 50, mixed $before = null)

Получить список партий.

Batch|null find(string $batchId)

Получить информацию о существующей партии.

Batch store(PendingBatch $batch)

Сохранить новую ожидающую партию.

void incrementTotalJobs(string $batchId, int $amount)

Увеличить общее количество задач в партии.

UpdatedBatchJobCounts decrementPendingJobs(string $batchId, string $jobId)

Уменьшить общее количество ожидающих задач для партии.

UpdatedBatchJobCounts incrementFailedJobs(string $batchId, string $jobId)

Увеличить общее количество завершившихся с ошибкой задач для партии.

int|null updateAtomicValues(string $batchId, Closure $callback)

Обновить атомарное значение в партии.

void markAsFinished(string $batchId)

Отметить партию с заданным идентификатором как завершённую.

void cancel(string $batchId)

Отменить партию с заданным идентификатором.

void delete(string $batchId)

Удалить партию с заданным идентификатором.

int prune(DateTimeInterface $before)

Очистить все записи, которые старше заданной даты.

int pruneUnfinished(DateTimeInterface $before)

Очистить все незавершенные записи, которые старше заданной даты.

int pruneCancelled(DateTimeInterface $before)

Очистить все отменённые записи, которые старше заданной даты.

mixed transaction(Closure $callback)

Выполнить предоставленный Closure в рамках транзакции, специфичной для хранилища.

string serialize(mixed $value)

Сериализовать заданное значение.

mixed unserialize(string $serialized)

Десериализовать заданное значение.

Batch toBatch(object $batch)

Преобразовать заданную исходную партию в объект Batch.

Connection getConnection()

Получить базу данных, к которой осуществляется подключение.

void setConnection(Connection $connection)

Установить базу данных, к которой осуществляется подключение.

Подробности

__construct(BatchFactory $factory, Connection $connection, string $table)

Создать новый экземпляр репозитория пакета.

Parameters

BatchFactory $factory
Connection $connection
string $table

Batch[] get(int $limit = 50, mixed $before = null)

Получить список пакетов.

Parameters

int $limit
mixed $before

Return Value

Batch[]

Batch|null find(string $batchId)

Получить информацию о существующем пакете.

Parameters

string $batchId

Return Value

Batch|null

Batch store(PendingBatch $batch)

Сохранить новый ожидающий пакет.

Parameters

PendingBatch $batch

Return Value

Batch

void incrementTotalJobs(string $batchId, int $amount)

Увеличить общее количество задач в пакете.

Parameters

string $batchId
int $amount

Return Value

void

UpdatedBatchJobCounts decrementPendingJobs(string $batchId, string $jobId)

Уменьшить общее количество ожидающих задач для пакета.

Parameters

string $batchId
string $jobId

Return Value

UpdatedBatchJobCounts

UpdatedBatchJobCounts incrementFailedJobs(string $batchId, string $jobId)

Увеличить общее количество завершившихся с ошибкой задач для пакета.

Parameters

string $batchId
string $jobId

Return Value

UpdatedBatchJobCounts

protected int|null updateAtomicValues(string $batchId, Closure $callback)

Обновить атомарное значение в пакете.

Parameters

string $batchId
Closure $callback

Return Value

int|null

void markAsFinished(string $batchId)

Отметить пакет с заданным идентификатором как завершённый.

Parameters

string $batchId

Return Value

void

void cancel(string $batchId)

Отменить пакет с заданным идентификатором.

Parameters

string $batchId

Return Value

void

void delete(string $batchId)

Удалить пакет с заданным идентификатором.

Parameters

string $batchId

Return Value

void

int prune(DateTimeInterface $before)

Очистить все записи, более старые, чем указанная дата.

Parameters

DateTimeInterface $before

Return Value

int

int pruneUnfinished(DateTimeInterface $before)

Очистить все незавершенные записи, более старые, чем указанная дата.

Parameters

DateTimeInterface $before

Return Value

int

int pruneCancelled(DateTimeInterface $before)

Очистить все отменённые записи, более старые, чем указанная дата.

Parameters

DateTimeInterface $before

Return Value

int

mixed transaction(Closure $callback)

Выполнить переданный замыкание в рамках транзакции, специфичной для хранилища.

Parameters

Closure $callback

Return Value

mixed

protected string serialize(mixed $value)

Сериализовать переданное значение.

Parameters

mixed $value

Return Value

string

protected mixed unserialize(string $serialized)

Десериализовать переданное значение.

Parameters

string $serialized

Return Value

mixed

protected Batch toBatch(object $batch)

Преобразовать переданный пакет в объект Batch.

Parameters

object $batch

Return Value

Batch

Подключение getConnection()

Получить подключение к базе данных.

Возвращаемое значение

Подключение

void setConnection(Подключение $connection)

Установить подключение к базе данных.

Параметры

Подключение $connection

Возвращаемое значение

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Bus/DatabaseBatchRepository.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API