Spec-Zone.ru › Laravel 8

JoinClause

class JoinClause extends Builder (View source)

Трейты

BuildsQueries
ExplainsQueries
ForwardsCalls
Macroable
Conditionable

Свойства

static protected array $macros

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

from Macroable
ConnectionInterface $connection

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

from Builder
Grammar $grammar

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

from Builder
Processor $processor

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

from Builder
array $bindings

Текущие значения связываемых данных запроса.

from Builder
array $aggregate

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

from Builder
array $columns

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

from Builder
bool|array $distinct

Указывает, возвращаются ли результаты distinct.

from Builder
string $from

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

from Builder
array $joins

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

from Builder
array $wheres

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

from Builder
array $groups

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

from Builder
array $havings

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

from Builder
array $orders

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

from Builder
int $limit

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

from Builder
int $offset

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

from Builder
array $unions

Объединённые операторы запроса.

from Builder
int $unionLimit

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

from Builder
int $unionOffset

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

from Builder
array $unionOrders

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

from Builder
string|bool $lock

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

from Builder
array $beforeQueryCallbacks

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

from Builder
string[] $operators

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

from Builder
string[] $bitwiseOperators

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

from Builder
bool $useWritePdo

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

from Builder
string $type

Тип выполняемого соединения.

string $table

Таблица, к которой присоединяется пункт соединения.

protected ConnectionInterface $parentConnection

Подключение родительского билдера запроса.

protected Grammar $parentGrammar

Синтаксический анализатор родительского билдера запроса.

protected Processor $parentProcessor

Обработчик родительского билдера запроса.

protected string $parentClass

Имя класса родительского билдера запроса.

Методы

$this|смешанный when(смешанный $value, вызываемый $callback, вызываемый|null $default = null)

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

из Conditionable
$this|смешанный unless(смешанный $value, вызываемый $callback, вызываемый|null $default = null)

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

из Conditionable
bool chunk(int $count, вызываемый $callback)

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

из BuildsQueries
Collection chunkMap(вызываемый $callback, int $count = 1000)

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

из BuildsQueries
bool each(вызываемый $callback, int $count = 1000)

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

из BuildsQueries
bool chunkById(int $count, вызываемый $callback, string|null $column = null, string|null $alias = null)

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

из BuildsQueries
bool eachById(вызываемый $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

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

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

Ленивый запрос по частям заданного размера.

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

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

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

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

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

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

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

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

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

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

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

Разбить запрос на страницы с помощью курсового пагинатора.

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

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

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

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

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

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

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

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

из BuildsQueries
$this|смешанный tap(вызываемый $callback)

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

из BuildsQueries
Collection explain()

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

из ExplainsQueries
смешанный forwardCallTo(смешанный $object, string $method, array $parameters)

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

из ForwardsCalls
смешанный forwardDecoratedCallTo(смешанный $object, string $method, array $parameters)

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

из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

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

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

from Macroable
static bool hasMacro(string $name)

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

from Macroable
static void flushMacros()

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

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

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

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

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

from Macroable
void __construct(Builder $parentQuery, string $type, string $table)

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

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

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

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

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

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

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

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

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

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

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

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

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

from Builder
array parseSub(mixed $query)

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

from Builder
mixed prependDatabaseNameIfCrossDatabaseQuery(mixed $query)

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

from Builder
$this addSelect(array|mixed $column)

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

from Builder
$this distinct()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Builder
void mergeWheres(array $wheres, array $bindings)

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

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

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

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

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

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

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

из Builder
bool invalidOperatorAndValue(string $operator, mixed $value)

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

из Builder
bool invalidOperator(string $operator)

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

из Builder
bool isBitwiseOperator(string $operator)

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

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

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

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

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

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

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

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

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

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

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

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

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

из Builder
$this orWhereIn(string $column, mixed $values)

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

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

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

из Builder
$this orWhereNotIn(string $column, mixed $values)

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

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

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

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

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

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

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

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

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

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

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

из Builder
$this orWhereNull(string|array $column)

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

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

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

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

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

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

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

из Builder
$this orWhereBetween(string $column, array $values)

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

из Builder
$this orWhereBetweenColumns(string $column, array $values)

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

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

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

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

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

из Builder
$this orWhereNotBetween(string $column, array $values)

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

из Builder
$this orWhereNotBetweenColumns(string $column, array $values)

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

из Builder
$this orWhereNotNull(string $column)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Builder
Builder forNestedWhere()

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

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

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

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

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

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

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

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

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

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

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

из Builder
$this orWhereNotExists(Closure $callback)

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

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

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

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

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

из Builder
$this orWhereRowValues(array $columns, string $operator, array $values)

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

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

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

из Builder
$this orWhereJsonContains(string $column, mixed $value)

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

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

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

из Builder
$this orWhereJsonDoesntContain(string $column, mixed $value)

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

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

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

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

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

из Builder
$this dynamicWhere(string $method, array $parameters)

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

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

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

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

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

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

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

из Builder
$this groupBy(array|string ...$groups)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Builder
$this inRandomOrder(string $seed = '')

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

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

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

из Builder
$this skip(int $value)

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

из Builder
$this offset(int $value)

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

из Builder
$this take(int $value)

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

из Builder
$this limit(int $value)

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

из Builder
$this forPage(int $page, int $perPage = 15)

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

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

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

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

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

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

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

из Builder
array removeExistingOrdersFor(string $column)

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

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

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

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

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

из Builder
$this lock(string|bool $value = true)

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

из Builder
Builder lockForUpdate()

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

из Builder
Builder sharedLock()

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

из Builder
$this beforeQuery(callable $callback)

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

из Builder
void applyBeforeQueryCallbacks()

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

из Builder
string toSql()

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

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

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

из Builder
mixed value(string $column)

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

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

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

из Builder
array runSelect()

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

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

Разбить заданный запрос на страницы с использованием простого пагинатора.

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

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

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

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

из Builder
Collection ensureOrderForCursorPagination(bool $shouldReverse = false)

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

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

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

из Builder
array runPaginationCountQuery(array $columns = ['*'])

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

из Builder
Builder cloneForPaginationCount()

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

from Builder
array withoutSelectAliases(array $columns)

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

from Builder
LazyCollection cursor()

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

from Builder
void enforceOrderBy()

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

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

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

from Builder
string|null stripTableForPluck(string $column)

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

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

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

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

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

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

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

from Builder
bool exists()

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

from Builder
bool doesntExist()

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

from Builder
mixed existsOr(Closure $callback)

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

from Builder
mixed doesntExistOr(Closure $callback)

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

from Builder
int count(string $columns = '*')

Извлечь результат "count" запроса.

from Builder
mixed min(string $column)

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

from Builder
mixed max(string $column)

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

from Builder
mixed sum(string $column)

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

from Builder
mixed avg(string $column)

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

from Builder
mixed average(string $column)

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

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

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

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

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

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

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

from Builder
mixed onceWithColumns(array $columns, callable $callback)

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

from Builder
bool insert(array $values)

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

from Builder
int insertOrIgnore(array $values)

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

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

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

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

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

from Builder
int update(array $values)

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

from Builder
int updateFrom(array $values)

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

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

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

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

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

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

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

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

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

из Builder
int delete(mixed $id = null)

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

из Builder
void truncate()

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

из Builder
Builder newQuery()

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

Builder forSubQuery()

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

Expression raw(mixed $value)

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

из Builder
array getBindings()

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

из Builder
array getRawBindings()

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

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

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

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

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

из Builder
mixed castBinding(mixed $value)

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

из Builder
$this mergeBindings(Builder $query)

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

из Builder
array cleanBindings(array $bindings)

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

из Builder
mixed flattenValue(mixed $value)

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

из Builder
string defaultKeyName()

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

из Builder
ConnectionInterface getConnection()

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

из Builder
Processor getProcessor()

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

из Builder
Grammar getGrammar()

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

из Builder
$this useWritePdo()

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

из Builder
bool isQueryable(mixed $value)

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

из Builder
Builder clone()

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

из Builder
Builder cloneWithout(array $properties)

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

из Builder
Builder cloneWithoutBindings(array $except)

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

из Builder
$this dump()

Вывести текущую SQL-строку и связи.

из Builder
never dd()

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

из Builder
$this on(Closure|string $first, string|null $operator = null, Expression|string|null $second = null, string $boolean = 'and')

Добавить условие "on" к объединению.

JoinClause orOn(Closure|string $first, string|null $operator = null, Expression|string|null $second = null)

Добавить условие "or on" к объединению.

Builder newParentQuery()

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

Подробности

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

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

Ленивое выполнение запроса, разбивая на куски по ID.

Параметры

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

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

LazyCollection

Исключения

InvalidArgumentException

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

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

Параметры

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)

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

Параметры

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

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

LazyCollection

Исключения

InvalidArgumentException

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 $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)

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

Параметры

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

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

CursorPaginator

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

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

Parameters

Builder|Builder $builder
string $parameter

Return Value

string

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

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

Parameters

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

Return Value

LengthAwarePaginator

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

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

Parameters

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

Return Value

Paginator

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

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

Parameters

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

Return Value

CursorPaginator

$this|mixed tap(callable $callback)

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

Parameters

callable $callback

Return Value

$this|mixed

Collection explain()

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

Return Value

Collection

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

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

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

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

Parameters

string $name
object|callable $macro

Return Value

void

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
END_OF_DOCUMENT_MARKER

void __construct(Builder $parentQuery, string $type, string $table)

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

Параметры

Builder $parentQuery
string $type
string $table

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

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

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

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

Параметры

string $expression
array $bindings

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

$this

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

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

Параметры

Closure|Builder|string $query
string $as

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

string $expression
mixed $bindings

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

$this

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

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

Параметры

Closure|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|string $table, string|null $as = null)

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

Параметры

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

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

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

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

Параметры

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|строка $query
строка $as
Closure|строка $first
строка|null $operator
строка|null $second
строка $type
логическое $where

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

строка $table
Closure|строка $first
строка|null $operator
строка|null $second

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

$this

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

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

Параметры

строка $table
Closure|строка $first
строка $operator
строка $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|строка $query
строка $as
Closure|строка $first
строка|null $operator
строка|null $second

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

$this

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

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

Параметры

строка $table
Closure|строка $first
строка|null $operator
строка|null $second

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

$this

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

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

Параметры

строка $table
Closure|строка $first
строка $operator
строка $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|строка $query
строка $as
Closure|строка $first
строка|null $operator
строка|null $second

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

$this

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

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

Параметры

строка $table
Closure|строка|null $first
строка|null $operator
строка|null $second

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

$this

$this crossJoinSub(Closure|Builder|строка $query, string $as)

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

Параметры

Closure|Builder|строка $query
строка $as

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

$this

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

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

Параметры

Builder $parentQuery
строка $type
строка $table

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

JoinClause

void mergeWheres(array $wheres, array $bindings)

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

Параметры

массив $wheres
массив $bindings

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

void

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

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

Parameters

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

Return Value

$this

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

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

Parameters

array $column
string $boolean
string $method

Return Value

$this

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

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

Parameters

string $value
string $operator
bool $useDefault

Return Value

array

Exceptions

InvalidArgumentException

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

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

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

Parameters

string $operator
mixed $value

Return Value

bool

protected bool invalidOperator(string $operator)

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

Parameters

string $operator

Return Value

bool

protected bool isBitwiseOperator(string $operator)

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

Parameters

string $operator

Return Value

bool

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

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

Parameters

string $sql
mixed $bindings

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

string $column
mixed $values

Return Value

$this

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

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

Parameters

string $column
mixed $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
mixed $values

Return Value

$this

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

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

Parameters

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

Return Value

$this
END_OF_DOCUMENT_MARKER

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

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

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

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

Parameters

string $column
Arrayable|array $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
Arrayable|array $values

Return Value

$this

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

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

Parameters

string|array $columns
string $boolean
bool $not

Return Value

$this

$this orWhereNull(string|array $column)

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

Parameters

string|array $column

Return Value

$this

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

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

Parameters

string|array $columns
string $boolean

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
array $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
array $values
string $boolean

Return Value

$this

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

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

Parameters

string $column
array $values

Return Value

$this

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

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

Parameters

string $column
array $values

Return Value

$this

$this orWhereNotNull(string $column)

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

Parameters

string $column

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Параметры

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

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

Параметры

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

Значение, возвращаемое функцией

$this

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

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

Параметры

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

Значение, возвращаемое функцией

$this

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

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

Параметры

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

Значение, возвращаемое функцией

$this

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

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

Параметры

string $column
string $operator
DateTimeInterface|string|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')

Добавить другой экземпляр Query Builder как вложенное условие к Query 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
bool $not

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

$this

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

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

Параметры

Closure $callback
bool $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
bool $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
bool $not

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

строка $method
массив $parameters

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

$this

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

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

Параметры

строка $segment
строка $connector
массив $parameters
целое $index

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

void

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

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

Параметры

строка|массив строк $columns
строка $value
массив $options
строка $boolean

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

array|string ...$groups

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $sql
array $bindings
string $boolean

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

$this

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

Добавить условие "или 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|Builder|Expression|string $column = 'created_at')

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

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

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

Параметры

Closure|Builder|Builder|Expression|string $column

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

$this

$this inRandomOrder(string $seed = '')

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

Параметры

string $seed

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

$this skip(int $value)

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

Параметры

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

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

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

Параметры

Builder|Closure $query
bool $all

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

$this

$this unionAll(Builder|Closure $query)

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

Параметры

Builder|Closure $query

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

$this

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

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

Параметры

string|bool $value

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

$this

Builder lockForUpdate()

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

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

Builder

Builder sharedLock()

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

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

Builder

$this beforeQuery(callable $callback)

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

Параметры

callable $callback

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

$this

void applyBeforeQueryCallbacks()

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

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

void

string toSql()

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

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

string

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

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

Параметры

int|string $id
array $columns

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

mixed|Builder

mixed value(string $column)

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

Параметры

string $column

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

mixed

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

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

Параметры

array|string $columns

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

Collection

protected array runSelect()

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

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

array

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

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

Параметры

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

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

LengthAwarePaginator

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

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

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

Параметры

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

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

Paginator

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

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

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

Параметры

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

mixed existsOr(Closure $callback)

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

Parameters

Closure $callback

Return Value

mixed

mixed doesntExistOr(Closure $callback)

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

Parameters

Closure $callback

Return Value

mixed

int count(string $columns = '*')

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

Parameters

string $columns

Return Value

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)

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

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

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

Parameters

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

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

int delete(mixed $id = null)

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

Parameters

mixed $id

Return Value

int

void truncate()

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

Return Value

void

Builder newQuery()

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

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 для записи запросов.

Return Value

$this

protected bool isQueryable(mixed $value)

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

Parameters

mixed $value

Return Value

bool

Builder clone()

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

Return Value

Builder

Builder cloneWithout(array $properties)

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

Parameters

array $properties

Return Value

Builder

Builder cloneWithoutBindings(array $except)

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

Parameters

array $except

Return Value

Builder

$this dump()

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

Return Value

$this

never dd()

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

Return Value

never

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

Добавить условие "on" к объединению.

Условие "on" можно цеплять, например:

$join->on('contacts.user_id', '=', 'users.id') ->on('contacts.info_id', '=', 'info.id')

Это сгенерирует следующий SQL:

on contacts.user_id = users.id and contacts.info_id = info.id

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

JoinClause orOn(Closure|string $first, string|null $operator = null, Expression|string|null $second = null)

Добавить условие "or on" к объединению.

Parameters

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

Return Value

JoinClause

protected Builder newParentQuery()

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

Return Value

Builder

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

Spec-Zone.ru

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