Spec-Zone.ru › Laravel 9

Builder

class Builder implements 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

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

IndexHint $indexHint

Подсказка индекса для запроса.

array $joins

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

array $wheres

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

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 для select.

Методы

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

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

из Conditionable
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $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|string $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 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)

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

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

Смешать другой объект в класс.

из Macroable
static bool hasMacro(string $name)

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

из Macroable
static void flushMacros()

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

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

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

из 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 = [])

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

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

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

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

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

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

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

array parseSub(mixed $query)

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

mixed prependDatabaseNameIfCrossDatabaseQuery(mixed $query)

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

$this addSelect(array|mixed $column)

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

$this distinct()

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

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

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

$this useIndex(string $index)

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

$this forceIndex(string $index)

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

$this ignoreIndex(string $index)

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

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

Добавить условие "right join 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)

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

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

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

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

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

$this 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 whereNot(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

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

$this orWhereNot(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, iterable $values, string $boolean = 'and', bool $not = false)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$this orWhereNotNull(string $column)

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

$this whereDate(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|int|null $value = null, string $boolean = 'and')

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

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

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

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

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

$this orWhereMonth(string $column, string $operator, DateTimeInterface|string|int|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')

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

$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 whereJsonContainsKey(string $column, string $boolean = 'and', bool $not = false)

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

$this orWhereJsonContainsKey(string $column)

Добавить условие "или", определяющее, существует ли JSON путь в запросе.

$this whereJsonDoesntContainKey(string $column, string $boolean = 'and')

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

$this orWhereJsonDoesntContainKey(string $column)

Добавить условие "или", определяющее, не существует ли 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(Closure|string $column, string|int|float|null $operator = null, string|int|float|null $value = null, string $boolean = 'and')

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

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

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

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

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

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

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

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

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

$this orHavingNull(string $column)

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

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

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

$this orHavingNotNull(string $column)

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

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

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

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

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

$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|Expression|string $column = 'created_at')

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

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

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

$this inRandomOrder(string|int $seed = '')

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

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

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

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

Ограничить запрос предыдущей "страницей" результатов до заданного ID.

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

Ограничить запрос следующей "страницей" результатов после заданного ID.

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

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

array removeExistingOrdersFor(string $column)

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

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

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

$this unionAll(Closure|Builder|Builder $query)

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

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

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

$this lockForUpdate()

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

$this sharedLock()

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

$this beforeQuery(callable $callback)

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

void applyBeforeQueryCallbacks()

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

string toSql()

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

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

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

mixed|Builder findOr(mixed $id, Closure|array|string $columns = ['*'], Closure $callback = null)

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

mixed value(string $column)

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

mixed rawValue(string $expression, array $bindings = [])

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

mixed soleValue(string $column)

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

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

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

array runSelect()

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

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

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

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

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

CursorPaginator cursorPaginate(int|null $perPage = 15, array|string $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)

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

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|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 incrementEach(array $columns, array $extra = [])

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

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

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

int decrementEach(array $columns, 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()

Использовать соединение PDO "write" при выполнении запроса.

bool isQueryable(mixed $value)

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

Builder clone()

Создать клон запроса.

Builder cloneWithout(array $properties)

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

Builder cloneWithoutBindings(array $except)

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

$this dump()

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

never dd()

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

Details

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

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

Parameters

$value
callable $callback
callable $default

Return Value

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)

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

Parameters

$value
callable $callback
callable $default

Return Value

$this|TUnlessReturnType

bool chunk(int $count, callable $callback)

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

Parameters

int $count
callable $callback

Return Value

bool

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

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

Parameters

callable $callback
int $count

Return Value

Collection

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

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

Parameters

callable $callback
int $count

Return Value

bool

Exceptions

RuntimeException

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

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

Parameters

int $count
callable $callback
string|null $column
string|null $alias

Return Value

bool

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

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

Parameters

callable $callback
int $count
string|null $column
string|null $alias

Return Value

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

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

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

Параметры

array|string $columns

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

Модель|object|BuildsQueries|null

Модель|object|BuildsQueries|null sole(array|string $columns = ['*'])

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

Параметры

array|string $columns

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

Модель|object|BuildsQueries|null

Исключения

RecordsNotFoundException
MultipleRecordsFoundException

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

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

Параметры

int $perPage
array|string $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
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

CursorPaginator

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

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)

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

Параметры

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

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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 = null, Processor $processor = null)

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

Параметры

ConnectionInterface $connection
Grammar $grammar
Processor $processor

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

void

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

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

Параметры

array|mixed $columns

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $expression
array $bindings

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

$this

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

Указать, что выборка "from" должна происходить из подзапроса.

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

string $expression
mixed $bindings

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

$this

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

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

Параметры

Closure|Builder|Builder|string $query

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

array

protected array parseSub(mixed $query)

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

Параметры

mixed $query

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

array

Исключения

InvalidArgumentException

protected mixed prependDatabaseNameIfCrossDatabaseQuery(mixed $query)

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

Параметры

mixed $query

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

mixed

$this addSelect(array|mixed $column)

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

Параметры

array|mixed $column

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

$this

$this distinct()

Выбрать только уникальные результаты.

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

$this

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

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

Параметры

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

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

$this

$this useIndex(string $index)

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

Параметры

string $index

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

$this

$this forceIndex(string $index)

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

Параметры

string $index

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

$this

$this ignoreIndex(string $index)

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

Параметры

string $index

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

$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|Builder|string $query, string $as)

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

Параметры

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

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

$this

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

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

Параметры

Builder $parentQuery
string $type
string $table

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

JoinClause

$this mergeWheres(array $wheres, array $bindings)

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

Параметры

array $wheres
array $bindings

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

array $column
string $boolean
string $method

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

$this

массив prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

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

Параметры

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

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

массив

Исключения

InvalidArgumentException

protected булево invalidOperatorAndValue(string $operator, mixed $value)

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

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

Параметры

строка $operator
смешанное $value

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

булево

protected булево invalidOperator(string $operator)

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

Параметры

строка $operator

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

булево

protected булево isBitwiseOperator(string $operator)

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

Параметры

строка $operator

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

булево

$this orWhere(Closure|строка|массив $column, mixed $operator = null, mixed $value = null)

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

Параметры

Closure|строка|массив $column
смешанное $operator
смешанное $value

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

$this

$this whereNot(Closure|строка|массив $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

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

Параметры

Closure|строка|массив $column
смешанное $operator
смешанное $value
строка $boolean

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

$this

$this orWhereNot(Closure|строка|массив $column, mixed $operator = null, mixed $value = null)

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

Параметры

Closure|строка|массив $column
смешанное $operator
смешанное $value

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

$this

$this whereColumn(строка|массив $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

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

Параметры

строка|массив $first
строка|null $operator
строка|null $second
строка|null $boolean

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

$this

$this orWhereColumn(строка|массив $first, string|null $operator = null, string|null $second = null)

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

Параметры

строка|массив $first
строка|null $operator
строка|null $second

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

$this

$this whereRaw(строка $sql, mixed $bindings = [], string $boolean = 'and')

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

Параметры

строка $sql
смешанное $bindings
строка $boolean

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

$this

$this orWhereRaw(строка $sql, mixed $bindings = [])

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

Параметры

строка $sql
смешанное $bindings

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

$this

$this whereIn(строка $column, смешанное $values, строка $boolean = 'and', булево $not = false)

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

Параметры

строка $column
смешанное $values
строка $boolean
булево $not

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

$this

$this orWhereIn(строка $column, смешанное $values)

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

Параметры

строка $column
смешанное $values

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

$this

$this whereNotIn(строка $column, смешанное $values, строка $boolean = 'and')

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

Параметры

строка $column
смешанное $values
строка $boolean

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

$this

$this orWhereNotIn(строка $column, смешанное $values)

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

Параметры

строка $column
смешанное $values

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

$this

$this whereIntegerInRaw(строка $column, Arrayable|массив $values, строка $boolean = 'and', булево $not = false)

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

Параметры

строка $column
Arrayable|массив $values
строка $boolean
булево $not

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

$this

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

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

Параметры

string $column
Arrayable|array $values

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

$this

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

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

Параметры

string $column
Arrayable|array $values
string $boolean

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

$this

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

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

Параметры

string $column
Arrayable|array $values

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

$this

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

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

Параметры

string|array $columns
string $boolean
bool $not

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

$this

$this orWhereNull(string|array $column)

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

Параметры

string|array $column

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

$this

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

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

Параметры

string|array $columns
string $boolean

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
iterable $values

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

$this

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

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

Параметры

string $column
array $values

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

$this

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

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

Параметры

string $column
iterable $values
string $boolean

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

$this

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

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

Параметры

string $column
array $values
string $boolean

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

$this

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

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

Параметры

string $column
iterable $values

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

$this

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

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

Параметры

string $column
array $values

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

$this

$this orWhereNotNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Closure $callback
string $boolean

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

$this

Builder forNestedWhere()

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

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

Builder

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

Добавить другой объект `Builder` в качестве вложенного условия к объекту `Builder`.

Параметры

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)

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

Параметры

Closure $callback
строка $boolean
логическое $not

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

$this

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

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

Параметры

Closure $callback
логическое $not

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

$this

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

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

Параметры

Closure $callback
строка $boolean

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

$this

$this orWhereNotExists(Closure $callback)

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

Параметры

Closure $callback

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

$this

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

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

Параметры

Builder $query
строка $boolean
логическое $not

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

$this

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

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

Параметры

массив $columns
строка $operator
массив $values
строка $boolean

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

массив $columns
строка $operator
массив $values

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

$this

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

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

Параметры

строка $column
смешанный $value
строка $boolean
логическое $not

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

$this

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

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

Параметры

строка $column
смешанный $value

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

$this

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

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

Parameters

string $column
mixed $value
string $boolean

Return Value

$this

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

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

Parameters

string $column
mixed $value

Return Value

$this

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

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

Parameters

string $column
string $boolean
bool $not

Return Value

$this

$this orWhereJsonContainsKey(string $column)

Добавить условие "или", определяющее, существует ли JSON путь в запросе.

Parameters

string $column

Return Value

$this

$this whereJsonDoesntContainKey(string $column, string $boolean = 'and')

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

Parameters

string $column
string $boolean

Return Value

$this

$this orWhereJsonDoesntContainKey(string $column)

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

Parameters

string $column

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

string $column
mixed $operator
mixed $value

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

Closure|string $column
string|int|float|null $operator
string|int|float|null $value
string $boolean

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

$this

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

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

Параметры

Closure|string $column
string|int|float|null $operator
string|int|float|null $value

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

$this

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

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

Параметры

Closure $callback
string $boolean

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

$this

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

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

Параметры

Builder $query
string $boolean

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

$this

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

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

Параметры

string|array $columns
string $boolean
bool $not

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

$this

$this orHavingNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

string|array $columns
string $boolean

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

$this

$this orHavingNotNull(string $column)

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

Параметры

string $column

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

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

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

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

Параметры

Closure|Builder|Expression|string $column

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

$this

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

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

Параметры

Closure|Builder|Expression|string $column

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

$this

$this inRandomOrder(string|int $seed = '')

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

Параметры

string|int $seed

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

$this skip(int $value)

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

Параметры

int $value

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

$this

$this offset(int $value)

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

Параметры

int $value

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

$this

$this take(int $value)

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

Параметры

int $value

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

$this

$this limit(int $value)

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

Параметры

int $value

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

$this

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

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

Параметры

int $page
int $perPage

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

$this

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

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

Параметры

int $perPage
int|null $lastId
string $column

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

$this

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

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

Параметры

int $perPage
int|null $lastId
string $column

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

$this

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

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

Параметры

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

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

$this

protected array removeExistingOrdersFor(string $column)

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

Параметры

string $column

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

array
END_OF_DOCUMENT_MARKER

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

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

Параметры

Closure|Builder|Builder $query
bool $all

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

$this

$this unionAll(Closure|Builder|Builder $query)

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

Параметры

Closure|Builder|Builder $query

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

$this

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

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

Параметры

string|bool $value

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

$this

$this lockForUpdate()

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

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

$this

$this sharedLock()

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

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

$this

$this beforeQuery(callable $callback)

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

Параметры

callable $callback

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

$this

void applyBeforeQueryCallbacks()

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

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

void

string toSql()

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

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

string

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

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

Параметры

int|string $id
array|string $columns

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

mixed|Builder

mixed|Builder findOr(mixed $id, Closure|array|string $columns = ['*'], Closure $callback = null)

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

Параметры

mixed $id
Closure|array|string $columns
Closure $callback

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

mixed|Builder

mixed value(string $column)

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

Параметры

string $column

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

mixed

mixed rawValue(string $expression, array $bindings = [])

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

Параметры

string $expression
array $bindings

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

mixed

mixed soleValue(string $column)

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

Параметры

string $column

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

mixed

Исключения

RecordsNotFoundException
MultipleRecordsFoundException

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

Выполнить запрос в качестве оператора "select".

Параметры

array|string $columns

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

Collection

protected array runSelect()

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

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

array

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

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

Параметры

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

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

LengthAwarePaginator

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

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

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

Параметры

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

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

Paginator

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

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

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

Параметры

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

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

CursorPaginator

protected Collection ensureOrderForCursorPagination(bool $shouldReverse = false)

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

Параметры

bool $shouldReverse

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

Collection

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

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

Параметры

array $columns

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

int

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

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

Параметры

array $columns

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

array

protected Builder cloneForPaginationCount()

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

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

Builder

protected array withoutSelectAliases(array $columns)

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

Параметры

array $columns

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

array

LazyCollection cursor()

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

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

LazyCollection

protected void enforceOrderBy()

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

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

void

Исключения

RuntimeException

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

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

Параметры

string $column
string|null $key

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

Collection

protected string|null stripTableForPluck(string $column)

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

Параметры

string $column

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

string|null

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

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

Параметры

array $queryResult
string $column
string $key

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

Collection

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

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

Параметры

array $queryResult
string $column
string $key

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

Collection

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

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

Параметры

string $column
string $glue

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

string

bool exists()

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

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

bool

bool doesntExist()

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

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

bool

mixed existsOr(Closure $callback)

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

Параметры

Closure $callback

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

mixed

mixed doesntExistOr(Closure $callback)

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

Параметры

Closure $callback

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

mixed

int count(string $columns = '*')

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

Параметры

string $columns

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

int

mixed min(string $column)

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

Parameters

string $column

Return Value

mixed

mixed max(string $column)

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

Parameters

string $column

Return Value

mixed

mixed sum(string $column)

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

Parameters

string $column

Return Value

mixed

mixed avg(string $column)

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

Parameters

string $column

Return Value

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

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

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

Parameters

string $function
array $columns

Return Value

$this

protected mixed onceWithColumns(array $columns, callable $callback)

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

После выполнения обратного вызова столбцы сбрасываются до исходного значения.

Parameters

array $columns
callable $callback

Return Value

mixed

bool insert(array $values)

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

Parameters

array $values

Return Value

bool

int insertOrIgnore(array $values)

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

Parameters

array $values

Return Value

int

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

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

Parameters

array $values
string|null $sequence

Return Value

int

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

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

Parameters

array $columns
Closure|Builder|Builder|string $query

Return Value

int

int update(array $values)

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

Parameters

array $values

Return Value

int

int updateFrom(array $values)

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

Parameters

array $values

Return Value

int

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 incrementEach(array $columns, array $extra = [])

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

Parameters

array $columns
array $extra

Return Value

int

Exceptions

InvalidArgumentException
END_OF_DOCUMENT_MARKER

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

int decrementEach(array $columns, array $extra = [])

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

Parameters

array $columns
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

$this useWritePdo()

Использовать подключение PDO "write" при выполнении запроса.

Return Value

$this

protected bool isQueryable(mixed $value)

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

Parameters

mixed $value

Return Value

bool

Builder clone()

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

Return Value

Builder

Builder cloneWithout(array $properties)

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

Параметры

Массив $properties

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

Builder

Builder cloneWithoutBindings(array $except)

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

Параметры

Массив $except

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

Builder

$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/9.x/Illuminate/Database/Query/Builder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API