Class Illuminate\Database\Query\Builder

`uses`	`BuildsQueries, ExplainsQueries, ForwardsCalls, Macroable`


					
	public

__construct(ConnectionInterface $connection, Grammar|null $grammar = null, Processor|null $processor = null): void

Create a new query builder instance.

#


					
	public

select(array|mixed $columns = ['*']): $this

Set the columns to be selected.

#


					
	public

selectSub(Closure|Builder|Builder|string $query, string $as): $this

Add a subselect expression to the query.

Throws

InvalidArgumentException

#


					
	public

selectRaw(string $expression, array $bindings = []): $this

Add a new "raw" select expression to the query.

#


					
	public

fromSub(Closure|Builder|string $query, string $as): $this

Makes "from" fetch from a subquery.

Throws

InvalidArgumentException

#


					
	public

fromRaw(string $expression, mixed $bindings = []): $this

Add a raw from clause to the query.

#


					
	public

addSelect(array|mixed $column): $this

Add a new select column to the query.

#


					
	public

distinct(): $this

Force the query to only return distinct results.

#


					
	public

from(Closure|Builder|string $table, string|null $as = null): $this

Set the table which the query is targeting.

#


					
	public

join(
	string $table,
	Closure|string $first,
	string|null $operator = null,
	string|null $second = null,
	string $type = 'inner',
	bool $where = false,
): $this

Add a join clause to the query.

#


					
	public

joinWhere(string $table, Closure|string $first, string $operator, string $second, string $type = 'inner'): $this

Add a "join where" clause to the query.

#


					
	public

joinSub(
	Closure|Builder|Builder|string $query,
	string $as,
	Closure|string $first,
	string|null $operator = null,
	string|null $second = null,
	string $type = 'inner',
	bool $where = false,
): $this

Add a subquery join clause to the query.

Throws

InvalidArgumentException

#


					
	public

leftJoin(string $table, Closure|string $first, string|null $operator = null, string|null $second = null): $this

Add a left join to the query.

#


					
	public

leftJoinWhere(string $table, Closure|string $first, string $operator, string $second): $this

Add a "join where" clause to the query.

#


					
	public

leftJoinSub(
	Closure|Builder|Builder|string $query,
	string $as,
	Closure|string $first,
	string|null $operator = null,
	string|null $second = null,
): $this

Add a subquery left join to the query.

#


					
	public

rightJoin(string $table, Closure|string $first, string|null $operator = null, string|null $second = null): $this

Add a right join to the query.

#


					
	public

rightJoinWhere(string $table, Closure|string $first, string $operator, string $second): $this

Add a "right join where" clause to the query.

#


					
	public

rightJoinSub(
	Closure|Builder|Builder|string $query,
	string $as,
	Closure|string $first,
	string|null $operator = null,
	string|null $second = null,
): $this

Add a subquery right join to the query.

#


					
	public

crossJoin(
	string $table,
	Closure|string|null $first = null,
	string|null $operator = null,
	string|null $second = null,
): $this

Add a "cross join" clause to the query.

#


					
	public

crossJoinSub(Closure|Builder|string $query, string $as): $this

Add a subquery cross join to the query.

#


					
	public

mergeWheres(array $wheres, array $bindings): void

Merge an array of where clauses and bindings.

#


					
	public

where(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and'): $this

Add a basic where clause to the query.

#


					
	public

prepareValueAndOperator(string $value, string $operator, bool $useDefault = false): array

Prepare the value and operator for a where clause.

Throws

InvalidArgumentException

#


					
	public

orWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null): $this

Add an "or where" clause to the query.

#


					
	public

whereColumn(
	string|array $first,
	string|null $operator = null,
	string|null $second = null,
	string|null $boolean = 'and',
): $this

Add a "where" clause comparing two columns to the query.

#


					
	public

orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null): $this

Add an "or where" clause comparing two columns to the query.

#


					
	public

whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and'): $this

Add a raw where clause to the query.

#


					
	public

orWhereRaw(string $sql, mixed $bindings = []): $this

Add a raw or where clause to the query.

#


					
	public

whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false): $this

Add a "where in" clause to the query.

#


					
	public

orWhereIn(string $column, mixed $values): $this

Add an "or where in" clause to the query.

#


					
	public

whereNotIn(string $column, mixed $values, string $boolean = 'and'): $this

Add a "where not in" clause to the query.

#


					
	public

orWhereNotIn(string $column, mixed $values): $this

Add an "or where not in" clause to the query.

#


					
	public

whereIntegerInRaw(string $column, Arrayable|array $values, string $boolean = 'and', bool $not = false): $this

Add a "where in raw" clause for integer values to the query.

#


					
	public

orWhereIntegerInRaw(string $column, Arrayable|array $values): $this

Add an "or where in raw" clause for integer values to the query.

#


					
	public

whereIntegerNotInRaw(string $column, Arrayable|array $values, string $boolean = 'and'): $this

Add a "where not in raw" clause for integer values to the query.

#


					
	public

orWhereIntegerNotInRaw(string $column, Arrayable|array $values): $this

Add an "or where not in raw" clause for integer values to the query.

#


					
	public

whereNull(string|array $columns, string $boolean = 'and', bool $not = false): $this

Add a "where null" clause to the query.

#


					
	public

orWhereNull(string|array $column): $this

Add an "or where null" clause to the query.

#


					
	public

whereNotNull(string|array $columns, string $boolean = 'and'): $this

Add a "where not null" clause to the query.

#


					
	public

whereBetween(string|Expression $column, array $values, string $boolean = 'and', bool $not = false): $this

Add a where between statement to the query.

#


					
	public

whereBetweenColumns(string $column, array $values, string $boolean = 'and', bool $not = false): $this

Add a where between statement using columns to the query.

#


					
	public

orWhereBetween(string $column, array $values): $this

Add an or where between statement to the query.

#


					
	public

orWhereBetweenColumns(string $column, array $values): $this

Add an or where between statement using columns to the query.

#


					
	public

whereNotBetween(string $column, array $values, string $boolean = 'and'): $this

Add a where not between statement to the query.

#


					
	public

whereNotBetweenColumns(string $column, array $values, string $boolean = 'and'): $this

Add a where not between statement using columns to the query.

#


					
	public

orWhereNotBetween(string $column, array $values): $this

Add an or where not between statement to the query.

#


					
	public

orWhereNotBetweenColumns(string $column, array $values): $this

Add an or where not between statement using columns to the query.

#


					
	public

orWhereNotNull(string $column): $this

Add an "or where not null" clause to the query.

#


					
	public

whereDate(
	Expression|string $column,
	string $operator,
	DateTimeInterface|string|null $value = null,
	string $boolean = 'and',
): $this

Add a "where date" statement to the query.

#


					
	public

orWhereDate(string $column, string $operator, DateTimeInterface|string|null $value = null): $this

Add an "or where date" statement to the query.

#


					
	public

whereTime(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and'): $this

Add a "where time" statement to the query.

#


					
	public

orWhereTime(string $column, string $operator, DateTimeInterface|string|null $value = null): $this

Add an "or where time" statement to the query.

#


					
	public

whereDay(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and'): $this

Add a "where day" statement to the query.

#


					
	public

orWhereDay(string $column, string $operator, DateTimeInterface|string|null $value = null): $this

Add an "or where day" statement to the query.

#


					
	public

whereMonth(
	string $column,
	string $operator,
	DateTimeInterface|string|null $value = null,
	string $boolean = 'and',
): $this

Add a "where month" statement to the query.

#


					
	public

orWhereMonth(string $column, string $operator, DateTimeInterface|string|null $value = null): $this

Add an "or where month" statement to the query.

#


					
	public

whereYear(
	string $column,
	string $operator,
	DateTimeInterface|string|int|null $value = null,
	string $boolean = 'and',
): $this

Add a "where year" statement to the query.

#


					
	public

orWhereYear(string $column, string $operator, DateTimeInterface|string|int|null $value = null): $this

Add an "or where year" statement to the query.

#


					
	public

whereNested(Closure $callback, string $boolean = 'and'): $this

Add a nested where statement to the query.

#


					
	public

forNestedWhere(): Builder

Create a new query instance for nested where condition.

#


					
	public

addNestedWhereQuery(Builder $query, string $boolean = 'and'): $this

Add another query builder as a nested where to the query builder.

#


					
	public

whereExists(Closure $callback, string $boolean = 'and', bool $not = false): $this

Add an exists clause to the query.

#


					
	public

orWhereExists(Closure $callback, bool $not = false): $this

Add an or exists clause to the query.

#


					
	public

whereNotExists(Closure $callback, string $boolean = 'and'): $this

Add a where not exists clause to the query.

#


					
	public

orWhereNotExists(Closure $callback): $this

Add a where not exists clause to the query.

#


					
	public

addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false): $this

Add an exists clause to the query.

#


					
	public

whereRowValues(array $columns, string $operator, array $values, string $boolean = 'and'): $this

Adds a where condition using row values.

Throws

InvalidArgumentException

#


					
	public

orWhereRowValues(array $columns, string $operator, array $values): $this

Adds an or where condition using row values.

#


					
	public

whereJsonContains(string $column, mixed $value, string $boolean = 'and', bool $not = false): $this

Add a "where JSON contains" clause to the query.

#


					
	public

orWhereJsonContains(string $column, mixed $value): $this

Add an "or where JSON contains" clause to the query.

#


					
	public

whereJsonDoesntContain(string $column, mixed $value, string $boolean = 'and'): $this

Add a "where JSON not contains" clause to the query.

#


					
	public

orWhereJsonDoesntContain(string $column, mixed $value): $this

Add an "or where JSON not contains" clause to the query.

#


					
	public

whereJsonLength(string $column, mixed $operator, mixed $value = null, string $boolean = 'and'): $this

Add a "where JSON length" clause to the query.

#


					
	public

orWhereJsonLength(string $column, mixed $operator, mixed $value = null): $this

Add an "or where JSON length" clause to the query.

#


					
	public

dynamicWhere(string $method, array $parameters): $this

Handles dynamic "where" clauses to the query.

#


					
	public

whereFullText(string|string[] $columns, string $value, array $options = [], string $boolean = 'and'): $this

Add a "where fulltext" clause to the query.

#


					
	public

orWhereFullText(string|string[] $columns, string $value, array $options = []): $this

Add a "or where fulltext" clause to the query.

#


					
	public

groupBy(array|string ...$groups): $this

Add a "group by" clause to the query.

#


					
	public

groupByRaw(string $sql, array $bindings = []): $this

Add a raw groupBy clause to the query.

#


					
	public

having(string $column, string|null $operator = null, string|null $value = null, string $boolean = 'and'): $this

Add a "having" clause to the query.

#


					
	public

orHaving(string $column, string|null $operator = null, string|null $value = null): $this

Add an "or having" clause to the query.

#


					
	public

havingBetween(string $column, array $values, string $boolean = 'and', bool $not = false): $this

Add a "having between " clause to the query.

#


					
	public

havingRaw(string $sql, array $bindings = [], string $boolean = 'and'): $this

Add a raw having clause to the query.

#


					
	public

orHavingRaw(string $sql, array $bindings = []): $this

Add a raw or having clause to the query.

#


					
	public

orderBy(Closure|Builder|Builder|Expression|string $column, string $direction = 'asc'): $this

Add an "order by" clause to the query.

Throws

InvalidArgumentException

#


					
	public

orderByDesc(Closure|Builder|Builder|Expression|string $column): $this

Add a descending "order by" clause to the query.

#


					
	public

latest(Closure|Builder|Builder|Expression|string $column = 'created_at'): $this

Add an "order by" clause for a timestamp to the query.

#


					
	public

oldest(Closure|Builder|Builder|Expression|string $column = 'created_at'): $this

Add an "order by" clause for a timestamp to the query.

#


					
	public

inRandomOrder(string $seed = ''): $this

Put the query's results in random order.

#


					
	public

orderByRaw(string $sql, array $bindings = []): $this

Add a raw "order by" clause to the query.

#


					
	public

skip(int $value): $this

Alias to set the "offset" value of the query.

#


					
	public

offset(int $value): $this

Set the "offset" value of the query.

#


					
	public

take(int $value): $this

Alias to set the "limit" value of the query.

#


					
	public

limit(int $value): $this

Set the "limit" value of the query.

#


					
	public

forPage(int $page, int $perPage = 15): $this

Set the limit and offset for a given page.

#


					
	public

forPageBeforeId(int $perPage = 15, int|null $lastId = 0, string $column = 'id'): $this

Constrain the query to the previous "page" of results before a given ID.

#


					
	public

forPageAfterId(int $perPage = 15, int|null $lastId = 0, string $column = 'id'): $this

Constrain the query to the next "page" of results after a given ID.

#


					
	public

reorder(Closure|Builder|Expression|string|null $column = null, string $direction = 'asc'): $this

Remove all existing orders and optionally add a new order.

#


					
	public

union(Builder|Closure $query, bool $all = false): $this

Add a union statement to the query.

#


					
	public

unionAll(Builder|Closure $query): $this

Add a union all statement to the query.

#


					
	public

lock(string|bool $value = true): $this

Lock the selected rows in the table.

#


					
	public

lockForUpdate(): Builder

Lock the selected rows in the table for updating.

#


					
	public

sharedLock(): Builder

Share lock the selected rows in the table.

#


					
	public

beforeQuery(callable $callback): $this

Register a closure to be invoked before the query is executed.

#


					
	public

applyBeforeQueryCallbacks(): void

Invoke the "before query" modification callbacks.

#


					
	public

toSql(): string

Get the SQL representation of the query.

#


					
	public

find(int|string $id, array $columns = ['*']): mixed|static

Execute a query for a single record by ID.

#


					
	public

value(string $column): mixed

Get a single column's value from the first result of a query.

#


					
	public

get(array|string $columns = ['*']): Collection

Execute the query as a "select" statement.

#


					
	public

paginate(
	int $perPage = 15,
	array $columns = ['*'],
	string $pageName = 'page',
	int|null $page = null,
): LengthAwarePaginator

Paginate the given query into a simple paginator.

#


					
	public

simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null): Paginator

Get a paginator only supporting simple next and previous links.

This is more efficient on larger data-sets, etc.

#


					
	public

cursorPaginate(
	int|null $perPage = 15,
	array $columns = ['*'],
	string $cursorName = 'cursor',
	Cursor|string|null $cursor = null,
): CursorPaginator

Get a paginator only supporting simple next and previous links.

This is more efficient on larger data-sets, etc.

#


					
	public

getCountForPagination(array $columns = ['*']): int

Get the count of the total records for the paginator.

#


					
	public

cursor(): LazyCollection

Get a lazy collection for the given query.

#


					
	public

pluck(string $column, string|null $key = null): Collection

Get a collection instance containing the values of a given column.

#


					
	public

implode(string $column, string $glue = ''): string

Concatenate values of a given column as a string.

#


					
	public

exists(): bool

Determine if any rows exist for the current query.

#


					
	public

doesntExist(): bool

Determine if no rows exist for the current query.

#


					
	public

existsOr(Closure $callback): mixed

Execute the given callback if no rows exist for the current query.

#


					
	public

doesntExistOr(Closure $callback): mixed

Execute the given callback if rows exist for the current query.

#


					
	public

count(string $columns = '*'): int

Retrieve the "count" result of the query.

#


					
	public

min(string $column): mixed

Retrieve the minimum value of a given column.

#


					
	public

max(string $column): mixed

Retrieve the maximum value of a given column.

#


					
	public

sum(string $column): mixed

Retrieve the sum of the values of a given column.

#


					
	public

avg(string $column): mixed

Retrieve the average of the values of a given column.

#


					
	public

average(string $column): mixed

Alias for the "avg" method.

#


					
	public

aggregate(string $function, array $columns = ['*']): mixed

Execute an aggregate function on the database.

#


					
	public

numericAggregate(string $function, array $columns = ['*']): float|int

Execute a numeric aggregate function on the database.

#


					
	public

insert(array $values): bool

Insert new records into the database.

#


					
	public

insertOrIgnore(array $values): int

Insert new records into the database while ignoring errors.

#


					
	public

insertGetId(array $values, string|null $sequence = null): int

Insert a new record and get the value of the primary key.

#


					
	public

insertUsing(array $columns, Closure|Builder|string $query): int

Insert new records into the table using a subquery.

#


					
	public

update(array $values): int

Update records in the database.

#


					
	public

updateFrom(array $values): int

Update records in a PostgreSQL database using the update from syntax.

#


					
	public

updateOrInsert(array $attributes, array $values = []): bool

Insert or update a record matching the attributes, and fill it with values.

#


					
	public

upsert(array $values, array|string $uniqueBy, array|null $update = null): int

Insert new records or update the existing ones.

#


					
	public

increment(string $column, float|int $amount = 1, array $extra = []): int

Increment a column's value by a given amount.

Throws

InvalidArgumentException

#


					
	public

decrement(string $column, float|int $amount = 1, array $extra = []): int

Decrement a column's value by a given amount.

Throws

InvalidArgumentException

#


					
	public

delete(mixed $id = null): int

Delete records from the database.

#


					
	public

truncate(): void

Run a truncate statement on the table.

#


					
	public

newQuery(): Builder

Get a new instance of the query builder.

#


					
	public

raw(mixed $value): Expression

Create a raw database expression.

#


					
	public

getBindings(): array

Get the current query value bindings in a flattened array.

#


					
	public

getRawBindings(): array

Get the raw array of bindings.

#


					
	public

setBindings(array $bindings, string $type = 'where'): $this

Set the bindings on the query builder.

Throws

InvalidArgumentException

#


					
	public

addBinding(mixed $value, string $type = 'where'): $this

Add a binding to the query.

Throws

InvalidArgumentException

#


					
	public

castBinding(mixed $value): mixed

Cast the given binding value.

#


					
	public

mergeBindings(Builder $query): $this

Merge an array of bindings into our bindings.

#


					
	public

cleanBindings(array $bindings): array

Remove all of the expressions from a list of bindings.

#


					
	public

getConnection(): ConnectionInterface

Get the database connection instance.

#


					
	public

getProcessor(): Processor

Get the database query processor instance.

#


					
	public

getGrammar(): Grammar

Get the query grammar instance.

#


					
	public

useWritePdo(): $this

Use the write pdo for query.

#


					
	public

clone(): static

Clone the query.

#


					
	public

cloneWithout(array $properties): static

Clone the query without the given properties.

#


					
	public

cloneWithoutBindings(array $except): static

Clone the query without the given bindings.

#


					
	public

dump(): $this

Dump the current SQL and bindings.

#


					
	public

dd(): never

Die and dump the current SQL and bindings.

#


					
	public

__call(string $method, array $parameters): mixed

Handle dynamic method calls into the method.

Throws

BadMethodCallException

#

Properties
`public`	`ConnectionInterface`	`$connection`	#
`public`	`Grammar`	`$grammar`	#
`public`	`Processor`	`$processor`	#
`public`	`array`	`$bindings = [ 'select' => [], 'from' => [], 'join' => [], 'where' => [], 'groupBy' => [], 'having' => [], 'order' => [], 'union' => [], 'unionOrder' => [], ]`	#
`public`	`array`	`$aggregate`	#
`public`	`array`	`$columns`	#
`public`	`bool\|array`	`$distinct = false`	#
`public`	`string`	`$from`	#
`public`	`array`	`$joins`	#
`public`	`array`	`$wheres = []`	#
`public`	`array`	`$groups`	#
`public`	`array`	`$havings`	#
`public`	`array`	`$orders`	#
`public`	`int`	`$limit`	#
`public`	`int`	`$offset`	#
`public`	`array`	`$unions`	#
`public`	`int`	`$unionLimit`	#
`public`	`int`	`$unionOffset`	#
`public`	`array`	`$unionOrders`	#
`public`	`string\|bool`	`$lock`	#
`public`	`array`	`$beforeQueryCallbacks = []`	#
`public`	`string[]`	`$operators = [ '=', '<', '>', '<=', '>=', '<>', '!=', '<=>', 'like', 'like binary', 'not like', 'ilike', '&', '\|', '^', '<<', '>>', '&~', 'rlike', 'not rlike', 'regexp', 'not regexp', '~', '~', '!~', '!~', 'similar to', 'not similar to', 'not ilike', '~~', '!~~', ]`	#
`public`	`string[]`	`$bitwiseOperators = ['&', '\|', '^', '<<', '>>', '&~']`	#
`public`	`bool`	`$useWritePdo = false`	#

Namespaces

Classes

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws