| Methods |
public
|
chunk(int $count, callable(Collection<int, TValue>, int): mixed $callback): bool
Chunk the results of the query.
Chunk the results of the query.
|
#
|
public
|
chunkMap<TReturn>(callable(TValue): TReturn $callback, int $count = 1000): Collection<int, TReturn>
Run a map over each item while chunking.
Run a map over each item while chunking.
|
#
|
public
|
each(callable(TValue, int): mixed $callback, int $count = 1000): bool
Execute a callback over each item while chunking.
Execute a callback over each item while chunking.
Throws
|
#
|
public
|
chunkById(
int $count,
callable(Collection<int, TValue>, int): mixed $callback,
string|null $column = null,
string|null $alias = null,
): bool
Chunk the results of a query by comparing IDs.
Chunk the results of a query by comparing IDs.
|
#
|
public
|
chunkByIdDesc(
int $count,
callable(Collection<int, TValue>, int): mixed $callback,
string|null $column = null,
string|null $alias = null,
): bool
Chunk the results of a query by comparing IDs in descending order.
Chunk the results of a query by comparing IDs in descending order.
|
#
|
public
|
orderedChunkById(
int $count,
callable(Collection<int, TValue>, int): mixed $callback,
string|null $column = null,
string|null $alias = null,
bool $descending = false,
): bool
Chunk the results of a query by comparing IDs in a given order.
Chunk the results of a query by comparing IDs in a given order.
Throws
|
#
|
public
|
eachById(
callable(TValue, int): mixed $callback,
int $count = 1000,
string|null $column = null,
string|null $alias = null,
): bool
Execute a callback over each item while chunking by ID.
Execute a callback over each item while chunking by ID.
|
#
|
public
|
lazy(int $chunkSize = 1000): LazyCollection<int, TValue>
Query lazily, by chunks of the given size.
Query lazily, by chunks of the given size.
Throws
|
#
|
public
|
lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null): LazyCollection<int, TValue>
Query lazily, by chunking the results of a query by comparing IDs.
Query lazily, by chunking the results of a query by comparing IDs.
Throws
|
#
|
public
|
lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null): LazyCollection<int, TValue>
Query lazily, by chunking the results of a query by comparing IDs in descending order.
Query lazily, by chunking the results of a query by comparing IDs in descending order.
Throws
|
#
|
protected
|
orderedLazyById(
int $chunkSize = 1000,
string|null $column = null,
string|null $alias = null,
bool $descending = false,
): LazyCollection
Query lazily, by chunking the results of a query by comparing IDs in a given order.
Query lazily, by chunking the results of a query by comparing IDs in a given order.
Throws
|
#
|
public
|
first(array|string $columns = ['*']): TValue|null
Execute the query and get the first result.
Execute the query and get the first result.
|
#
|
public
|
firstOrFail(array|string $columns = ['*'], string|null $message = null): TValue
Execute the query and get the first result or throw an exception.
Execute the query and get the first result or throw an exception.
Throws
|
#
|
public
|
sole(array|string $columns = ['*']): TValue
Execute the query and get the first result if it's the sole matching record.
Execute the query and get the first result if it's the sole matching record.
Throws
|
#
|
protected
|
paginateUsingCursor(
int $perPage,
array|string $columns = ['*'],
string $cursorName = 'cursor',
Cursor|string|null $cursor = null,
): CursorPaginator
Paginate the given query using a cursor paginator.
Paginate the given query using a cursor paginator.
|
#
|
protected
|
getOriginalColumnNameForCursorPagination(Builder|Builder<*> $builder, string $parameter): string
Get the original column name of the given column, without any aliasing.
Get the original column name of the given column, without any aliasing.
|
#
|
protected
|
paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options): LengthAwarePaginator
Create a new length-aware paginator instance.
Create a new length-aware paginator instance.
|
#
|
protected
|
simplePaginator(Collection $items, int $perPage, int $currentPage, array $options): Paginator
Create a new simple paginator instance.
Create a new simple paginator instance.
|
#
|
protected
|
cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options): CursorPaginator
Create a new cursor paginator instance.
Create a new cursor paginator instance.
|
#
|
public
|
tap(callable($this): mixed $callback): $this
Pass the query to a given callback.
Pass the query to a given callback.
|
#
|