Строитель

класс Builder (Просмотреть исходный код)

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый Connection	$connection	Экземпляр подключения к базе данных.
защищённый Grammar	$grammar	Экземпляр синтаксического анализатора запросов к базе данных.
защищённый Processor	$processor	Экземпляр постпроцессора запросов к базе данных.
защищённый массив	$bindings	Текущие значения связываемых данных запроса.
массив	$aggregate	Функция агрегирования и столбец для выполнения.
массив	$columns	Столбцы, которые должны быть возвращены.
логическое значение	$distinct	Указывает, возвращает ли запрос уникальные результаты.
строка	$from	Таблица, на которую нацелен запрос.
массив	$joins	Соединения таблиц для запроса.
массив	$wheres	Условия WHERE для запроса.
массив	$groups	Группировки для запроса.
массив	$havings	Условия HAVING для запроса.
массив	$orders	Сортировки для запроса.
целое число	$limit	Максимальное количество записей для возврата.
целое число	$offset	Количество записей для пропуска.
массив	$unions	Заявления объединения запроса.
целое число	$unionLimit	Максимальное число записей объединения для возврата.
целое число	$unionOffset	Количество записей объединения для пропуска.
массив	$unionOrders	Сортировки для запроса объединения.
строка\|логическое значение	$lock	Указывает, используется ли блокировка строк.
защищённый массив	$backups	Текущие резервные копии полей.
защищённый массив	$bindingBackups	Текущие резервные копии связывания данных.
защищённый массив	$operators	Все доступные операторы предложений.
защищённый булево значение	$useWritePdo	Использовать ли write pdo для выборки.

Методы

static void	macro(string $name, callable $macro) Зарегистрировать пользовательский макрос.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирован ли макрос.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	from Macroable
mixed	__call(string $method, array $parameters) Обработка динамических вызовов методов в метод.
void	__construct(ConnectionInterface $connection, Grammar $grammar, Processor $processor) Создать новый экземпляр построителя запросов.
$this	select(array\|mixed $columns = ['*']) Установить столбцы для выбора.
Builder\|Builder	selectRaw(string $expression, array $bindings = []) Добавить новое "сырое" выражение select в запрос.
Builder\|Builder	selectSub(Closure\|Builder\|string $query, string $as) Добавить выражение подзапроса в запрос.
$this	addSelect(array\|mixed $column) Добавить новый столбец select в запрос.
$this	distinct() Принудительно вернуть только уникальные результаты.
$this	from(string $table) Установить таблицу, на которую нацелен запрос.
$this	join(string $table, string $one, string $operator = null, string $two = null, string $type = 'inner', bool $where = false) Добавить предложение join к запросу.
Builder\|Builder	joinWhere(string $table, string $one, string $operator, string $two, string $type = 'inner') Добавить предложение "join where" к запросу.
Builder\|Builder	leftJoin(string $table, string $first, string $operator = null, string $second = null) Добавить левое соединение к запросу.
Builder\|Builder	leftJoinWhere(string $table, string $one, string $operator, string $two) Добавить предложение "join where" к запросу.
Builder\|Builder	rightJoin(string $table, string $first, string $operator = null, string $second = null) Добавить правое соединение к запросу.
Builder\|Builder	rightJoinWhere(string $table, string $one, string $operator, string $two) Добавить предложение "right join where" к запросу.
$this	where(string\|array\|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and') Добавить базовое предложение where к запросу.
Builder\|Builder	orWhere(string $column, string $operator = null, mixed $value = null) Добавить предложение "or where" к запросу.
bool	invalidOperatorAndValue(string $operator, mixed $value) Определить, является ли данная комбинация оператора и значения допустимой.
$this	whereRaw(string $sql, array $bindings = [], string $boolean = 'and') Добавить "сырое" предложение where к запросу.
Builder\|Builder	orWhereRaw(string $sql, array $bindings = []) Добавить "сырое" предложение or where к запросу.
$this	whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false) Добавить предложение where between к запросу.
Builder\|Builder	orWhereBetween(string $column, array $values) Добавить предложение or where between к запросу.
Builder\|Builder	whereNotBetween(string $column, array $values, string $boolean = 'and') Добавить предложение where not between к запросу.
Builder\|Builder	orWhereNotBetween(string $column, array $values) Добавить предложение or where not between к запросу.
Builder\|Builder	whereNested(Closure $callback, string $boolean = 'and') Добавить вложенное предложение where к запросу.
$this	addNestedWhereQuery(Builder\|Builder $query, string $boolean = 'and') Добавить ещё один построитель запросов как вложенное where к построителю запросов.
$this	whereSub(string $column, string $operator, Closure $callback, string $boolean) Добавить полный подзапрос к запросу.
$this	whereExists(Closure $callback, string $boolean = 'and', bool $not = false) Добавить предложение exists к запросу.
Builder\|Builder	orWhereExists(Closure $callback, bool $not = false) Добавить предложение or exists к запросу.
Builder\|Builder	whereNotExists(Closure $callback, string $boolean = 'and') Добавить предложение where not exists к запросу.

Builder\|Builder	orWhereNotExists(Closure $callback) Добавить условие «where not exists» к запросу.
$this	whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false) Добавить условие «where in» к запросу.
Builder\|Builder	orWhereIn(string $column, mixed $values) Добавить условие «or where in» к запросу.
Builder\|Builder	whereNotIn(string $column, mixed $values, string $boolean = 'and') Добавить условие «where not in» к запросу.
Builder\|Builder	orWhereNotIn(string $column, mixed $values) Добавить условие «or where not in» к запросу.
$this	whereInSub(string $column, Closure $callback, string $boolean, bool $not) Добавить условие «where in» с подзапросом к запросу.
$this	whereInExistingQuery(string $column, Builder\|Builder $query, string $boolean, bool $not) Добавить внешний подзапрос к запросу.
$this	whereNull(string $column, string $boolean = 'and', bool $not = false) Добавить условие «where null» к запросу.
Builder\|Builder	orWhereNull(string $column) Добавить условие «or where null» к запросу.
Builder\|Builder	whereNotNull(string $column, string $boolean = 'and') Добавить условие «where not null» к запросу.
Builder\|Builder	orWhereNotNull(string $column) Добавить условие «or where not null» к запросу.
Builder\|Builder	whereDate(string $column, string $operator, int $value, string $boolean = 'and') Добавить условие «where date» к запросу.
Builder\|Builder	whereDay(string $column, string $operator, int $value, string $boolean = 'and') Добавить условие «where day» к запросу.
Builder\|Builder	whereMonth(string $column, string $operator, int $value, string $boolean = 'and') Добавить условие «where month» к запросу.
Builder\|Builder	whereYear(string $column, string $operator, int $value, string $boolean = 'and') Добавить условие «where year» к запросу.
$this	addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and') Добавить условие, основанное на дате (год, месяц, день), к запросу.
$this	dynamicWhere(string $method, string $parameters) Обрабатывает динамические условия «where» для запроса.
void	addDynamic(string $segment, string $connector, array $parameters, int $index) Добавить отдельное динамическое условие «where» в запрос.
$this	groupBy() Добавить условие «group by» к запросу.
$this	having(string $column, string $operator = null, string $value = null, string $boolean = 'and') Добавить условие «having» к запросу.
Builder\|Builder	orHaving(string $column, string $operator = null, string $value = null) Добавить условие «or having» к запросу.
$this	havingRaw(string $sql, array $bindings = [], string $boolean = 'and') Добавить простое условие «having» к запросу.
Builder\|Builder	orHavingRaw(string $sql, array $bindings = []) Добавить условие «or having» с сырой строкой SQL к запросу.
$this	orderBy(string $column, string $direction = 'asc') Добавить условие «order by» к запросу.
Builder\|Builder	latest(string $column = 'created_at') Добавить условие «order by» для временной метки в запрос.
Builder\|Builder	oldest(string $column = 'created_at') Добавить условие «order by» для временной метки в запрос.
$this	orderByRaw(string $sql, array $bindings = []) Добавить сырое условие «order by» в запрос.
$this	offset(int $value) Установить значение «offset» запроса.
Builder\|Builder	skip(int $value) Псевдоним для установки значения «offset» запроса.
$this	limit(int $value) Установить значение «limit» запроса.
Builder\|Builder	take(int $value) Псевдоним для установки значения «limit» запроса.
Builder\|Builder	forPage(int $page, int $perPage = 15) Установить limit и offset для заданной страницы.
Builder\|Builder	union(Builder\|Closure $query, bool $all = false) Добавить оператор union к запросу.

Builder\|Builder	unionAll(Builder\|Closure $query) Добавить оператор объединения union all в запрос.
$this	lock(bool $value = true) Заблокировать выбранные строки в таблице.
Builder	lockForUpdate() Заблокировать выбранные строки в таблице для обновления.
Builder	sharedLock() Заблокировать выбранные строки в таблице поделенным замком.
string	toSql() Получить SQL-представление запроса.
mixed\|Builder	find(int $id, array $columns = ['*']) Выполнить запрос для получения одной записи по ID.
mixed	value(string $column) Получить значение одного столбца из первого результата запроса.
mixed	pluck(string $column) ^{устаревший} Получить значение одного столбца из первого результата запроса.
mixed\|Builder	first(array $columns = ['*']) Выполнить запрос и получить первый результат.
array\|Builder[]	get(array $columns = ['*']) Выполнить запрос как оператор «select».
array\|Builder[]	getFresh(array $columns = ['*']) ^{устаревший} Выполнить запрос как новый оператор «select».
array	runSelect() Выполнить запрос как оператор «select» к соединению.
LengthAwarePaginator	paginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int\|null $page = null) Разбить заданный запрос на страницы с помощью простого пагинатора.
Paginator	simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page') Получить пагинатор, поддерживающий только простые ссылки «следующая» и «предыдущая».
int	getCountForPagination(array $columns = ['*']) Получить количество всех записей для пагинатора.
void	backupFieldsForCount() Создать резервную копию некоторых полей для подсчета страниц.
array	clearSelectAliases(array $columns) Удалить псевдонимы столбцов, так как они приведут к ошибке в запросах подсчета.
void	restoreFieldsForCount() Восстановить некоторые поля после подсчета страниц.
bool	chunk(int $count, callable $callback) Разбить результаты запроса на части.
array	lists(string $column, string\|null $key = null) Получить массив со значениями заданного столбца.
string\|null	stripTableForPluck(string $column) Убрать имя таблицы или псевдоним из идентификатора столбца.
string	implode(string $column, string $glue = '') Склеить значения заданного столбца в строку.
bool	exists() Определить, существуют ли строки для текущего запроса.
int	count(string $columns = '*') Получить результат «count» запроса.
mixed	min(string $column) Получить минимальное значение заданного столбца.
mixed	max(string $column) Получить максимальное значение заданного столбца.
mixed	sum(string $column) Получить сумму значений заданного столбца.
mixed	avg(string $column) Получить среднее значение значений заданного столбца.
mixed	average(string $column) Псевдоним для метода «avg».
mixed	aggregate(string $function, array $columns = ['*']) Выполнить агрегатную функцию в базе данных.
float\|int	numericAggregate(string $function, array $columns = ['*']) Выполнить числовую агрегатную функцию в базе данных.
bool	insert(array $values) Вставить новую запись в базу данных.
int	insertGetId(array $values, string $sequence = null) Вставить новую запись и получить значение первичного ключа.
int	update(array $values) Обновить запись в базе данных.
int	increment(string $column, int $amount = 1, array $extra = []) Увеличить значение столбца на заданную величину.
int	decrement(string $column, int $amount = 1, array $extra = []) Уменьшить значение столбца на заданную величину.
int	delete(mixed $id = null) Удалить запись из базы данных.
void	truncate() Выполнить оператор truncate для таблицы.
Builder	newQuery() Получить новый экземпляр генератора запросов.
void	mergeWheres(array $wheres, array $bindings) Объединить массив условий where и связывающих значений.
array	cleanBindings(array $bindings) Удалить все выражения из списка связывающих значений.
Expression	raw(mixed $value) Создать выражение базы данных в сыром формате.
array	getBindings() Получить текущие связывающие значения запроса в плоском массиве.
array	getRawBindings() Получить исходный массив связывающих значений.

$this	setBindings(array $bindings, string $type = 'where') Установить привязки к билдеру запроса.
$this	addBinding(mixed $value, string $type = 'where') Добавить привязку к запросу.
$this	mergeBindings(Builder $query) Объединить массив привязок в наши привязки.
ConnectionInterface	getConnection() Получить экземпляр подключения к базе данных.
Processor	getProcessor() Получить экземпляр обработчика запросов базы данных.
Grammar	getGrammar() Получить экземпляр грамматики запросов.
$this	useWritePdo() Использовать write pdo для запроса.

Подробности

static void macro(string $name, callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string	$name
callable	$macro

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

void

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

Параметры

string

$name

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

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

void __construct(ConnectionInterface $connection, Grammar $grammar, Processor $processor)

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

Параметры

ConnectionInterface	$connection
Grammar	$grammar
Processor	$processor

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

void

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

Установить столбцы для выбора.

Параметры

array|mixed

$columns

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

$this

Builder|Builder selectRaw(string $expression, array $bindings = [])

Добавить новое выражение "raw" для выбора в запрос.

Параметры

string	$expression
array	$bindings

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

Builder|Builder

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

Добавить подзапрос в запрос.

Параметры

Closure\|Builder\|string	$query
string	$as

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

Builder|Builder

$this addSelect(array|mixed $column)

Добавить новый столбец для выбора в запрос.

Параметры

array|mixed

$column

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

$this

$this distinct()

Вынудить запрос вернуть только уникальные результаты.

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

$this

$this from(string $table)

Установить таблицу, на которую нацелен запрос.

Параметры

string

$table

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

$this

$this join(string $table, string $one, string $operator = null, string $two = null, string $type = 'inner', bool $where = false)

Добавить условие объединения в запрос.

Параметры

string	$table
string	$one
string	$operator
string	$two
string	$type
bool	$where

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

$this

Builder|Builder joinWhere(string $table, string $one, string $operator, string $two, string $type = 'inner')

Добавить условие "join where" в запрос.

Параметры

string	$table
string	$one
string	$operator
string	$two
string	$type

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

Builder|Builder

END_OF_DOCUMENT_MARKER

Builder|Builder leftJoin(string $table, string $first, string $operator = null, string $second = null)

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

Параметры

string	$table
string	$first
string	$operator
string	$second

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

Builder|Builder

Builder|Builder leftJoinWhere(string $table, string $one, string $operator, string $two)

Добавить условие "join where" к запросу.

Параметры

string	$table
string	$one
string	$operator
string	$two

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

Builder|Builder

Builder|Builder rightJoin(string $table, string $first, string $operator = null, string $second = null)

Добавить правое соединение к запросу.

Параметры

string	$table
string	$first
string	$operator
string	$second

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

Builder|Builder

Builder|Builder rightJoinWhere(string $table, string $one, string $operator, string $two)

Добавить условие "right join where" к запросу.

Параметры

string	$table
string	$one
string	$operator
string	$two

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

Builder|Builder

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

Добавить базовое условие where к запросу.

Параметры

string\|array\|Closure	$column
string	$operator
mixed	$value
string	$boolean

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

$this

Исключения

InvalidArgumentException

Builder|Builder orWhere(string $column, string $operator = null, mixed $value = null)

Добавить условие "or where" к запросу.

Параметры

string	$column
string	$operator
mixed	$value

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

Builder|Builder

protected bool invalidOperatorAndValue(string $operator, mixed $value)

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

Параметры

string	$operator
mixed	$value

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

bool

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

Добавить сырое условие where к запросу.

Параметры

string	$sql
array	$bindings
string	$boolean

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

$this

Builder|Builder orWhereRaw(string $sql, array $bindings = [])

Добавить сырое условие or where к запросу.

Параметры

string	$sql
array	$bindings

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

Builder|Builder

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

Добавить условие where between к запросу.

Параметры

string	$column
array	$values
string	$boolean
bool	$not

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

$this

Builder|Builder orWhereBetween(string $column, array $values)

Добавить условие or where between к запросу.

Параметры

string	$column
array	$values

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

Builder|Builder

Builder|Builder whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавить условие where not between к запросу.

Параметры

string	$column
array	$values
string	$boolean

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

Builder|Builder

Builder|Builder orWhereNotBetween(string $column, array $values)

Добавить условие or where not between к запросу.

Параметры

string	$column
array	$values

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

Builder|Builder

Builder|Builder whereNested(Closure $callback, string $boolean = 'and')

Добавить вложенное условие where в запрос.

Parameters

Closure	$callback
string	$boolean

Return Value

Builder|Builder

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

Добавить другой билдер запросов как вложенное условие where к билдеру запросов.

Parameters

Builder\|Builder	$query
string	$boolean

Return Value

$this

protected $this whereSub(string $column, string $operator, Closure $callback, string $boolean)

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

Parameters

string	$column
string	$operator
Closure	$callback
string	$boolean

Return Value

$this

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

Добавить условие exists в запрос.

Parameters

Closure	$callback
string	$boolean
bool	$not

Return Value

$this

Builder|Builder orWhereExists(Closure $callback, bool $not = false)

Добавить условие or exists в запрос.

Parameters

Closure	$callback
bool	$not

Return Value

Builder|Builder

Builder|Builder whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие where not exists в запрос.

Parameters

Closure	$callback
string	$boolean

Return Value

Builder|Builder

Builder|Builder orWhereNotExists(Closure $callback)

Добавить условие or where not exists в запрос.

Parameters

Closure

$callback

Return Value

Builder|Builder

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

Добавить условие "where in" в запрос.

Parameters

string	$column
mixed	$values
string	$boolean
bool	$not

Return Value

$this

Builder|Builder orWhereIn(string $column, mixed $values)

Добавить условие "or where in" в запрос.

Parameters

string	$column
mixed	$values

Return Value

Builder|Builder

Builder|Builder whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие "where not in" в запрос.

Parameters

string	$column
mixed	$values
string	$boolean

Return Value

Builder|Builder

Builder|Builder orWhereNotIn(string $column, mixed $values)

Добавить условие "or where not in" в запрос.

Parameters

string	$column
mixed	$values

Return Value

Builder|Builder

protected $this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

Добавить условие where in с подзапросом в запрос.

Parameters

string	$column
Closure	$callback
string	$boolean
bool	$not

Return Value

$this

protected $this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

Добавить внешний подзапрос к запросу.

Parameters

string	$column
Builder\|Builder	$query
string	$boolean
bool	$not

Return Value

$this

$this whereNull(string $column, string $boolean = 'and', bool $not = false)

Добавить условие "where null" в запрос.

Parameters

string	$column
string	$boolean
bool	$not

Return Value

$this

Builder|Builder orWhereNull(string $column)

Добавить условие "или где null" к запросу.

Parameters

string

$column

Return Value

Builder|Builder

Builder|Builder whereNotNull(string $column, string $boolean = 'and')

Добавить условие "где не null" к запросу.

Parameters

string	$column
string	$boolean

Return Value

Builder|Builder

Builder|Builder orWhereNotNull(string $column)

Добавить условие "или где не null" к запросу.

Parameters

string

$column

Return Value

Builder|Builder

Builder|Builder whereDate(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "где дата" к запросу.

Parameters

string	$column
string	$operator
int	$value
string	$boolean

Return Value

Builder|Builder

Builder|Builder whereDay(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "где день" к запросу.

Parameters

string	$column
string	$operator
int	$value
string	$boolean

Return Value

Builder|Builder

Builder|Builder whereMonth(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "где месяц" к запросу.

Parameters

string	$column
string	$operator
int	$value
string	$boolean

Return Value

Builder|Builder

Builder|Builder whereYear(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "где год" к запросу.

Parameters

string	$column
string	$operator
int	$value
string	$boolean

Return Value

Builder|Builder

protected $this addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день), в запрос.

Parameters

string	$type
string	$column
string	$operator
int	$value
string	$boolean

Return Value

$this

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

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

Параметры

string	$method
string	$parameters

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

$this

protected void addDynamic(string $segment, string $connector, array $parameters, int $index)

Добавляет одно динамическое условие "where" в запрос.

Параметры

string	$segment
string	$connector
array	$parameters
int	$index

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

void

$this groupBy()

Добавляет условие "group by" в запрос.

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

$this

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

Добавляет условие "having" в запрос.

Параметры

string	$column
string	$operator
string	$value
string	$boolean

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

$this

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

Добавляет условие "or having" в запрос.

Параметры

string	$column
string	$operator
string	$value

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

Builder|Builder

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

Добавляет сырое условие "having" в запрос.

Параметры

string	$sql
array	$bindings
string	$boolean

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

$this

Builder|Builder orHavingRaw(string $sql, array $bindings = [])

Добавляет сырое условие "or having" в запрос.

Параметры

string	$sql
array	$bindings

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

Builder|Builder

$this orderBy(string $column, string $direction = 'asc')

Добавить условие "упорядочить по" к запросу.

Параметры

string	$column
string	$direction

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

$this

Builder|Builder latest(string $column = 'created_at')

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

Параметры

string

$column

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

Builder|Builder

Builder|Builder oldest(string $column = 'created_at')

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

Параметры

string

$column

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

Builder|Builder

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

Добавить "упорядочить по" с сырым SQL-запросом.

Параметры

string	$sql
array	$bindings

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

$this

$this offset(int $value)

Установить значение "смещения" запроса.

Параметры

int

$value

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

$this

Builder|Builder skip(int $value)

Псевдоним для установки значения "смещения" запроса.

Параметры

int

$value

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

Builder|Builder

$this limit(int $value)

Установить значение "лимита" запроса.

Параметры

int

$value

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

$this

Builder|Builder take(int $value)

Псевдоним для установки значения "лимита" запроса.

Параметры

int

$value

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

Builder|Builder

Builder|Builder forPage(int $page, int $perPage = 15)

Установить лимит и смещение для заданной страницы.

Параметры

int	$page
int	$perPage

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

Builder|Builder

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

Добавить оператор объединения к запросу.

Параметры

Builder\|Closure	$query
bool	$all

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

Builder|Builder

Builder|Builder unionAll(Builder|Closure $query)

Добавить оператор объединения ALL к запросу.

Параметры

Builder|Closure

$query

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

Builder|Builder

$this lock(bool $value = true)

Заблокировать выбранные строки в таблице.

Параметры

bool

$value

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

$this

Builder lockForUpdate()

Заблокировать выбранные строки в таблице для обновления.

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

Builder

Builder sharedLock()

Заблокировать выбранные строки в таблице совместно.

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

Builder

string toSql()

Получить SQL-представление запроса.

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

string

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

Выполнить запрос для одной записи по ID.

Параметры

int	$id
array	$columns

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

mixed|Builder

mixed value(string $column)

Получить значение одного столбца из первого результата запроса.

Параметры

string

$column

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

mixed

mixed pluck(string $column) ^deprecated

^deprecated

since version 5.1.

Получить значение одного столбца из первого результата запроса.

Это псевдоним для метода "value".

Параметры

string

$column

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

mixed

mixed|Builder first(array $columns = ['*'])

Выполнить запрос и получить первый результат.

Параметры

array

$columns

Значение возврата

mixed|Builder

array|Builder[] get(array $columns = ['*'])

Выполнить запрос в виде оператора «select».

Параметры

array

$columns

Значение возврата

array|Builder[]

array|Builder[] getFresh(array $columns = ['*']) ^{устаревший}

^{устаревший}

с версии версии 5.1. Используйте вместо этого get.

Выполнить запрос как новый оператор «select».

Параметры

array

$columns

Значение возврата

array|Builder[]

protected array runSelect()

Выполнить запрос в виде оператора «select» на подключении.

Значение возврата

array

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

Разбить заданный запрос на страницы с помощью пагинатора.

Параметры

int	$perPage
array	$columns
string	$pageName
int\|null	$page

Значение возврата

LengthAwarePaginator

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

Получить пагинатор, поддерживающий только ссылки «следующая» и «предыдущая».

Это более эффективно для больших наборов данных и т. д.

Параметры

int	$perPage
array	$columns
string	$pageName

Значение возврата

Paginator

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

Получить количество всех записей для пагинатора.

Параметры

array

$columns

Значение возврата

int

protected void backupFieldsForCount()

Создать резервную копию некоторых полей для подсчета страниц.

Значение возврата

void

protected array clearSelectAliases(array $columns)

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

Параметры

array

$columns

Значение возврата

array

protected void restoreFieldsForCount()

Восстановить некоторые поля после подсчета страниц.

Значение возврата

void

bool chunk(int $count, callable $callback)

Разбить результаты запроса на части.

Параметры

int	$count
callable	$callback

Значение возврата

bool

array lists(string $column, string|null $key = null)

Получить массив со значениями заданного столбца.

Параметры

string	$column
string\|null	$key

Значение возврата

array

protected string|null stripTableForPluck(string $column)

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

Параметры

string

$column

Значение возврата

string|null

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

Объединить значения заданного столбца в строку.

Параметры

string	$column
string	$glue

Значение возврата

string

bool exists()

Определить, существуют ли какие-либо строки для текущего запроса.

Значение возврата

bool

int count(string $columns = '*')

Получить результат «count» запроса.

Параметры

string

$columns

Значение возврата

int

mixed min(string $column)

Получить минимальное значение заданного столбца.

Параметры

string

$column

Значение возврата

mixed

mixed max(string $column)

Получить максимальное значение заданного столбца.

Параметры

string

$column

Значение возврата

mixed

mixed sum(string $column)

Получить сумму значений заданного столбца.

Параметры

string

$column

Значение возврата

mixed

mixed avg(string $column)

Получить среднее значение значений заданного столбца.

Параметры

string

$column

Значение возврата

mixed

mixed average(string $column)

Псевдоним для метода "avg".

Parameters

string

$column

Return Value

mixed

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

Выполнение агрегатной функции в базе данных.

Parameters

string	$function
array	$columns

Return Value

mixed

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

Выполнение числовой агрегатной функции в базе данных.

Parameters

string	$function
array	$columns

Return Value

float|int

bool insert(array $values)

Вставка новой записи в базу данных.

Parameters

array

$values

Return Value

bool

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

Вставка новой записи и получение значения первичного ключа.

Parameters

array	$values
string	$sequence

Return Value

int

int update(array $values)

Обновление записи в базе данных.

Parameters

array

$values

Return Value

int

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

Инкрементирование значения столбца на заданную величину.

Parameters

string	$column
int	$amount
array	$extra

Return Value

int

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

Декрементирование значения столбца на заданную величину.

Parameters

string	$column
int	$amount
array	$extra

Return Value

int

int delete(mixed $id = null)

Удаление записи из базы данных.

Parameters

mixed

$id

Return Value

int

void truncate()

Выполнение команды truncate для таблицы.

Return Value

void

Builder newQuery()

Получение нового экземпляра билдера запросов.

Return Value

Builder

void mergeWheres(array $wheres, array $bindings)

Объединение массива условий where и привязок.

Parameters

array	$wheres
array	$bindings

Return Value

void

protected array cleanBindings(array $bindings)

Удаление всех выражений из списка привязок.

Parameters

array

$bindings

Return Value

array

Expression raw(mixed $value)

Создание выражения для базы данных в сыром виде.

Parameters

mixed

$value

Return Value

Expression

array getBindings()

Получение текущих привязок значений запроса в плоском массиве.

Return Value

array

array getRawBindings()

Получение сырого массива привязок.

Return Value

array

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

Установка привязок для билдера запросов.

Parameters

array	$bindings
string	$type

Return Value

$this

Exceptions

InvalidArgumentException

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

Добавление привязки к запросу.

Parameters

mixed	$value
string	$type

Return Value

$this

Exceptions

InvalidArgumentException

$this mergeBindings(Builder $query)

Объединение массива привязок в наши привязки.

Parameters

Builder

$query

Return Value

$this

ConnectionInterface getConnection()

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

Return Value

ConnectionInterface

Processor getProcessor()

Получение экземпляра обработчика запросов базы данных.

Return Value

Processor

Грамматика getGrammar()

Получить экземпляр грамматики запроса.

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

Грамматика

$this useWritePdo()

Использовать write pdo для запроса.

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

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Database/Query/Builder.html