Spec-Zone.ru › Laravel 8

Builder

class Builder (View source)

Трейты

BuildsQueries
ExplainsQueries
ForwardsCalls
Macroable
Conditionable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

from Macroable
ConnectionInterface $connection

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

Grammar $grammar

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

Processor $processor

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

array $bindings

Текущие значения связей запроса.

array $aggregate

Агрегатная функция и столбец для выполнения.

array $columns

Столбцы, которые должны быть возвращены.

bool|array $distinct

Указывает, возвращает ли запрос уникальные результаты.

string $from

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

array $joins

Соединения таблиц для запроса.

array $wheres

Условие запроса.

array $groups

Группировки для запроса.

array $havings

Условие HAVING для запроса.

array $orders

Сортировки для запроса.

int $limit

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

int $offset

Количество записей для пропуска.

array $unions

Операции объединения запроса.

int $unionLimit

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

int $unionOffset

Количество записей объединения для пропуска.

array $unionOrders

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

string|bool $lock

Указывает, используется ли блокировка строк.

array $beforeQueryCallbacks

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

string[] $operators

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

string[] $bitwiseOperators

Все доступные побитовые операторы.

bool $useWritePdo

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

Методы

$this|mixed when(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное "значение" истинно.

из Conditionable
$this|mixed unless(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное "значение" ложно.

из Conditionable
bool chunk(int $count, callable $callback)

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

из BuildsQueries
Collection chunkMap(callable $callback, int $count = 1000)

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

из BuildsQueries
bool each(callable $callback, int $count = 1000)

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

из BuildsQueries
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Разбить результаты запроса на части по сравниванию идентификаторов.

из BuildsQueries
bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

Выполнить обратный вызов для каждого элемента с разбивкой на части по идентификатору.

из BuildsQueries
LazyCollection lazy(int $chunkSize = 1000)

Выполнить запрос лениво, частями заданного размера.

из BuildsQueries
LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

из BuildsQueries
LazyCollection lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

из BuildsQueries
LazyCollection orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)

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

из BuildsQueries
Model|object|BuildsQueries|null first(array|string $columns = ['*'])

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

из BuildsQueries
Model|object|BuildsQueries|null sole(array|string $columns = ['*'])

Выполнить запрос и получить первый результат, если это единственная совпадающая запись.

из BuildsQueries
CursorPaginator paginateUsingCursor(int $perPage, array $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)

Выполнить постраничную навигацию заданного запроса с использованием курсора.

из BuildsQueries
string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)

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

из BuildsQueries
LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

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

из BuildsQueries
Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

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

из BuildsQueries
CursorPaginator cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)

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

из BuildsQueries
$this|mixed tap(callable $callback)

Передать запрос заданному обратному вызову.

из BuildsQueries
Collection explain()

Объяснить запрос.

из ExplainsQueries
mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

из ForwardsCalls
mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту, вернув $this, если перенаправленный вызов вернул себя.

из ForwardsCalls
static void throwBadMethodCallException(string $method)

Выбросить исключение плохого вызова метода для заданного метода.

из ForwardsCalls
static void macro(string $name, object|callable $macro)

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

from Macroable
static void mixin(object $mixin, bool $replace = true)

Включить другой объект в класс.

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

Очистить существующие макросы.

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

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

from Macroable
mixed __call(string $method, array $parameters)

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

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

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

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

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

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

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

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

Добавить новое "сырое" выражение select к запросу.

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

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

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

Добавить сырую инструкцию from к запросу.

array createSub(Closure|Builder|string $query)

Создает подзапрос и разбирает его.

array parseSub(mixed $query)

Разбирает подзапрос в SQL и привязки.

mixed prependDatabaseNameIfCrossDatabaseQuery(mixed $query)

Добавить имя базы данных, если данный запрос находится в другой базе данных.

$this addSelect(array|mixed $column)

Добавить новый столбец select к запросу.

$this distinct()

Принудительно возвращать только уникальные результаты.

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

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

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

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

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

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

$this 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 leftJoin(string $table, Closure|string $first, string|null $operator = null, string|null $second = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

JoinClause newJoinClause(Builder $parentQuery, string $type, string $table)

Получить новое условие соединения.

void mergeWheres(array $wheres, array $bindings)

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

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

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

$this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

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

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

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

bool invalidOperatorAndValue(string $operator, mixed $value)

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

bool invalidOperator(string $operator)

Определить, поддерживается ли данный оператор.

bool isBitwiseOperator(string $operator)

Определить, является ли оператор битовым оператором.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Добавить условие "включено в (целые числа)" к запросу.

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

Добавить условие "или включено в (целые числа)" к запросу.

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

Добавить условие "не включено в (целые числа)" к запросу.

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

Добавить условие "или не включено в (целые числа)" к запросу.

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

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

$this orWhereNull(string|array $column)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$this orWhereNotNull(string $column)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Builder forNestedWhere()

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

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

Добавить другой экземпляр Query Builder как вложенное условие к экземпляру Query Builder.

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

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

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

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

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

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

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

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

$this orWhereNotExists(Closure $callback)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$this inRandomOrder(string $seed = '')

Расположить результаты запроса в случайном порядке.

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

Добавить условие «упорядочить по» с необработанным SQL в запрос.

$this skip(int $value)

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

$this offset(int $value)

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

$this take(int $value)

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

$this limit(int $value)

Установить значение «ограничения» запроса.

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

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

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

Ограничить запрос предыдущей «страницей» результатов перед заданным идентификатором.

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

Ограничить запрос следующей «страницей» результатов после заданного идентификатора.

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

Удалить все существующие сортировки и, при необходимости, добавить новую.

array removeExistingOrdersFor(string $column)

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

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

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

$this unionAll(Builder|Closure $query)

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

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

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

Builder lockForUpdate()

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

Builder sharedLock()

Заблокировать выбранные строки в таблице в режиме совместного доступа.

$this beforeQuery(callable $callback)

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

void applyBeforeQueryCallbacks()

Вызвать модифицирующие обратные вызовы «перед запросом».

string toSql()

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

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

Выполнить запрос для получения одной записи по идентификатору.

mixed value(string $column)

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

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

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

array runSelect()

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

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|null $page = null)

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

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

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

Collection ensureOrderForCursorPagination(bool $shouldReverse = false)

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

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

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

array runPaginationCountQuery(array $columns = ['*'])

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

Builder cloneForPaginationCount()

Создать клон существующего экземпляра запроса для использования в подзапросе пагинации.

array withoutSelectAliases(array $columns)

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

LazyCollection cursor()

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

void enforceOrderBy()

Выбросить исключение, если в запросе нет условия orderBy.

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

Получить экземпляр коллекции, содержащий значения заданного столбца.

string|null stripTableForPluck(string $column)

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

Collection pluckFromObjectColumn(array $queryResult, string $column, string $key)

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

Collection pluckFromArrayColumn(array $queryResult, string $column, string $key)

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

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

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

bool exists()

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

bool doesntExist()

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

mixed existsOr(Closure $callback)

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

mixed doesntExistOr(Closure $callback)

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

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 = ['*'])

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

$this setAggregate(string $function, array $columns)

Установить агрегатную собственность без выполнения запроса.

mixed onceWithColumns(array $columns, callable $callback)

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

bool insert(array $values)

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

int insertOrIgnore(array $values)

Вставить новые записи в базу данных, игнорируя ошибки.

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

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

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

Вставить новые записи в таблицу, используя подзапрос.

int update(array $values)

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

int updateFrom(array $values)

Обновить записи в базе данных PostgreSQL, используя синтаксис update from.

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

Вставить или обновить запись, соответствующую атрибутам, и заполнить её значениями.

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

Вставить новые записи или обновить существующие.

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

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

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

Уменьшить значение столбца на заданное количество.

int delete(mixed $id = null)

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

void truncate()

Выполнить операцию truncate для таблицы.

Builder newQuery()

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

Builder forSubQuery()

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

Expression raw(mixed $value)

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

array getBindings()

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

array getRawBindings()

Получить сырой массив связей.

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

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

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

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

mixed castBinding(mixed $value)

Преобразовать значение заданной связи.

$this mergeBindings(Builder $query)

Слить массив связей в наши связи.

array cleanBindings(array $bindings)

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

mixed flattenValue(mixed $value)

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

string defaultKeyName()

Получить имя стандартного ключа таблицы.

ConnectionInterface getConnection()

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

Processor getProcessor()

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

Grammar getGrammar()

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

$this useWritePdo()

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

bool isQueryable(mixed $value)

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

Builder clone()

Клонировать запрос.

Builder cloneWithout(array $properties)

Клонировать запрос без указанных свойств.

Построитель cloneWithoutBindings(array $except)

Клонировать запрос без указанных связей.

$this dump()

Вывести текущий SQL и связи.

никогда dd()

Прекратить выполнение и вывести текущий SQL и связи.

Подробности

$this|смешанный when(смешанный $value, вызываемая функция $callback, вызываемая функция|null $default = null)

Применить обратный вызов, если заданное «значение» истинно.

Параметры

смешанный $value
вызываемая функция $callback
вызываемая функция|null $default

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

$this|смешанный

$this|смешанный unless(смешанный $value, вызываемая функция $callback, вызываемая функция|null $default = null)

Применить обратный вызов, если заданное «значение» ложно.

Параметры

смешанный $value
вызываемая функция $callback
вызываемая функция|null $default

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

$this|смешанный

bool chunk(int $count, вызываемая функция $callback)

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

Параметры

int $count
вызываемая функция $callback

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

bool

Коллекция chunkMap(вызываемая функция $callback, int $count = 1000)

Выполнить отображение над каждым элементом при разбиении на куски.

Параметры

вызываемая функция $callback
int $count

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

Коллекция

bool each(вызываемая функция $callback, int $count = 1000)

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

Параметры

вызываемая функция $callback
int $count

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

bool

Исключения

RuntimeException

bool chunkById(int $count, вызываемая функция $callback, string|null $column = null, string|null $alias = null)

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

Параметры

int $count
вызываемая функция $callback
string|null $column
string|null $alias

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

bool

bool eachById(вызываемая функция $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

Выполнить обратный вызов над каждым элементом при разбиении на куски по идентификатору.

Параметры

вызываемая функция $callback
int $count
string|null $column
string|null $alias

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

bool

LazyCollection lazy(int $chunkSize = 1000)

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

Параметры

int $chunkSize

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

LazyCollection

Исключения

InvalidArgumentException

LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

Параметры

int $chunkSize
string|null $column
string|null $alias

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

LazyCollection

Исключения

InvalidArgumentException

LazyCollection lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

Параметры

int $chunkSize
string|null $column
string|null $alias

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

LazyCollection

Исключения

InvalidArgumentException

protected LazyCollection orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)

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

Параметры

int $chunkSize
string|null $column
string|null $alias
bool $descending

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

LazyCollection

Исключения

InvalidArgumentException

Модель|объект|BuildsQueries|null first(array|string $columns = ['*'])

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

Параметры

array|string $columns

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

Модель|объект|BuildsQueries|null
END_OF_DOCUMENT_MARKER

Model|object|BuildsQueries|null sole(array|string $columns = ['*'])

Выполнить запрос и получить первый результат, если это единственная соответствующая запись.

Параметры

array|string $columns

Значение результата

Model|object|BuildsQueries|null

Исключения

RecordsNotFoundException
MultipleRecordsFoundException

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

Выполнить постраничную навигацию для заданного запроса с помощью постраничного курсора.

Параметры

int $perPage
array $columns
string $cursorName
Cursor|string|null $cursor

Значение результата

CursorPaginator

protected string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)

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

Параметры

Builder|Builder $builder
string $parameter

Значение результата

string

protected LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

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

Параметры

Collection $items
int $total
int $perPage
int $currentPage
array $options

Значение результата

LengthAwarePaginator

protected Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

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

Параметры

Collection $items
int $perPage
int $currentPage
array $options

Значение результата

Paginator

protected CursorPaginator cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)

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

Параметры

Collection $items
int $perPage
Cursor $cursor
array $options

Значение результата

CursorPaginator

$this|mixed tap(callable $callback)

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

Параметры

callable $callback

Значение результата

$this|mixed

Collection explain()

Объяснить запрос.

Значение результата

Collection

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Параметры

mixed $object
string $method
array $parameters

Значение результата

mixed

Исключения

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода на заданный объект, возвращая $this, если перенаправленный вызов вернул себя.

Параметры

mixed $object
string $method
array $parameters

Значение результата

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Выбросить исключение для вызова несуществующего метода.

Параметры

string $method

Значение результата

void

Исключения

BadMethodCallException

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

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

Параметры

string $name
object|callable $macro

Значение результата

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

object $mixin
bool $replace

Значение результата

void

Исключения

ReflectionException
END_OF_DOCUMENT_MARKER

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

ConnectionInterface $connection
Grammar $grammar
Processor $processor

Return Value

void

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

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

Parameters

array|mixed $columns

Return Value

$this

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

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

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

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

Добавить выражение "сырого" выбора в запрос.

Parameters

string $expression
array $bindings

Return Value

$this

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

Выполняет "from" для выборки из подзапроса.

Parameters

Closure|Builder|string $query
string $as

Return Value

$this

Exceptions

InvalidArgumentException

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

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

Parameters

string $expression
mixed $bindings

Return Value

$this

protected array createSub(Closure|Builder|string $query)

Создает подзапрос и анализирует его.

Parameters

Closure|Builder|string $query

Return Value

array

protected array parseSub(mixed $query)

Анализирует подзапрос в SQL и параметры.

Parameters

mixed $query

Return Value

array

Exceptions

InvalidArgumentException

protected mixed prependDatabaseNameIfCrossDatabaseQuery(mixed $query)

Добавляет имя базы данных, если запрос к другой базе.

Parameters

mixed $query

Return Value

mixed

$this addSelect(array|mixed $column)

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

Parameters

array|mixed $column

Return Value

$this

$this distinct()

Принудительно возвращать только уникальные результаты.

Return Value

$this

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

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

Parameters

Closure|Builder|string $table
string|null $as

Return Value

$this

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

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

Параметры

string $table
Closure|string $first
string|null $operator
string|null $second
string $type
bool $where

Значение результата

$this

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

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

Параметры

string $table
Closure|string $first
string $operator
string $second
string $type

Значение результата

$this

$this 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)

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

Параметры

Closure|Builder|Builder|string $query
string $as
Closure|string $first
string|null $operator
string|null $second
string $type
bool $where

Значение результата

$this

Исключения

InvalidArgumentException

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

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

Параметры

string $table
Closure|string $first
string|null $operator
string|null $second

Значение результата

$this

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

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

Параметры

string $table
Closure|string $first
string $operator
string $second

Значение результата

$this

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

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

Параметры

Closure|Builder|Builder|string $query
string $as
Closure|string $first
string|null $operator
string|null $second

Значение результата

$this

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

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

Параметры

string $table
Closure|string $first
string|null $operator
string|null $second

Значение результата

$this

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

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

Параметры

string $table
Closure|string $first
string $operator
string $second

Значение результата

$this

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

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

Параметры

Closure|Builder|Builder|string $query
string $as
Closure|string $first
string|null $operator
string|null $second

Значение результата

$this

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

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

Параметры

string $table
Closure|string|null $first
string|null $operator
string|null $second

Значение результата

$this

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

Добавить в запрос вложенный перекрёстный JOIN.

Параметры

Closure|Builder|string $query
string $as

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

$this

protected JoinClause newJoinClause(Builder $parentQuery, string $type, string $table)

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

Параметры

Builder $parentQuery
string $type
string $table

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

JoinClause

void mergeWheres(array $wheres, array $bindings)

Объединить массив условий where и связанных значений.

Параметры

array $wheres
array $bindings

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

void

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

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

Параметры

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

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

$this

protected $this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

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

Параметры

array $column
string $boolean
string $method

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

$this

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

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

Параметры

string $value
string $operator
bool $useDefault

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

array

Исключения

InvalidArgumentException

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

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

Предотвращает использование Null значений с некорректными операторами.

Параметры

string $operator
mixed $value

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

bool

protected bool invalidOperator(string $operator)

Определить, поддерживается ли данный оператор.

Параметры

string $operator

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

bool

protected bool isBitwiseOperator(string $operator)

Определить, является ли оператор побитовым.

Параметры

string $operator

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

bool

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

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

Параметры

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

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

$this

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

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

Параметры

string|array $first
string|null $operator
string|null $second
string|null $boolean

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

$this

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

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

Параметры

string|array $first
string|null $operator
string|null $second

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

$this

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

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

Параметры

string $sql
mixed $bindings
string $boolean

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

$this

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

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

Параметры

string $sql
mixed $bindings

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $values

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

$this

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

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

Parameters

string $column
mixed $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
mixed $values

Return Value

$this

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

Добавить условие «в» для целых значений к запросу.

Parameters

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

Return Value

$this

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

Добавить условие «или в» для целых значений к запросу.

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

Добавить условие «не в» для целых значений к запросу.

Parameters

string $column
Arrayable|array $values
string $boolean

Return Value

$this

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

Добавить условие «или не в» для целых значений к запросу.

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

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

Parameters

string|array $columns
string $boolean
bool $not

Return Value

$this

$this orWhereNull(string|array $column)

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

Parameters

string|array $column

Return Value

$this

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

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

Parameters

string|array $columns
string $boolean

Return Value

$this

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

Добавить условие «между» к запросу.

Parameters

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

Return Value

$this

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

Добавить условие «между» используя столбцы к запросу.

Parameters

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

Return Value

$this

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

Добавить условие «или между» к запросу.

Parameters

string $column
array $values

Return Value

$this

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

Добавить условие «или между» используя столбцы к запросу.

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
array $values
string $boolean

Return Value

$this

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

Добавить условие «не между» используя столбцы к запросу.

Parameters

string $column
array $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
array $values

Return Value

$this

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

Добавить условие «или не между» используя столбцы к запросу.

Parameters

string $column
array $values

Return Value

$this

$this orWhereNotNull(string $column)

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

Parameters

string $column

Return Value

$this

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

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

Parameters

Expression|string $column
string $operator
DateTimeInterface|string|null $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|null $value

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|int|null $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
string $operator
DateTimeInterface|string|int|null $value

Return Value

$this

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

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

Parameters

string $type
string $column
string $operator
mixed $value
string $boolean

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean

Return Value

$this

Builder forNestedWhere()

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

Return Value

Builder

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

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

Параметры

Builder $query
string $boolean

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Closure $callback
string $boolean
bool $not

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

$this

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

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

Параметры

Closure $callback
bool $not

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

$this

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

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

Параметры

Closure $callback
string $boolean

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

$this

$this orWhereNotExists(Closure $callback)

Добавить условие OR WHERE NOT EXISTS в запрос.

Параметры

Closure $callback

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

$this

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

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

Параметры

Builder $query
string $boolean
bool $not

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

$this

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

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

Параметры

array $columns
string $operator
array $values
string $boolean

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

array $columns
string $operator
array $values

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

$this

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

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

Параметры

string $column
mixed $value
string $boolean
bool $not

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

$this

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

string $column
mixed $value
string $boolean

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

$this

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $operator
mixed $value

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

$this

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

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

Параметры

string $method
array $parameters

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

$this

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

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

Параметры

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

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

void

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

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

Параметры

string|string[] $columns
string $value
array $options
string $boolean

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

$this

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

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

Параметры

string|string[] $columns
string $value
array $options

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

$this

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

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

Параметры

array|string ...$groups

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

string $column
string|null $operator
string|null $value
string $boolean

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

$this

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

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

Параметры

string $column
string|null $operator
string|null $value

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $sql
array $bindings
string $boolean

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

Closure|Builder|Builder|Expression|string $column
string $direction

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

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

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

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

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

$this inRandomOrder(string $seed = '')

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

Параметры

строка $seed

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

$this

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

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

Параметры

строка $sql
массив $bindings

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

$this

$this skip(int $value)

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

Параметры

целое число $value

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

$this

$this offset(int $value)

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

Параметры

целое число $value

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

$this

$this take(int $value)

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

Параметры

целое число $value

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

$this

$this limit(int $value)

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

Параметры

целое число $value

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

$this

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

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

Параметры

целое число $page
целое число $perPage

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

$this

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

Ограничьте запрос предыдущей «страницей» результатов перед заданным идентификатором.

Параметры

целое число $perPage
целое число|null $lastId
строка $column

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

$this

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

Ограничьте запрос следующей «страницей» результатов после заданного идентификатора.

Параметры

целое число $perPage
целое число|null $lastId
строка $column

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

$this

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

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

Параметры

Closure|Builder|Expression|строка|null $column
строка $direction

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

$this

protected array removeExistingOrdersFor(string $column)

Возвращает массив со всеми упорядочиваниями, в котором удален столбец.

Параметры

строка $column

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

массив

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

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

Параметры

Builder|Closure $query
булево $all

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

$this

$this unionAll(Builder|Closure $query)

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

Параметры

Builder|Closure $query

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

$this

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

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

Параметры

строка|булево $value

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

$this

Builder lockForUpdate()

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

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

Builder

Builder sharedLock()

Разделить блокировку выбранных строк в таблице.

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

Builder

$this beforeQuery(callable $callback)

Зарегистрировать лямбда-выражение, которое будет вызываться перед выполнением запроса.

Параметры

вызов $callback

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

$this

void applyBeforeQueryCallbacks()

Вызвать обратные вызовы модификаций «перед запросом».

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

пусто

строка toSql()

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

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

строка

смешанное|Builder find(int|строка $id, array $columns = ['*'])

Выполнить запрос для получения одной записи по идентификатору.

Параметры

int|строка $id
массив $columns

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

смешанное|Builder

mixed value(string $column)

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

Parameters

string $column

Return Value

mixed

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

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

Parameters

array|string $columns

Return Value

Collection

protected array runSelect()

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

Return Value

array

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

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

Parameters

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

Return Value

LengthAwarePaginator

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

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

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

Parameters

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

Return Value

Paginator

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

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

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

Parameters

int|null $perPage
array $columns
string $cursorName
Cursor|string|null $cursor

Return Value

CursorPaginator

protected Collection ensureOrderForCursorPagination(bool $shouldReverse = false)

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

Parameters

bool $shouldReverse

Return Value

Collection

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

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

Parameters

array $columns

Return Value

int

protected array runPaginationCountQuery(array $columns = ['*'])

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

Parameters

array $columns

Return Value

array

protected Builder cloneForPaginationCount()

Создать клон существующего экземпляра запроса для использования в подзапросе пагинации.

Return Value

Builder

protected array withoutSelectAliases(array $columns)

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

Parameters

array $columns

Return Value

array

LazyCollection cursor()

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

Return Value

LazyCollection

protected void enforceOrderBy()

Выбросить исключение, если в запросе отсутствует предложение orderBy.

Return Value

void

Exceptions

RuntimeException

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

Получить экземпляр набора, содержащий значения заданного столбца.

Parameters

string $column
string|null $key

Return Value

Collection

protected string|null stripTableForPluck(string $column)

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

Parameters

string $column

Return Value

string|null

protected Collection pluckFromObjectColumn(array $queryResult, string $column, string $key)

Получение значений столбцов из строк, представленных в виде объектов.

Parameters

array $queryResult
string $column
string $key

Return Value

Collection

protected Collection pluckFromArrayColumn(array $queryResult, string $column, string $key)

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

Parameters

array $queryResult
string $column
string $key

Return Value

Collection

строка implode(строка $column, строка $glue = '')

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

Параметры

строка $column
строка $glue

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

строка

логическое значение exists()

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

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

логическое значение

логическое значение doesntExist()

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

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

логическое значение

смешанный тип existsOr(Closure $callback)

Выполнить заданный обратный вызов, если для текущего запроса нет строк.

Параметры

Closure $callback

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

смешанный тип

смешанный тип doesntExistOr(Closure $callback)

Выполнить заданный обратный вызов, если для текущего запроса есть строки.

Параметры

Closure $callback

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

смешанный тип

целое число count(строка $columns = '*')

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

Параметры

строка $columns

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

целое число

смешанный тип min(строка $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип max(строка $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип sum(строка $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип avg(строка $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип average(строка $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип aggregate(строка $function, массив $columns = ['*'])

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

Параметры

строка $function
массив $columns

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

смешанный тип

число с плавающей точкой|целое число numericAggregate(строка $function, массив $columns = ['*'])

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

Параметры

строка $function
массив $columns

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

число с плавающей точкой|целое число

protected $this setAggregate(строка $function, массив $columns)

Установить свойство агрегата без выполнения запроса.

Параметры

строка $function
массив $columns

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

$this

protected смешанный тип onceWithColumns(массив $columns, вызываемый $callback)

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

После выполнения обратного вызова столбцы сбрасываются до исходного значения.

Параметры

массив $columns
вызываемый $callback

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

смешанный тип

логическое значение insert(массив $values)

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

Параметры

массив $values

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

логическое значение

целое число insertOrIgnore(массив $values)

Вставить новые записи в базу данных, игнорируя ошибки.

Параметры

массив $values

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

целое число

целое число insertGetId(массив $values, строка|null $sequence = null)

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

Параметры

массив $values
строка|null $sequence

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

целое число

целое число insertUsing(массив $columns, Closure|Builder|строка $query)

Вставить новые записи в таблицу, используя подзапрос.

Параметры

массив $columns
Closure|Builder|строка $query

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

целое число

целое число update(массив $values)

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

Параметры

массив $values

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

целое число

целое число updateFrom(массив $values)

Обновить записи в базе данных PostgreSQL, используя синтаксис update from.

Параметры

массив $values

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

целое число

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

Вставить или обновить запись, соответствующую атрибутам, и заполнить ее значениями.

Parameters

array $attributes
array $values

Return Value

bool

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

Вставить новые записи или обновить существующие.

Parameters

array $values
array|string $uniqueBy
array|null $update

Return Value

int

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

Увеличить значение столбца на заданную величину.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

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

Уменьшить значение столбца на заданную величину.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

int delete(mixed $id = null)

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

Parameters

mixed $id

Return Value

int

void truncate()

Выполнить операцию truncate для таблицы.

Return Value

void

Builder newQuery()

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

Return Value

Builder

protected Builder forSubQuery()

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

Return Value

Builder

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

mixed castBinding(mixed $value)

Преобразовать данное значение привязки.

Parameters

mixed $value

Return Value

mixed

$this mergeBindings(Builder $query)

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

Parameters

Builder $query

Return Value

$this

array cleanBindings(array $bindings)

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

Parameters

array $bindings

Return Value

array

protected mixed flattenValue(mixed $value)

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

Parameters

mixed $value

Return Value

mixed

protected string defaultKeyName()

Получить имя ключа по умолчанию для таблицы.

Return Value

string

ConnectionInterface getConnection()

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

Return Value

ConnectionInterface

Processor getProcessor()

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

Return Value

Processor

Grammar getGrammar()

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

Return Value

Grammar
END_OF_DOCUMENT_MARKER

$this useWritePdo()

Использование pdo для записи запроса.

Значение возвращаемого значения

$this

protected bool isQueryable(mixed $value)

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

Параметры

mixed $value

Значение возвращаемого значения

bool

Библиотека clone()

Клонировать запрос.

Значение возвращаемого значения

Библиотека

Библиотека cloneWithout(array $properties)

Клонировать запрос без указанных свойств.

Параметры

array $properties

Значение возвращаемого значения

Библиотека

Библиотека cloneWithoutBindings(array $except)

Клонировать запрос без указанных привязок.

Параметры

array $except

Значение возвращаемого значения

Библиотека

$this dump()

Вывести текущий SQL и привязки.

Значение возвращаемого значения

$this

never dd()

Прервать выполнение и вывести текущий SQL и привязки.

Значение возвращаемого значения

never

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

Spec-Zone.ru

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