JoinLateralClause
class JoinLateralClause extends JoinClause
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| ConnectionInterface | $connection | The database connection instance. |
from Builder |
| Grammar | $grammar | The database query grammar instance. |
from Builder |
| Processor | $processor | The database query post processor instance. |
from Builder |
| array{select: list<mixed>, from: list<mixed>, join: list<mixed>, where: list<mixed>, groupBy: list<mixed>, having: list<mixed>, order: list<mixed>, union: list<mixed>, unionOrder: list<mixed>} | $bindings | The current query value bindings. |
from Builder |
| null|Expression|string>} | $aggregate | An aggregate function and column to be run. |
from Builder |
| null|Expression|string> | $columns | The columns that should be returned. |
from Builder |
| bool|array | $distinct | Indicates if the query returns distinct results. |
from Builder |
| Expression|string|null | $from | The table which the query is targeting. |
from Builder |
| IndexHint|null | $indexHint | The index hint for the query. |
from Builder |
| array|null | $joins | The table joins for the query. |
from Builder |
| array | $wheres | The where constraints for the query. |
from Builder |
| array|null | $groups | The groupings for the query. |
from Builder |
| array|null | $havings | The having constraints for the query. |
from Builder |
| array|null | $orders | The orderings for the query. |
from Builder |
| int|null | $limit | The maximum number of records to return. |
from Builder |
| array|null | $groupLimit | The maximum number of records to return per group. |
from Builder |
| int|null | $offset | The number of records to skip. |
from Builder |
| array|null | $unions | The query union statements. |
from Builder |
| int|null | $unionLimit | The maximum number of union records to return. |
from Builder |
| int|null | $unionOffset | The number of union records to skip. |
from Builder |
| array|null | $unionOrders | The orderings for the union query. |
from Builder |
| string|bool|null | $lock | Indicates whether row locking is being used. |
from Builder |
| int|null | $timeout | The query execution timeout in seconds. |
from Builder |
| array | $beforeQueryCallbacks | The callbacks that should be invoked before the query is executed. |
from Builder |
| protected array | $afterQueryCallbacks | The callbacks that should be invoked after retrieving data from the database. |
from Builder |
| string[] | $operators | All of the available clause operators. |
from Builder |
| string[] | $bitwiseOperators | All of the available bitwise operators. |
from Builder |
| bool | $useWritePdo | Whether to use write pdo for the select. |
from Builder |
| array | $fetchUsing | The PDO fetch mode arguments for the query. |
from Builder |
| string | $type | The type of join being performed. |
from JoinClause |
| Expression|string | $table | The table the join clause is joining to. |
from JoinClause |
| protected ConnectionInterface | $parentConnection | The connection of the parent query builder. |
from JoinClause |
| protected Grammar | $parentGrammar | The grammar of the parent query builder. |
from JoinClause |
| protected Processor | $parentProcessor | The processor of the parent query builder. |
from JoinClause |
| protected string | $parentClass | The class name of the parent query builder. |
from JoinClause |
Methods
Add a where clause to determine if a "date" column is in the past to the query.
Add a where clause to determine if a "date" column is in the past or now to the query.
Add an "or where" clause to determine if a "date" column is in the past to the query.
Add a where clause to determine if a "date" column is in the past or now to the query.
Add a where clause to determine if a "date" column is in the future to the query.
Add a where clause to determine if a "date" column is in the future or now to the query.
Add an "or where" clause to determine if a "date" column is in the future to the query.
Add an "or where" clause to determine if a "date" column is in the future or now to the query.
Add an "where" clause to determine if a "date" column is in the past or future.
Add a "where date" clause to determine if a "date" column is today to the query.
Add a "where date" clause to determine if a "date" column is before today.
Add a "where date" clause to determine if a "date" column is today or before to the query.
Add a "where date" clause to determine if a "date" column is after today.
Add a "where date" clause to determine if a "date" column is today or after to the query.
Add an "or where date" clause to determine if a "date" column is today to the query.
Add an "or where date" clause to determine if a "date" column is before today.
Add an "or where date" clause to determine if a "date" column is today or before to the query.
Add an "or where date" clause to determine if a "date" column is after today.
Add an "or where date" clause to determine if a "date" column is today or after to the query.
Add a "where date" clause to determine if a "date" column is today or after to the query.
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Run a map over each item while chunking.
Execute a callback over each item while chunking.
Chunk the results of a query by comparing IDs.
Chunk the results of a query by comparing IDs in descending order.
Chunk the results of a query by comparing IDs in a given order.
Execute a callback over each item while chunking by ID.
Query lazily, by chunks of the given size.
Query lazily, by chunking the results of a query by comparing IDs.
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 a given order.
Execute the query and get the first result.
Execute the query and get the first result or throw an exception.
Execute the query and get the first result if it's the sole matching record.
Paginate the given query using a cursor paginator.
Get the original column name of the given column, without any aliasing.
Create a new length-aware paginator instance.
Create a new simple paginator instance.
Create a new cursor paginator instance.
Pass the query to a given callback and then return it.
Pass the query to a given callback and return the result.
Forward a method call to the given object.
Forward a method call to the given object, returning $this if the forwarded call returned itself.
Throw a bad method call exception for the given method.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new join clause instance.
Add a subselect expression to the query.
Add a new "raw" select expression to the query.
Prepend the database name if the given query is on another database.
Add a vector-similarity selection to the query.
Set the table which the query is targeting.
Add a "join" clause to the query.
Add a "join where" clause to the query.
Add a "subquery join" clause to the query.
Add a "lateral join" clause to the query.
Add a lateral left join to the query.
Add a left join to the query.
Add a "join where" clause to the query.
Add a subquery left join to the query.
Add a right join to the query.
Add a "right join where" clause to the query.
Add a subquery right join to the query.
Add a "cross join" clause to the query.
Add a subquery cross join to the query.
Add a straight join to the query.
Add a straight join where clause to the query.
Add a subquery straight join to the query.
Get a new "join" clause.
Get a new "join lateral" clause.
Merge an array of "where" clauses and bindings.
Add a basic "where" clause to the query.
Add an array of "where" clauses to the query.
Prepare the value and operator for a where clause.
Determine if the given operator and value combination is legal.
Determine if the operator is a bitwise operator.
Add an "or where" clause to the query.
Add a basic "where not" clause to the query.
Add an "or where not" clause to the query.
Add a "where" clause comparing two columns to the query.
Add an "or where" clause comparing two columns to the query.
Add a vector similarity clause to the query, filtering by minimum similarity and ordering by similarity.
Add a vector distance "where" clause to the query.
Add a vector distance "or where" clause to the query.
Add a raw "where" clause to the query.
Add a raw "or where" clause to the query.
Add a "where like" clause to the query.
Add an "or where like" clause to the query.
Add a "where not like" clause to the query.
Add an "or where not like" clause to the query.
Add a null-safe equality clause to the query.
Add an "or" null-safe equality clause to the query.
Add a "where in" clause to the query.
Add a "where not in" clause to the query.
Add an "or where not in" clause to the query.
Add a "where in raw" clause for integer values to the query.
Add an "or where in raw" clause for integer values to the query.
Add a "where not in raw" clause for integer values to the query.
Add an "or where not in raw" clause for integer values to the query.
Add a "where null" clause to the query.
Add a "where not null" clause to the query.
Add a "where between" statement to the query.
Add a "where between" statement using columns to the query.
Add an "or where between" statement to the query.
Add an "or where between" statement using columns to the query.
Add a "where not between" statement to the query.
Add a "where not between" statement using columns to the query.
Add an "or where not between" statement to the query.
Add an "or where not between" statement using columns to the query.
Add a "where between columns" statement using a value to the query.
Add an "or where between columns" statement using a value to the query.
Add a "where not between columns" statement using a value to the query.
Add an "or where not between columns" statement using a value to the query.
Add a "where date" statement to the query.
Add an "or where date" statement to the query.
Add a "where time" statement to the query.
Add an "or where time" statement to the query.
Add a "where day" statement to the query.
Add an "or where day" statement to the query.
Add a "where month" statement to the query.
Add an "or where month" statement to the query.
Add a "where year" statement to the query.
Add an "or where year" statement to the query.
Add a date based (year, month, day, time) statement to the query.
Add a nested "where" statement to the query.
Add another query builder as a nested where to the query builder.
Add a full sub-select to the query.
Add an "exists" clause to the query.
Add an "or where exists" clause to the query.
Add a "where not exists" clause to the query.
Add an "or where not exists" clause to the query.
Add an "exists" clause to the query.
Adds a where condition using row values.
Adds an or where condition using row values.
Add a "where JSON contains" clause to the query.
Add an "or where JSON contains" clause to the query.
Add a "where JSON not contains" clause to the query.
Add an "or where JSON not contains" clause to the query.
Add a "where JSON overlaps" clause to the query.
Add an "or where JSON overlaps" clause to the query.
Add a "where JSON not overlap" clause to the query.
Add an "or where JSON not overlap" clause to the query.
Add a clause that determines if a JSON path exists to the query.
Add an "or" clause that determines if a JSON path exists to the query.
Add a clause that determines if a JSON path does not exist to the query.
Add an "or" clause that determines if a JSON path does not exist to the query.
Add a "where JSON length" clause to the query.
Add an "or where JSON length" clause to the query.
Handles dynamic "where" clauses to the query.
Add a single dynamic "where" clause statement to the query.
Add a "where fulltext" clause to the query.
Add an "or where fulltext" clause to the query.
Add a "where" clause to the query for multiple columns with "and" conditions between them.
Add an "or where" clause to the query for multiple columns with "and" conditions between them.
Add a "where" clause to the query for multiple columns with "or" conditions between them.
Add an "or where" clause to the query for multiple columns with "or" conditions between them.
Add a "where not" clause to the query for multiple columns where none of the conditions should be true.
Add an "or where not" clause to the query for multiple columns where none of the conditions should be true.
Add a raw "groupBy" clause to the query.
Add a "having" clause to the query.
Add an "or having" clause to the query.
Add a nested "having" statement to the query.
Add another query builder as a nested having to the query builder.
Add a "having null" clause to the query.
Add a "having not null" clause to the query.
Add an "or having not null" clause to the query.
Add a "having between" clause to the query.
Add a "having not between" clause to the query.
Add an "or having between" clause to the query.
Add an "or having not between" clause to the query.
Add a raw "having" clause to the query.
Add a raw "or having" clause to the query.
Add an "order by" clause to the query.
Add a descending "order by" clause to the query.
Add an "order by" clause for a timestamp to the query.
Add an "order by" clause for a timestamp to the query.
Add a vector-distance "order by" clause to the query.
Add an order clause for a given sequence of values.
Add a raw "order by" clause to the query.
Add a "group limit" clause to the query.
Constrain the query to the previous "page" of results before a given ID.
Constrain the query to the next "page" of results after a given ID.
Remove all existing orders and optionally add a new order.
Add descending "reorder" clause to the query.
Get an array with all orders with a given column removed.
Register a closure to be invoked before the query is executed.
Execute a query for a single record by ID.
Execute a query for a single record by ID or call a callback.
Get a single column's value from the first result of a query.
Get a single expression value from the first result of a query.
Get a single column's value from the first result of a query if it's the sole matching record.
Remove the group limit keys from the results in the collection.
Paginate the given query into a simple paginator.
Get a paginator only supporting simple next and previous links.
Get a paginator only supporting simple next and previous links.
Ensure the proper order by required for cursor pagination.
Get the count of the total records for the paginator.
Clone the existing query instance for usage in a pagination subquery.
Remove the column aliases since they will break count queries.
Get a collection instance containing the values of a given column.
Strip off the table name or alias from a column identifier.
Retrieve column values from rows represented as objects.
Retrieve column values from rows represented as arrays.
Concatenate values of a given column as a string.
Execute an aggregate function on the database.
Execute a numeric aggregate function on the database.
Set the aggregate property without running the query.
Execute the given callback while selecting the given columns.
Insert new records into the database while ignoring errors.
Insert records while ignoring conflicts and return the inserted rows.
Insert a new record and get the value of the primary key.
Insert new records into the table using a subquery.
Insert new records into the table using a subquery while ignoring errors.
Update records in a PostgreSQL database using the update from syntax.
Insert or update a record matching the attributes, and fill it with values.
Insert new records or update the existing ones.
Increment a column's value by a given amount.
Increment the given column's values by the given amounts.
Decrement a column's value by a given amount.
Decrement the given column's values by the given amounts.
Get all of the query builder's columns in a text-only array with all expressions evaluated.
Get the query builder instances that are used in the union of the query.
Set the bindings on the query builder.
Remove all of the expressions from a list of bindings.
Get a scalar type value from an unknown type of input.
Ensure the database connection supports vector queries.
Set the PDO fetch mode arguments for the query.
Determine if the value is a query builder instance or a Closure.
Clone the query without the given bindings.
Add an "on" clause to the join.
Add an "or on" clause to the join.
Details
in
BuildsWhereDateClauses at line 17
BuildsWhereDateClauses
wherePast(array|string $columns)
Add a where clause to determine if a "date" column is in the past to the query.
in
BuildsWhereDateClauses at line 27
BuildsWhereDateClauses
whereNowOrPast(array|string $columns)
Add a where clause to determine if a "date" column is in the past or now to the query.
in
BuildsWhereDateClauses at line 37
BuildsWhereDateClauses
orWherePast(array|string $columns)
Add an "or where" clause to determine if a "date" column is in the past to the query.
in
BuildsWhereDateClauses at line 47
BuildsWhereDateClauses
orWhereNowOrPast(array|string $columns)
Add a where clause to determine if a "date" column is in the past or now to the query.
in
BuildsWhereDateClauses at line 57
BuildsWhereDateClauses
whereFuture(array|string $columns)
Add a where clause to determine if a "date" column is in the future to the query.
in
BuildsWhereDateClauses at line 67
BuildsWhereDateClauses
whereNowOrFuture(array|string $columns)
Add a where clause to determine if a "date" column is in the future or now to the query.
in
BuildsWhereDateClauses at line 77
BuildsWhereDateClauses
orWhereFuture(array|string $columns)
Add an "or where" clause to determine if a "date" column is in the future to the query.
in
BuildsWhereDateClauses at line 87
BuildsWhereDateClauses
orWhereNowOrFuture(array|string $columns)
Add an "or where" clause to determine if a "date" column is in the future or now to the query.
in
BuildsWhereDateClauses at line 97
protected BuildsWhereDateClauses
wherePastOrFuture(array|string $columns, string $operator, string $boolean)
Add an "where" clause to determine if a "date" column is in the past or future.
in
BuildsWhereDateClauses at line 116
BuildsWhereDateClauses
whereToday(array|string $columns, string $boolean = 'and')
Add a "where date" clause to determine if a "date" column is today to the query.
in
BuildsWhereDateClauses at line 126
BuildsWhereDateClauses
whereBeforeToday(array|string $columns)
Add a "where date" clause to determine if a "date" column is before today.
in
BuildsWhereDateClauses at line 136
BuildsWhereDateClauses
whereTodayOrBefore(array|string $columns)
Add a "where date" clause to determine if a "date" column is today or before to the query.
in
BuildsWhereDateClauses at line 146
BuildsWhereDateClauses
whereAfterToday(array|string $columns)
Add a "where date" clause to determine if a "date" column is after today.
in
BuildsWhereDateClauses at line 156
BuildsWhereDateClauses
whereTodayOrAfter(array|string $columns)
Add a "where date" clause to determine if a "date" column is today or after to the query.
in
BuildsWhereDateClauses at line 166
BuildsWhereDateClauses
orWhereToday(array|string $columns)
Add an "or where date" clause to determine if a "date" column is today to the query.
in
BuildsWhereDateClauses at line 176
BuildsWhereDateClauses
orWhereBeforeToday(array|string $columns)
Add an "or where date" clause to determine if a "date" column is before today.
in
BuildsWhereDateClauses at line 186
BuildsWhereDateClauses
orWhereTodayOrBefore(array|string $columns)
Add an "or where date" clause to determine if a "date" column is today or before to the query.
in
BuildsWhereDateClauses at line 196
BuildsWhereDateClauses
orWhereAfterToday(array|string $columns)
Add an "or where date" clause to determine if a "date" column is after today.
in
BuildsWhereDateClauses at line 206
BuildsWhereDateClauses
orWhereTodayOrAfter(array|string $columns)
Add an "or where date" clause to determine if a "date" column is today or after to the query.
in
BuildsWhereDateClauses at line 216
protected BuildsWhereDateClauses
whereTodayBeforeOrAfter(array|string $columns, string $operator, string $boolean)
Add a "where date" clause to determine if a "date" column is today or after to the query.
in
Conditionable at line 23
mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
in
Conditionable at line 56
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
in
BuildsQueries at line 39
bool
chunk(int $count, callable $callback)
Chunk the results of the query.
in
BuildsQueries at line 90
Collection
chunkMap(callable $callback, int $count = 1000)
Run a map over each item while chunking.
in
BuildsQueries at line 108
bool
each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
in
BuildsQueries at line 124
bool
chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs.
in
BuildsQueries at line 134
bool
chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs in descending order.
in
BuildsQueries at line 144
bool
orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, SortDirection|bool $descending = false)
Chunk the results of a query by comparing IDs in a given order.
in
BuildsQueries at line 212
bool
eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)
Execute a callback over each item while chunking by ID.
in
BuildsQueries at line 228
LazyCollection
lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size.
in
BuildsQueries at line 258
LazyCollection
lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs.
in
BuildsQueries at line 268
LazyCollection
lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs in descending order.
in
BuildsQueries at line 278
protected LazyCollection
orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, SortDirection|bool $descending = false)
Query lazily, by chunking the results of a query by comparing IDs in a given order.
in
BuildsQueries at line 321
null|TValue
first(array|string $columns = ['*'])
Execute the query and get the first result.
in
BuildsQueries at line 334
TValue
firstOrFail(array|string $columns = ['*'], string|null $message = null)
Execute the query and get the first result or throw an exception.
in
BuildsQueries at line 351
TValue
sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
in
BuildsQueries at line 374
protected CursorPaginator
paginateUsingCursor(int $perPage, array|string $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)
Paginate the given query using a cursor paginator.
in
BuildsQueries at line 469
protected string
getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)
Get the original column name of the given column, without any aliasing.
in
BuildsQueries at line 491
protected LengthAwarePaginator
paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)
Create a new length-aware paginator instance.
in
BuildsQueries at line 505
protected Paginator
simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)
Create a new simple paginator instance.
in
BuildsQueries at line 518
protected CursorPaginator
cursorPaginator(Collection $items, int $perPage, Cursor|null $cursor, array $options)
Create a new cursor paginator instance.
in
BuildsQueries at line 534
BuildsQueries
tap(callable $callback)
Pass the query to a given callback and then return it.
in
BuildsQueries at line 549
TReturn is null|TReturn)
pipe(callable $callback)
Pass the query to a given callback and return the result.
in
ExplainsQueries at line 14
Collection
explain()
Explains the query.
in
ForwardsCalls at line 22
protected mixed
forwardCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object.
in
ForwardsCalls at line 52
protected mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Forward a method call to the given object, returning $this if the forwarded call returned itself.
in
ForwardsCalls at line 66
static protected never
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
JoinClause at line 49
__construct(Builder $parentQuery, string $type, Expression|string $table)
Create a new join clause instance.
in
Builder at line 285
Builder
selectSub(Closure|Builder|Builder|string $query, string $as)
Add a subselect expression to the query.
in
Builder at line 298
Builder
selectExpression(Expression $expression, string $as)
Add an expression to the select clause.
in
Builder at line 308
Builder
selectRaw(string $expression, array $bindings = [])
Add a new "raw" select expression to the query.
in
Builder at line 326
Builder
fromSub(Closure|Builder|Builder|string $query, string $as)
Makes "from" fetch from a subquery.
in
Builder at line 336
Builder
fromRaw(Expression|string $expression, mixed $bindings = [])
Add a raw "from" clause to the query.
in
Builder at line 352
protected array
createSub(Closure|Builder|Builder|string $query)
Creates a subquery and parse it.
in
Builder at line 371
protected array
parseSub(mixed $query)
Parse the subquery into SQL and bindings.
in
Builder at line 389
protected Builder|Builder|Relation
prependDatabaseNameIfCrossDatabaseQuery(Builder|Builder|Relation $query)
Prepend the database name if the given query is on another database.
in
Builder at line 440
Builder
selectVectorDistance(Expression|string $column, Collection|Arrayable|array|string $vector, string|null $as = null)
Add a vector-similarity selection to the query.
in
Builder at line 486
Builder
from(Closure|Builder|Builder|Expression|string $table, string|null $as = null)
Set the table which the query is targeting.
in
Builder at line 520
Builder
ignoreIndex(string $index)
Add an index hint to ignore a query index.
in
Builder at line 530
Builder
join(Expression|string $table, Closure|Expression|string $first, string|null $operator = null, mixed $second = null, string $type = 'inner', bool $where = false)
Add a "join" clause to the query.
in
Builder at line 562
Builder
joinWhere(Expression|string $table, Closure|Expression|string $first, string $operator, Expression|string $second, string $type = 'inner')
Add a "join where" clause to the query.
in
Builder at line 574
Builder
joinSub(Closure|Builder|Builder|string $query, string $as, Closure|Expression|string $first, string|null $operator = null, mixed $second = null, string $type = 'inner', bool $where = false)
Add a "subquery join" clause to the query.
in
Builder at line 590
Builder
joinLateral(Closure|Builder|Builder|string $query, string $as, string $type = 'inner')
Add a "lateral join" clause to the query.
in
Builder at line 608
Builder
leftJoinLateral(Closure|Builder|Builder|string $query, string $as)
Add a lateral left join to the query.
in
Builder at line 616
Builder
leftJoin(Expression|string $table, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a left join to the query.
in
Builder at line 624
Builder
leftJoinWhere(Expression|string $table, Closure|Expression|string $first, string $operator, Expression|string|null $second)
Add a "join where" clause to the query.
in
Builder at line 634
Builder
leftJoinSub(Closure|Builder|Builder|string $query, string $as, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a subquery left join to the query.
in
Builder at line 642
Builder
rightJoin(Expression|string $table, Closure|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a right join to the query.
in
Builder at line 650
Builder
rightJoinWhere(Expression|string $table, Closure|Expression|string $first, string $operator, Expression|string $second)
Add a "right join where" clause to the query.
in
Builder at line 660
Builder
rightJoinSub(Closure|Builder|Builder|string $query, string $as, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a subquery right join to the query.
in
Builder at line 668
Builder
crossJoin(Expression|string $table, Closure|Expression|string|null $first = null, string|null $operator = null, Expression|string|null $second = null)
Add a "cross join" clause to the query.
in
Builder at line 682
Builder
crossJoinSub(Closure|Builder|Builder|string $query, string $as)
Add a subquery cross join to the query.
in
Builder at line 698
Builder
straightJoin(Expression|string $table, Closure|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a straight join to the query.
in
Builder at line 706
Builder
straightJoinWhere(Expression|string $table, Closure|Expression|string $first, string $operator, Expression|string $second)
Add a straight join where clause to the query.
in
Builder at line 716
Builder
straightJoinSub(Closure|Builder|Builder|string $query, string $as, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null)
Add a subquery straight join to the query.
in
Builder at line 724
protected JoinClause
newJoinClause(Builder $parentQuery, string $type, Expression|string $table)
Get a new "join" clause.
in
Builder at line 732
protected JoinLateralClause
newJoinLateralClause(Builder $parentQuery, string $type, Expression|string $table)
Get a new "join lateral" clause.
in
Builder at line 740
Builder
mergeWheres(array $wheres, array $bindings)
Merge an array of "where" clauses and bindings.
in
Builder at line 754
Builder
where(Closure|Builder|Builder|Relation|Expression|array|string $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic "where" clause to the query.
in
Builder at line 860
protected Builder
addArrayOfWheres(array $column, string $boolean, string $method = 'where')
Add an array of "where" clauses to the query.
in
Builder at line 878
array
prepareValueAndOperator(mixed $value, mixed $operator, bool $useDefault = false)
Prepare the value and operator for a where clause.
in
Builder at line 895
protected bool
invalidOperatorAndValue(mixed $operator, mixed $value)
Determine if the given operator and value combination is legal.
Prevents using Null values with invalid operators.
in
Builder at line 904
protected bool
invalidOperator(mixed $operator)
Determine if the given operator is supported.
in
Builder at line 913
protected bool
isBitwiseOperator(string $operator)
Determine if the operator is a bitwise operator.
in
Builder at line 922
Builder
orWhere(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null)
Add an "or where" clause to the query.
in
Builder at line 936
Builder
whereNot(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic "where not" clause to the query.
in
Builder at line 950
Builder
orWhereNot(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null)
Add an "or where not" clause to the query.
in
Builder at line 958
Builder
whereColumn(Expression|string|array $first, string|null $operator = null, string|null $second = null, string $boolean = 'and')
Add a "where" clause comparing two columns to the query.
in
Builder at line 993
Builder
orWhereColumn(Expression|string|array $first, string|null $operator = null, string|null $second = null)
Add an "or where" clause comparing two columns to the query.
in
Builder at line 1004
Builder
whereVectorSimilarTo(Expression|string $column, Collection|Arrayable|array|string $vector, float $minSimilarity = 0.6, bool $order = true)
Add a vector similarity clause to the query, filtering by minimum similarity and ordering by similarity.
in
Builder at line 1024
Builder
whereVectorDistanceLessThan(Expression|string $column, Collection|Arrayable|array|string $vector, float $maxDistance, string $boolean = 'and')
Add a vector distance "where" clause to the query.
in
Builder at line 1052
Builder
orWhereVectorDistanceLessThan(Expression|string $column, Collection|Arrayable|array|string $vector, float $maxDistance)
Add a vector distance "or where" clause to the query.
in
Builder at line 1060
Builder
whereRaw(Expression|string $sql, mixed $bindings = [], string $boolean = 'and')
Add a raw "where" clause to the query.
in
Builder at line 1072
Builder
orWhereRaw(string $sql, mixed $bindings = [])
Add a raw "or where" clause to the query.
in
Builder at line 1080
Builder
whereLike(Expression|string $column, string $value, bool $caseSensitive = false, string $boolean = 'and', bool $not = false)
Add a "where like" clause to the query.
in
Builder at line 1098
Builder
orWhereLike(Expression|string $column, string $value, bool $caseSensitive = false)
Add an "or where like" clause to the query.
in
Builder at line 1106
Builder
whereNotLike(Expression|string $column, string $value, bool $caseSensitive = false, string $boolean = 'and')
Add a "where not like" clause to the query.
in
Builder at line 1114
Builder
orWhereNotLike(Expression|string $column, string $value, bool $caseSensitive = false)
Add an "or where not like" clause to the query.
in
Builder at line 1122
Builder
whereNullSafeEquals(Expression|string $column, mixed $value, string $boolean = 'and')
Add a null-safe equality clause to the query.
in
Builder at line 1138
Builder
orWhereNullSafeEquals(Expression|string $column, mixed $value)
Add an "or" null-safe equality clause to the query.
in
Builder at line 1146
Builder
whereIn(Expression|string $column, mixed $values, string $boolean = 'and', bool $not = false)
Add a "where in" clause to the query.
in
Builder at line 1185
Builder
orWhereIn(Expression|string $column, mixed $values)
Add an "or where in" clause to the query.
in
Builder at line 1193
Builder
whereNotIn(Expression|string $column, mixed $values, string $boolean = 'and')
Add a "where not in" clause to the query.
in
Builder at line 1201
Builder
orWhereNotIn(Expression|string $column, mixed $values)
Add an "or where not in" clause to the query.
in
Builder at line 1209
Builder
whereIntegerInRaw(string $column, Arrayable|array $values, string $boolean = 'and', bool $not = false)
Add a "where in raw" clause for integer values to the query.
in
Builder at line 1231
Builder
orWhereIntegerInRaw(string $column, Arrayable|array $values)
Add an "or where in raw" clause for integer values to the query.
in
Builder at line 1239
Builder
whereIntegerNotInRaw(string $column, Arrayable|array $values, string $boolean = 'and')
Add a "where not in raw" clause for integer values to the query.
in
Builder at line 1247
Builder
orWhereIntegerNotInRaw(string $column, Arrayable|array $values)
Add an "or where not in raw" clause for integer values to the query.
in
Builder at line 1255
Builder
whereNull(string|array|Expression $columns, string $boolean = 'and', bool $not = false)
Add a "where null" clause to the query.
in
Builder at line 1269
Builder
orWhereNull(string|array|Expression $column)
Add an "or where null" clause to the query.
in
Builder at line 1277
Builder
whereNotNull(string|array|Expression $columns, string $boolean = 'and')
Add a "where not null" clause to the query.
in
Builder at line 1287
Builder
whereBetween(Builder|Builder|Expression|string $column, iterable $values, string $boolean = 'and', bool $not = false)
Add a "where between" statement to the query.
in
Builder at line 1314
Builder
whereBetweenColumns(Builder|Builder|Expression|string $column, array $values, string $boolean = 'and', bool $not = false)
Add a "where between" statement using columns to the query.
in
Builder at line 1335
Builder
orWhereBetween(Builder|Builder|Expression|string $column, iterable $values)
Add an "or where between" statement to the query.
in
Builder at line 1343
Builder
orWhereBetweenColumns(Expression|string $column, array $values)
Add an "or where between" statement using columns to the query.
in
Builder at line 1353
Builder
whereNotBetween(Builder|Builder|Expression|string $column, iterable $values, string $boolean = 'and')
Add a "where not between" statement to the query.
in
Builder at line 1361
Builder
whereNotBetweenColumns(Expression|string $column, array $values, string $boolean = 'and')
Add a "where not between" statement using columns to the query.
in
Builder at line 1371
Builder
orWhereNotBetween(Builder|Builder|Expression|string $column, iterable $values)
Add an "or where not between" statement to the query.
in
Builder at line 1379
Builder
orWhereNotBetweenColumns(Expression|string $column, array $values)
Add an "or where not between" statement using columns to the query.
in
Builder at line 1389
Builder
whereValueBetween(mixed $value, array $columns, string $boolean = 'and', bool $not = false)
Add a "where between columns" statement using a value to the query.
in
Builder at line 1405
Builder
orWhereValueBetween(mixed $value, array $columns)
Add an "or where between columns" statement using a value to the query.
in
Builder at line 1415
Builder
whereValueNotBetween(mixed $value, array $columns, string $boolean = 'and')
Add a "where not between columns" statement using a value to the query.
in
Builder at line 1425
Builder
orWhereValueNotBetween(mixed $value, array $columns)
Add an "or where not between columns" statement using a value to the query.
in
Builder at line 1433
Builder
orWhereNotNull(array|Expression|string $column)
Add an "or where not null" clause to the query.
in
Builder at line 1441
Builder
whereDate(Expression|string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where date" statement to the query.
in
Builder at line 1468
Builder
orWhereDate(Expression|string $column, mixed $operator, mixed $value = null)
Add an "or where date" statement to the query.
in
Builder at line 1482
Builder
whereTime(Expression|string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where time" statement to the query.
in
Builder at line 1509
Builder
orWhereTime(Expression|string $column, mixed $operator, mixed $value = null)
Add an "or where time" statement to the query.
in
Builder at line 1523
Builder
whereDay(Expression|string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where day" statement to the query.
in
Builder at line 1554
Builder
orWhereDay(Expression|string $column, mixed $operator, mixed $value = null)
Add an "or where day" statement to the query.
in
Builder at line 1568
Builder
whereMonth(Expression|string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where month" statement to the query.
in
Builder at line 1599
Builder
orWhereMonth(Expression|string $column, mixed $operator, mixed $value = null)
Add an "or where month" statement to the query.
in
Builder at line 1613
Builder
whereYear(Expression|string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where year" statement to the query.
in
Builder at line 1640
Builder
orWhereYear(Expression|string $column, mixed $operator, mixed $value = null)
Add an "or where year" statement to the query.
in
Builder at line 1654
protected Builder
addDateBasedWhere(string $type, Expression|string $column, string $operator, mixed $value, string $boolean = 'and')
Add a date based (year, month, day, time) statement to the query.
in
Builder at line 1668
Builder
whereNested(Closure $callback, string $boolean = 'and')
Add a nested "where" statement to the query.
in
Builder at line 1678
Builder
forNestedWhere()
Create a new query instance for nested where condition.
in
Builder at line 1692
Builder
addNestedWhereQuery(Builder $query, string $boolean = 'and')
Add another query builder as a nested where to the query builder.
in
Builder at line 1710
protected Builder
whereSub(Expression|string $column, string $operator, Closure|Builder|Builder $callback, string $boolean)
Add a full sub-select to the query.
in
Builder at line 1741
Builder
whereExists(Closure|Builder|Builder $callback, string $boolean = 'and', bool $not = false)
Add an "exists" clause to the query.
in
Builder at line 1762
Builder
orWhereExists(Closure|Builder|Builder $callback, bool $not = false)
Add an "or where exists" clause to the query.
in
Builder at line 1772
Builder
whereNotExists(Closure|Builder|Builder $callback, string $boolean = 'and')
Add a "where not exists" clause to the query.
in
Builder at line 1782
Builder
orWhereNotExists(Closure|Builder|Builder $callback)
Add an "or where not exists" clause to the query.
in
Builder at line 1790
Builder
addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false)
Add an "exists" clause to the query.
in
Builder at line 1806
Builder
whereRowValues(array $columns, string $operator, array $values, string $boolean = 'and')
Adds a where condition using row values.
in
Builder at line 1824
Builder
orWhereRowValues(array $columns, string $operator, array $values)
Adds an or where condition using row values.
in
Builder at line 1832
Builder
whereJsonContains(string $column, mixed $value, string $boolean = 'and', bool $not = false)
Add a "where JSON contains" clause to the query.
in
Builder at line 1848
Builder
orWhereJsonContains(string $column, mixed $value)
Add an "or where JSON contains" clause to the query.
in
Builder at line 1856
Builder
whereJsonDoesntContain(string $column, mixed $value, string $boolean = 'and')
Add a "where JSON not contains" clause to the query.
in
Builder at line 1864
Builder
orWhereJsonDoesntContain(string $column, mixed $value)
Add an "or where JSON not contains" clause to the query.
in
Builder at line 1872
Builder
whereJsonOverlaps(string $column, mixed $value, string $boolean = 'and', bool $not = false)
Add a "where JSON overlaps" clause to the query.
in
Builder at line 1888
Builder
orWhereJsonOverlaps(string $column, mixed $value)
Add an "or where JSON overlaps" clause to the query.
in
Builder at line 1896
Builder
whereJsonDoesntOverlap(string $column, mixed $value, string $boolean = 'and')
Add a "where JSON not overlap" clause to the query.
in
Builder at line 1904
Builder
orWhereJsonDoesntOverlap(string $column, mixed $value)
Add an "or where JSON not overlap" clause to the query.
in
Builder at line 1912
Builder
whereJsonContainsKey(string $column, string $boolean = 'and', bool $not = false)
Add a clause that determines if a JSON path exists to the query.
in
Builder at line 1924
Builder
orWhereJsonContainsKey(string $column)
Add an "or" clause that determines if a JSON path exists to the query.
in
Builder at line 1932
Builder
whereJsonDoesntContainKey(string $column, string $boolean = 'and')
Add a clause that determines if a JSON path does not exist to the query.
in
Builder at line 1940
Builder
orWhereJsonDoesntContainKey(string $column)
Add an "or" clause that determines if a JSON path does not exist to the query.
in
Builder at line 1948
Builder
whereJsonLength(string $column, mixed $operator, mixed $value = null, string $boolean = 'and')
Add a "where JSON length" clause to the query.
in
Builder at line 1977
Builder
orWhereJsonLength(string $column, mixed $operator, mixed $value = null)
Add an "or where JSON length" clause to the query.
in
Builder at line 1991
Builder
dynamicWhere(string $method, array $parameters)
Handles dynamic "where" clauses to the query.
in
Builder at line 2033
protected void
addDynamic(string $segment, string $connector, array $parameters, int $index)
Add a single dynamic "where" clause statement to the query.
in
Builder at line 2046
Builder
whereFullText(string|array $columns, string $value, array $options = [], string $boolean = 'and')
Add a "where fulltext" clause to the query.
in
Builder at line 2062
Builder
orWhereFullText(string|array $columns, string $value, array $options = [])
Add an "or where fulltext" clause to the query.
in
Builder at line 2072
Builder
whereAll(array $columns, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a "where" clause to the query for multiple columns with "and" conditions between them.
in
Builder at line 2094
Builder
orWhereAll(array $columns, mixed $operator = null, mixed $value = null)
Add an "or where" clause to the query for multiple columns with "and" conditions between them.
in
Builder at line 2104
Builder
whereAny(array $columns, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a "where" clause to the query for multiple columns with "or" conditions between them.
in
Builder at line 2126
Builder
orWhereAny(array $columns, mixed $operator = null, mixed $value = null)
Add an "or where" clause to the query for multiple columns with "or" conditions between them.
in
Builder at line 2136
Builder
whereNone(array $columns, mixed $operator = null, mixed $value = null, string $boolean = 'and')
Add a "where not" clause to the query for multiple columns where none of the conditions should be true.
in
Builder at line 2146
Builder
orWhereNone(array $columns, mixed $operator = null, mixed $value = null)
Add an "or where not" clause to the query for multiple columns where none of the conditions should be true.
in
Builder at line 2154
Builder
groupBy(array|Expression|string ...$groups)
Add a "group by" clause to the query.
in
Builder at line 2169
Builder
groupByRaw(string $sql, array $bindings = [])
Add a raw "groupBy" clause to the query.
in
Builder at line 2181
Builder
having(Expression|Closure|string $column, DateTimeInterface|string|int|float|null $operator = null, Expression|DateTimeInterface|string|int|float|null $value = null, string $boolean = 'and')
Add a "having" clause to the query.
in
Builder at line 2233
Builder
orHaving(Expression|Closure|string $column, DateTimeInterface|string|int|float|null $operator = null, Expression|DateTimeInterface|string|int|float|null $value = null)
Add an "or having" clause to the query.
in
Builder at line 2250
Builder
havingNested(Closure $callback, string $boolean = 'and')
Add a nested "having" statement to the query.
in
Builder at line 2260
Builder
addNestedHavingQuery(Builder $query, string $boolean = 'and')
Add another query builder as a nested having to the query builder.
in
Builder at line 2276
Builder
havingNull(array|string $columns, string $boolean = 'and', bool $not = false)
Add a "having null" clause to the query.
in
Builder at line 2290
Builder
orHavingNull(string $column)
Add an "or having null" clause to the query.
in
Builder at line 2298
Builder
havingNotNull(array|string $columns, string $boolean = 'and')
Add a "having not null" clause to the query.
in
Builder at line 2306
Builder
orHavingNotNull(string $column)
Add an "or having not null" clause to the query.
in
Builder at line 2314
Builder
havingBetween(string $column, iterable $values, string $boolean = 'and', bool $not = false)
Add a "having between" clause to the query.
in
Builder at line 2332
Builder
havingNotBetween(string $column, iterable $values, string $boolean = 'and')
Add a "having not between" clause to the query.
in
Builder at line 2340
Builder
orHavingBetween(string $column, iterable $values)
Add an "or having between" clause to the query.
in
Builder at line 2348
Builder
orHavingNotBetween(string $column, iterable $values)
Add an "or having not between" clause to the query.
in
Builder at line 2358
protected array
resolveDatePeriodBounds(DatePeriod $period)
Resolve the start and end dates from a DatePeriod.
in
Builder at line 2377
Builder
havingRaw(string $sql, array $bindings = [], string $boolean = 'and')
Add a raw "having" clause to the query.
in
Builder at line 2391
Builder
orHavingRaw(string $sql, array $bindings = [])
Add a raw "or having" clause to the query.
in
Builder at line 2404
Builder
orderBy(Closure|Builder|Builder|Expression|string $column, SortDirection|string $direction = SortDirection::Ascending)
Add an "order by" clause to the query.
in
Builder at line 2437
Builder
orderByDesc(Closure|Builder|Builder|Expression|string $column)
Add a descending "order by" clause to the query.
in
Builder at line 2445
Builder
latest(Closure|Builder|Expression|string $column = 'created_at')
Add an "order by" clause for a timestamp to the query.
in
Builder at line 2453
Builder
oldest(Closure|Builder|Expression|string $column = 'created_at')
Add an "order by" clause for a timestamp to the query.
in
Builder at line 2463
Builder
orderByVectorDistance(Expression|string $column, Collection|Arrayable|array|string $vector)
Add a vector-distance "order by" clause to the query.
in
Builder at line 2492
Builder
inRandomOrder(string|int $seed = '')
Put the query's results in random order.
in
Builder at line 2500
Builder
inOrderOf(Expression|string $column, Arrayable|array $values)
Add an order clause for a given sequence of values.
in
Builder at line 2531
Builder
orderByRaw(string $sql, mixed $bindings = [])
Add a raw "order by" clause to the query.
in
Builder at line 2587
Builder
groupLimit(int $value, string $column)
Add a "group limit" clause to the query.
in
Builder at line 2599
Builder
forPage(int $page, int $perPage = 15)
Set the limit and offset for a given page.
in
Builder at line 2607
Builder
forPageBeforeId(int $perPage = 15, int|null $lastId = 0, string $column = 'id')
Constrain the query to the previous "page" of results before a given ID.
in
Builder at line 2624
Builder
forPageAfterId(int $perPage = 15, string|int|null $lastId = 0, string $column = 'id')
Constrain the query to the next "page" of results after a given ID.
in
Builder at line 2643
Builder
reorder(Closure|Builder|Expression|string|null $column = null, SortDirection|string $direction = SortDirection::Ascending)
Remove all existing orders and optionally add a new order.
in
Builder at line 2660
Builder
reorderDesc(Closure|Builder|Expression|string|null $column)
Add descending "reorder" clause to the query.
in
Builder at line 2668
protected array
removeExistingOrdersFor(string $column)
Get an array with all orders with a given column removed.
in
Builder at line 2681
Builder
union(Closure|Builder|Builder $query, bool $all = false)
Add a "union" statement to the query.
in
Builder at line 2699
Builder
unionAll(Closure|Builder|Builder $query)
Add a "union all" statement to the query.
in
Builder at line 2707
Builder
lock(string|bool $value = true)
Lock the selected rows in the table.
in
Builder at line 2736
Builder
timeout(int|null $seconds)
Set a query execution timeout in seconds.
in
Builder at line 2750
Builder
beforeQuery(callable $callback)
Register a closure to be invoked before the query is executed.
in
Builder at line 2760
void
applyBeforeQueryCallbacks()
Invoke the "before query" modification callbacks.
in
Builder at line 2772
Builder
afterQuery(Closure $callback)
Register a closure to be invoked after the query is executed.
in
Builder at line 2782
Collection
applyAfterQueryCallbacks(Collection $result)
Invoke the "after query" modification callbacks.
in
Builder at line 2794
string
toSql()
Get the SQL representation of the query.
in
Builder at line 2804
string
toRawSql()
Get the raw SQL representation of the query with embedded bindings.
in
Builder at line 2817
object|array|null
find(int|string $id, Expression|array|string $columns = ['*'])
Execute a query for a single record by ID.
in
Builder at line 2831
mixed
findOr(mixed $id, Closure|Expression|array|string $columns = ['*'], Closure|null $callback = null)
Execute a query for a single record by ID or call a callback.
in
Builder at line 2849
mixed
value(string $column)
Get a single column's value from the first result of a query.
in
Builder at line 2859
mixed
rawValue(string $expression, array $bindings = [])
Get a single expression value from the first result of a query.
in
Builder at line 2872
mixed
soleValue(string $column)
Get a single column's value from the first result of a query if it's the sole matching record.
in
Builder at line 2885
Collection
get(Expression|array|string $columns = ['*'])
Execute the query as a "select" statement.
in
Builder at line 2899
protected array
runSelect()
Run the query as a "select" statement against the connection.
in
Builder at line 2912
protected Collection
withoutGroupLimitKeys(Collection $items)
Remove the group limit keys from the results in the collection.
in
Builder at line 2937
LengthAwarePaginator
paginate(int|Closure $perPage = 15, Expression|array|string $columns = ['*'], string $pageName = 'page', int|null $page = null, Closure|int|null $total = null)
Paginate the given query into a simple paginator.
in
Builder at line 2965
Paginator
simplePaginate(int $perPage = 15, Expression|array|string $columns = ['*'], string $pageName = 'page', int|null $page = null)
Get a paginator only supporting simple next and previous links.
This is more efficient on larger data-sets, etc.
in
Builder at line 2988
CursorPaginator
cursorPaginate(int|null $perPage = 15, Expression|array|string $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)
Get a paginator only supporting simple next and previous links.
This is more efficient on larger data-sets, etc.
in
Builder at line 3000
protected Collection
ensureOrderForCursorPagination(bool $shouldReverse = false)
Ensure the proper order by required for cursor pagination.
in
Builder at line 3034
int
getCountForPagination(array $columns = ['*'])
Get the count of the total records for the paginator.
in
Builder at line 3057
protected array
runPaginationCountQuery(array $columns = ['*'])
Run a pagination count query.
in
Builder at line 3084
protected Builder
cloneForPaginationCount()
Clone the existing query instance for usage in a pagination subquery.
in
Builder at line 3096
protected array
withoutSelectAliases(array $columns)
Remove the column aliases since they will break count queries.
in
Builder at line 3110
LazyCollection
cursor()
Get a lazy collection for the given query.
in
Builder at line 3133
protected void
enforceOrderBy()
Throw an exception if the query doesn't have an orderBy clause.
in
Builder at line 3145
Collection
pluck(Expression|string $column, string|null $key = null)
Get a collection instance containing the values of a given column.
in
Builder at line 3181
protected string|null
stripTableForPluck(Expression|string|null $column)
Strip off the table name or alias from a column identifier.
in
Builder at line 3199
protected Collection
pluckFromObjectColumn(array $queryResult, string $column, string|null $key)
Retrieve column values from rows represented as objects.
in
Builder at line 3219
protected Collection
pluckFromArrayColumn(array $queryResult, string $column, string|null $key)
Retrieve column values from rows represented as arrays.
in
Builder at line 3239
string
implode(string $column, string $glue = '')
Concatenate values of a given column as a string.
in
Builder at line 3247
bool
exists()
Determine if any rows exist for the current query.
in
Builder at line 3273
bool
doesntExist()
Determine if no rows exist for the current query.
in
Builder at line 3281
mixed
existsOr(Closure $callback)
Execute the given callback if no rows exist for the current query.
in
Builder at line 3289
mixed
doesntExistOr(Closure $callback)
Execute the given callback if rows exist for the current query.
in
Builder at line 3299
int
count(Expression|string $columns = '*')
Retrieve the "count" result of the query.
in
Builder at line 3307
mixed
min(Expression|string $column)
Retrieve the minimum value of a given column.
in
Builder at line 3315
mixed
max(Expression|string $column)
Retrieve the maximum value of a given column.
in
Builder at line 3323
mixed
sum(Expression|string $column)
Retrieve the sum of the values of a given column.
in
Builder at line 3333
mixed
avg(Expression|string $column)
Retrieve the average of the values of a given column.
in
Builder at line 3341
mixed
average(Expression|string $column)
Alias for the "avg" method.
in
Builder at line 3349
mixed
aggregate(string $function, array $columns = ['*'])
Execute an aggregate function on the database.
in
Builder at line 3366
float|int
numericAggregate(string $function, array $columns = ['*'])
Execute a numeric aggregate function on the database.
in
Builder at line 3394
protected Builder
setAggregate(string $function, array $columns)
Set the aggregate property without running the query.
in
Builder at line 3418
protected mixed
onceWithColumns(array $columns, callable $callback)
Execute the given callback while selecting the given columns.
After running the callback, the columns are reset to the original value.
in
Builder at line 3436
bool
insert(array $values)
Insert new records into the database.
in
Builder at line 3476
int
insertOrIgnore(array $values)
Insert new records into the database while ignoring errors.
in
Builder at line 3507
Collection
insertOrIgnoreReturning(array $values, array $returning = ['*'], array|string|null $uniqueBy = null)
Insert records while ignoring conflicts and return the inserted rows.
in
Builder at line 3555
int|string
insertGetId(array $values, string|null $sequence = null)
Insert a new record and get the value of the primary key.
in
Builder at line 3571
int
insertUsing(array $columns, Closure|Builder|Builder|string $query)
Insert new records into the table using a subquery.
in
Builder at line 3588
int
insertOrIgnoreUsing(array $columns, Closure|Builder|Builder|string $query)
Insert new records into the table using a subquery while ignoring errors.
in
Builder at line 3605
int
update(array $values)
Update records in the database.
in
Builder at line 3635
int
updateFrom(array $values)
Update records in a PostgreSQL database using the update from syntax.
in
Builder at line 3655
bool
updateOrInsert(array $attributes, array|callable $values = [])
Insert or update a record matching the attributes, and fill it with values.
in
Builder at line 3677
int
upsert(array $values, array|string $uniqueBy, array|null $update = null)
Insert new records or update the existing ones.
in
Builder at line 3722
int
increment(string $column, mixed $amount = 1, array $extra = [])
Increment a column's value by a given amount.
in
Builder at line 3740
int
incrementEach(array $columns, array $extra = [])
Increment the given column's values by the given amounts.
in
Builder at line 3765
int
decrement(string $column, mixed $amount = 1, array $extra = [])
Decrement a column's value by a given amount.
in
Builder at line 3783
int
decrementEach(array $columns, array $extra = [])
Decrement the given column's values by the given amounts.
in
Builder at line 3795
int
delete(mixed $id = null)
Delete records from the database.
in
Builder at line 3817
void
truncate()
Run a "truncate" statement on the table.
in
JoinClause at line 106
Builder
newQuery()
Get a new instance of the join clause builder.
in
JoinClause at line 114
protected Builder
forSubQuery()
Create a new query instance for sub-query.
in
Builder at line 3847
array
getColumns()
Get all of the query builder's columns in a text-only array with all expressions evaluated.
in
Builder at line 3857
Expression
raw(mixed $value)
Create a raw database expression.
in
Builder at line 3865
protected Collection
getUnionBuilders()
Get the query builder instances that are used in the union of the query.
in
Builder at line 3875
int|null
getLimit()
Get the "limit" value for the query or null if it's not set.
in
Builder at line 3885
int|null
getOffset()
Get the "offset" value for the query or null if it's not set.
in
Builder at line 3897
array
getBindings()
Get the current query value bindings in a flattened array.
in
Builder at line 3917
array
getRawBindings()
Get the raw array of bindings.
in
Builder at line 3930
Builder
setBindings(array $bindings, string $type = 'where')
Set the bindings on the query builder.
in
Builder at line 3948
Builder
addBinding(mixed $value, string $type = 'where')
Add a binding to the query.
in
Builder at line 3969
mixed
castBinding(mixed $value)
Cast the given binding value.
in
Builder at line 3981
Builder
mergeBindings(Builder $query)
Merge an array of bindings into our bindings.
in
Builder at line 3994
array
cleanBindings(array $bindings)
Remove all of the expressions from a list of bindings.
in
Builder at line 4008
protected mixed
flattenValue(mixed $value)
Get a scalar type value from an unknown type of input.
in
Builder at line 4016
protected string
defaultKeyName()
Get the default key name of the table.
in
Builder at line 4024
ConnectionInterface
getConnection()
Get the database connection instance.
in
Builder at line 4032
protected void
ensureConnectionSupportsVectors()
Ensure the database connection supports vector queries.
in
Builder at line 4058
Builder
useWritePdo()
Use the "write" PDO connection when executing the query.
in
Builder at line 4068
Builder
fetchUsing(mixed ...$fetchUsing)
Set the PDO fetch mode arguments for the query.
in
Builder at line 4078
protected bool
isQueryable(mixed $value)
Determine if the value is a query builder instance or a Closure.
in
Builder at line 4097
Builder
cloneWithout(array $properties)
Clone the query without the given properties.
in
Builder at line 4109
Builder
cloneWithoutBindings(array $except)
Clone the query without the given bindings.
in
Builder at line 4145
never
dd()
Die and dump the current SQL and bindings.
in
Builder at line 4153
never
ddRawSql()
Die and dump the current SQL with embedded bindings.
in
Builder at line 4161
static void
flushState()
Flush all static state.
in
JoinClause at line 79
JoinClause
on(Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null, string $boolean = 'and')
Add an "on" clause to the join.
On clauses can be chained, e.g.
$join->on('contacts.user_id', '=', 'users.id') ->on('contacts.info_id', '=', 'info.id')
will produce the following SQL:
on contacts.user_id = users.id and contacts.info_id = info.id
in
JoinClause at line 95
JoinClause
orOn(Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null)
Add an "or on" clause to the join.
in
JoinClause at line 122
protected Builder
newParentQuery()
Create a new parent query instance.