Spec-Zone.ru › Laravel 10

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

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

bool|array $distinct

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

Expression|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

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

Методы

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

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

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

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

from Conditionable
bool chunk(int $count, callable $callback)

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

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

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

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

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

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

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

from BuildsQueries
bool chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)

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

from BuildsQueries
bool orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)

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

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

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

from BuildsQueries
LazyCollection lazy(int $chunkSize = 1000)

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

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

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

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

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

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

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

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

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

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

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

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

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

from BuildsQueries
string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)

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

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

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

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

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

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

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

from BuildsQueries
$this tap(callable $callback)

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

from BuildsQueries
Collection explain()

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

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

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

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

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

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

Добавить новое выражение выбора «raw» в запрос.

$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(Expression|string $table, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null, string $type = 'inner', bool $where = false)

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

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

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

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

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

$this joinLateral(Closure|Builder|Builder|string $query, string $as, string $type = 'inner')

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

JoinLateralClause newJoinLateralClause(Builder $parentQuery, string $type, string $table)

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

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

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

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

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

$this addArrayOfWheres(array $column, string $boolean, string $method = '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|Expression $column, mixed $operator = null, mixed $value = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$this orWhereNull(string|array|Expression $column)

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

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

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

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

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

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

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

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

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

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

Добавить условие "or where between" используя столбцы в запрос.

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

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

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

Добавить условие "where not between" используя столбцы в запрос.

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

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

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

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

$this orWhereNotNull(Expression|string $column)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$this addDateBasedWhere(string $type, Expression|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(Expression|string $column, string $operator, Closure|Builder|Builder $callback, string $boolean)

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

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

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

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

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

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

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

$this orWhereNotExists(Closure|Builder|Builder $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 whereAll(string[] $columns, mixed $operator = null, mixed $value = null, string $boolean = 'and')

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

$this orWhereAll(string[] $columns, string $operator = null, mixed $value = null)

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

$this whereAny(string[] $columns, string $operator = null, mixed $value = null, string $boolean = 'and')

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

$this orWhereAny(string[] $columns, string $operator = null, mixed $value = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$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 представление запроса.

string toRawSql()

Получить исходное 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(Expression|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(Expression|string $columns = '*')

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

mixed min(Expression|string $column)

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

mixed max(Expression|string $column)

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

mixed sum(Expression|string $column)

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

mixed avg(Expression|string $column)

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

mixed average(Expression|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|Builder|string $query)

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

int insertOrIgnoreUsing(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()

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

array getColumns()

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

Expression raw(mixed $value)

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

Collection getUnionBuilders()

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

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)

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

Builder clone()

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

Builder cloneWithout(array $properties)

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

Builder cloneWithoutBindings(array $except)

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

$this dump()

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

$this dumpRawSql()

Вывести исходный текущий SQL с встроенными связями.

never dd()

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

never ddRawSql()

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

Подробности

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TWhenReturnType

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TUnlessReturnType

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

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

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

Параметры

callable $callback
int $count

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

Collection

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

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

Параметры

callable $callback
int $count

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

bool

Исключения

RuntimeException

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

bool

bool orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)

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

Параметры

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

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

bool

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

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

Параметры

callable $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
END_OF_DOCUMENT_MARKER

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

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

Параметры

array|string $columns

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

Model|object|BuildsQueries|null

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

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

Параметры

array|string $columns

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

Model|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

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)

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

Параметры

string $method

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

void

Исключения

BadMethodCallException

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

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

Параметры

string $name
object|callable $macro

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

void
END_OF_DOCUMENT_MARKER

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

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Выполняет «from» из подзапроса.

Parameters

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

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

Parameters

Closure|Builder|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|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(Expression|string $table, Closure|Expression|string $first, string|null $operator = null, Expression|string|null $second = null, string $type = 'inner', bool $where = false)

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

$this joinLateral(Closure|Builder|Builder|string $query, string $as, string $type = 'inner')

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Builder $parentQuery
string $type
string $table

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

JoinClause

protected JoinLateralClause newJoinLateralClause(Builder $parentQuery, string $type, string $table)

Получить новый запрос объединения с помощью LATERAL.

Параметры

Builder $parentQuery
string $type
string $table

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

JoinLateralClause

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

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

Параметры

array $wheres
array $bindings

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

$this

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

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

Параметры

Closure|string|array|Expression $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|Expression $column, mixed $operator = null, mixed $value = null)

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this
END_OF_DOCUMENT_MARKER

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

string $sql
mixed $bindings
string $boolean

Return Value

$this

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

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

Parameters

string $sql
mixed $bindings

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Expression|string $column
mixed $values

Return Value

$this

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

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

Parameters

Expression|string $column
mixed $values
string $boolean

Return Value

$this

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

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

Parameters

Expression|string $column
mixed $values

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

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

Parameters

string $column
Arrayable|array $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

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

Parameters

string|array|Expression $columns
string $boolean
bool $not

Return Value

$this

$this orWhereNull(string|array|Expression $column)

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

Parameters

string|array|Expression $column

Return Value

$this

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

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

Параметры

string|array|Expression $columns
string $boolean

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Expression|string $column
iterable $values

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

$this

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

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

Параметры

Expression|string $column
array $values

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

$this

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

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

Параметры

Expression|string $column
iterable $values
string $boolean

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

$this

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

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

Параметры

Expression|string $column
array $values
string $boolean

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

$this

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

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

Параметры

Expression|string $column
iterable $values

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

$this

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

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

Параметры

Expression|string $column
array $values

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

$this

$this orWhereNotNull(Expression|string $column)

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

Параметры

Expression|string $column

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean

Return Value

$this

Builder forNestedWhere()

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

Return Value

Builder

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

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

Parameters

Builder $query
string $boolean

Return Value

$this

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

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

Parameters

Expression|string $column
string $operator
Closure|Builder|Builder $callback
string $boolean

Return Value

$this

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

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

Parameters

Closure|Builder|Builder $callback
string $boolean
bool $not

Return Value

$this

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

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

Parameters

Closure|Builder|Builder $callback
bool $not

Return Value

$this

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

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

Parameters

Closure|Builder|Builder $callback
string $boolean

Return Value

$this

$this orWhereNotExists(Closure|Builder|Builder $callback)

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

Parameters

Closure|Builder|Builder $callback

Return Value

$this

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

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

Parameters

Builder $query
string $boolean
bool $not

Return Value

$this

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

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

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

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

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

Parameters

array $columns
string $operator
array $values

Return Value

$this

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

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

Parameters

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

Return Value

$this
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

string $column
mixed $value
string $boolean

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

$this

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

string $column
string $boolean
bool $not

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

$this

$this orWhereJsonContainsKey(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

string $column
string $boolean

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

$this

$this orWhereJsonDoesntContainKey(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $operator
mixed $value

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

$this

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

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

Параметры

string $method
array $parameters

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

$this

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

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

Параметры

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

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

void

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

$this whereAll(string[] $columns, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить условие "где" для нескольких столбцов с условиями "и" между ними.

Параметры

string[] $columns
mixed $operator
mixed $value
string $boolean

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

$this

$this orWhereAll(string[] $columns, string $operator = null, mixed $value = null)

Добавить условие "или где" для нескольких столбцов с условиями "и" между ними.

Параметры

string[] $columns
string $operator
mixed $value

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

$this

$this whereAny(string[] $columns, string $operator = null, mixed $value = null, string $boolean = 'and')

Добавить условие "где" для нескольких столбцов с условиями "или" между ними.

Параметры

string[] $columns
string $operator
mixed $value
string $boolean

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

$this

$this orWhereAny(string[] $columns, string $operator = null, mixed $value = null)

Добавить условие "или где" для нескольких столбцов с условиями "или" между ними.

Параметры

string[] $columns
string $operator
mixed $value

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

$this

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

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

Параметры

array|Expression|string ...$groups

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Closure $callback
string $boolean

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

$this

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

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

Параметры

Builder $query
string $boolean

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

$this

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

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

Параметры

string|array $columns
string $boolean
bool $not

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

$this

$this orHavingNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

string|array $columns
string $boolean

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

$this

$this orHavingNotNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $sql
array $bindings
string $boolean

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

$this

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

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

Параметры

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

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

Параметры

Closure|Builder|Expression|string $column

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

$this

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

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

Параметры

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)

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

Параметры

int $value

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

$this

$this offset(int $value)

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

Параметры

int $value

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

$this

$this take(int $value)

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

Параметры

int $value

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

$this

$this limit(int $value)

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

Параметры

int $value

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

$this

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

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

Параметры

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

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

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

Параметры

Closure|Builder|Builder $query
bool $all

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

$this

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

Добавить оператор объединения union 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

string toRawSql()

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

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

string

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

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

Параметры

int|string $id
array|string $columns

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

mixed|Builder

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

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

Параметры

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(Expression|string $column, string|null $key = null)

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

Параметры

Expression|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(Expression|string $columns = '*')

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

Parameters

Expression|string $columns

Return Value

int

mixed min(Expression|string $column)

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

Parameters

Expression|string $column

Return Value

mixed

mixed max(Expression|string $column)

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

Parameters

Expression|string $column

Return Value

mixed

mixed sum(Expression|string $column)

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

Parameters

Expression|string $column

Return Value

mixed

mixed avg(Expression|string $column)

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

Parameters

Expression|string $column

Return Value

mixed

mixed average(Expression|string $column)

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

Parameters

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

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

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 insertOrIgnoreUsing(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

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

array getColumns()

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

Return Value

array

Expression raw(mixed $value)

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

Parameters

mixed $value

Return Value

Expression

protected Collection getUnionBuilders()

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

Return Value

Collection

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)

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

Параметры

array $bindings

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

array

protected mixed flattenValue(mixed $value)

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

Параметры

mixed $value

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

mixed

protected string defaultKeyName()

Получить имя ключа по умолчанию таблицы.

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

string

ConnectionInterface getConnection()

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

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

ConnectionInterface

Processor getProcessor()

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

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

Processor

Grammar getGrammar()

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

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

Grammar

$this useWritePdo()

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

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

$this

protected bool isQueryable(mixed $value)

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

Параметры

mixed $value

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

bool

Builder clone()

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

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

Builder

Builder cloneWithout(array $properties)

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

Параметры

array $properties

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

Builder

Builder cloneWithoutBindings(array $except)

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

Параметры

array $except

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

Builder

$this dump()

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

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

$this

$this dumpRawSql()

Вывести исходный текущий SQL с вложенными привязками.

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

$this

never dd()

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

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

never

never ddRawSql()

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

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

never

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

Spec-Zone.ru

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