Spec-Zone.ru › Laravel 7

Builder

class Builder (View source)

Свойства

static protected array $macros

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

 из Macroable
ConnectionInterface $connection

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

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

Экземпляр постпроцессора запросов базы данных.
array $bindings

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

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

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

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

Таблица, на которую нацелен запрос.
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 $operators

Все доступные операторы предложений.
bool $useWritePdo

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

Traits

BuildsQueries
ForwardsCalls
Macroable

Methods

bool chunk(int $count, callable $callback)

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

 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)

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

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

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

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

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

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

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

 from BuildsQueries
$this tap(callable $callback)

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

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

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

 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
mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

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

Добавить выражение подзапроса в запрос.
$this selectRaw(string $expression, array $bindings = [])

Добавить новое выражение "необработанного" выбора в запрос.
$this fromSub(Closure|Builder|string $query, string $as)

Делает "из" выборку из подзапроса.
$this fromRaw(string $expression, mixed $bindings = [])

Добавить "необработанное" из условия в запрос.
array createSub(Closure|Builder|string $query)

Создает подзапрос и анализирует его.
array parseSub(mixed $query)

Анализирует подзапрос в SQL и привязки.
$this addSelect(array|mixed $column)

Добавить новый столбец выбора в запрос.
$this distinct()

Принудительно заставить запрос возвращать только уникальные результаты.
$this from(Closure|Builder|string $table, string|null $as = null)

Указать таблицу, на которую нацелен запрос.
$this join(string $table, Closure|string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

Добавить условие соединения в запрос.
$this joinWhere(string $table, Closure|string $first, string $operator, string $second, string $type = 'inner')

Добавить условие "соединение где" в запрос.
$this joinSub(Closure|Builder|string $query, string $as, Closure|string $first, string|null $operator = null, string|null $second = null, string $type = 'inner', bool $where = false)

Добавить к запросу условие присоединения подзапроса.
$this leftJoin(string $table, Closure|string $first, string|null $operator = null, string|null $second = null)

Добавить левое присоединение к запросу.
$this leftJoinWhere(string $table, Closure|string $first, string $operator, string $second)

Добавить условие «присоединение где» к запросу.
$this leftJoinSub(Closure|Builder|string $query, string $as, Closure|string $first, string|null $operator = null, string|null $second = null)

Добавить левое присоединение подзапроса к запросу.
$this rightJoin(string $table, Closure|string $first, string|null $operator = null, string|null $second = null)

Добавить правое присоединение к запросу.
$this rightJoinWhere(string $table, Closure|string $first, string $operator, string $second)

Добавить условие «правое присоединение где» к запросу.
$this rightJoinSub(Closure|Builder|string $query, string $as, Closure|string $first, string|null $operator = null, string|null $second = null)

Добавить правое присоединение подзапроса к запросу.
$this crossJoin(string $table, Closure|string|null $first = null, string|null $operator = null, string|null $second = null)

Добавить условие «внешнее присоединение» к запросу.
JoinClause newJoinClause(Builder $parentQuery, string $type, string $table)

Получить новое условие присоединения.
void mergeWheres(array $wheres, array $bindings)

Объединить массив условий where и связывающие элементы.
$this where(Closure|string|array $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where к запросу.
$this addArrayOfWheres(array $column, string $boolean, string $method = 'where')

Добавить массив условий where к запросу.
array prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

Подготовить значение и оператор для условия where.
bool invalidOperatorAndValue(string $operator, mixed $value)

Определить, является ли данная комбинация оператора и значения законной.
bool invalidOperator(string $operator)

Определить, поддерживается ли данный оператор.
$this orWhere(Closure|string|array $column, mixed $operator = null, mixed $value = null)

Добавить условие «или где» к запросу.
$this whereColumn(string|array $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

Добавить условие «где» для сравнения двух столбцов к запросу.
$this orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null)

Добавить условие «или где» для сравнения двух столбцов к запросу.
$this whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and')

Добавить сырое условие where к запросу.
$this orWhereRaw(string $sql, mixed $bindings = [])

Добавить сырое условие «или где» к запросу.
$this whereIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Добавить условие «где в» к запросу.
$this orWhereIn(string $column, mixed $values)

Добавить условие «или где в» к запросу.
$this whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие «где не в» к запросу.
$this orWhereNotIn(string $column, mixed $values)

Добавить условие «или где не в» к запросу.
$this whereIntegerInRaw(string $column, Arrayable|array $values, string $boolean = 'and', bool $not = false)

Добавить условие «где в (сырое)» для целочисленных значений к запросу.
$this orWhereIntegerInRaw(string $column, Arrayable|array $values)

Добавить условие «или где в (сырое)» для целочисленных значений к запросу.
$this whereIntegerNotInRaw(string $column, Arrayable|array $values, string $boolean = 'and')

Добавить условие «где не в (сырое)» для целочисленных значений к запросу.
$this orWhereIntegerNotInRaw(string $column, Arrayable|array $values)

Добавить условие «или где не в (сырое)» для целочисленных значений к запросу.
$this whereNull(string|array $columns, string $boolean = 'and', bool $not = false)

Добавить условие «где null» к запросу.
$this orWhereNull(string $column)

Добавить условие «или где null» к запросу.
$this whereNotNull(string|array $columns, string $boolean = 'and')

Добавить условие «где не null» к запросу.
$this whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить условие «где между» к запросу.
$this whereBetweenColumns(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить условие «где между» используя столбцы к запросу.
$this orWhereBetween(string $column, array $values)

Добавить условие «или где между» к запросу.
$this orWhereBetweenColumns(string $column, array $values)

Добавить условие «или где между» используя столбцы к запросу.
$this whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавить условие «не между» к запросу.
$this whereNotBetweenColumns(string $column, array $values, string $boolean = 'and')

Добавить условие «не между» к запросу, используя столбцы.
$this orWhereNotBetween(string $column, array $values)

Добавить условие «или не между» к запросу.
$this orWhereNotBetweenColumns(string $column, array $values)

Добавить условие «или не между» к запросу, используя столбцы.
$this orWhereNotNull(string $column)

Добавить условие «или не равно null» к запросу.
$this whereDate(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and')

Добавить условие «где дата» к запросу.
$this orWhereDate(string $column, string $operator, DateTimeInterface|string|null $value = null)

Добавить условие «или где дата» к запросу.
$this whereTime(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and')

Добавить условие «где время» к запросу.
$this orWhereTime(string $column, string $operator, DateTimeInterface|string|null $value = null)

Добавить условие «или где время» к запросу.
$this whereDay(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and')

Добавить условие «где день» к запросу.
$this orWhereDay(string $column, string $operator, DateTimeInterface|string|null $value = null)

Добавить условие «или где день» к запросу.
$this whereMonth(string $column, string $operator, DateTimeInterface|string|null $value = null, string $boolean = 'and')

Добавить условие «где месяц» к запросу.
$this orWhereMonth(string $column, string $operator, DateTimeInterface|string|null $value = null)

Добавить условие «или где месяц» к запросу.
$this whereYear(string $column, string $operator, DateTimeInterface|string|int|null $value = null, string $boolean = 'and')

Добавить условие «где год» к запросу.
$this orWhereYear(string $column, string $operator, DateTimeInterface|string|int|null $value = null)

Добавить условие «или где год» к запросу.
$this addDateBasedWhere(string $type, string $column, string $operator, mixed $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день, время), к запросу.
$this whereNested(Closure $callback, string $boolean = 'and')

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

Создать новый экземпляр запроса для вложенного условия.
$this addNestedWhereQuery(Builder $query, string $boolean = 'and')

Добавить другой билдер запросов как вложенное условие к билдеру запросов.
$this whereSub(string $column, string $operator, Closure $callback, string $boolean)

Добавить полную подзапрос к запросу.
$this whereExists(Closure $callback, string $boolean = 'and', bool $not = false)

Добавить условие «существует» к запросу.
$this orWhereExists(Closure $callback, bool $not = false)

Добавить условие «или существует» к запросу.
$this whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие «не существует» к запросу.
$this orWhereNotExists(Closure $callback)

Добавить условие «или не существует» к запросу.
$this addWhereExistsQuery(Builder $query, string $boolean = 'and', bool $not = false)

Добавить условие «существует» к запросу.
$this whereRowValues(array $columns, string $operator, array $values, string $boolean = 'and')

Добавляет условие, используя значения строк.
$this orWhereRowValues(array $columns, string $operator, array $values)

Добавляет условие «или», используя значения строк.
$this whereJsonContains(string $column, mixed $value, string $boolean = 'and', bool $not = false)

Добавить условие «где JSON содержит» к запросу.
$this orWhereJsonContains(string $column, mixed $value)

Добавить условие «или где JSON содержит» к запросу.
$this whereJsonDoesntContain(string $column, mixed $value, string $boolean = 'and')

Добавить условие «где JSON не содержит» к запросу.
$this orWhereJsonDoesntContain(string $column, mixed $value)

Добавить условие «или где JSON не содержит» к запросу.
$this whereJsonLength(string $column, mixed $operator, mixed $value = null, string $boolean = 'and')

Добавить условие «где длина JSON» к запросу.
$this orWhereJsonLength(string $column, mixed $operator, mixed $value = null)

Добавить условие «или где длина JSON» к запросу.
$this dynamicWhere(string $method, array $parameters)

Обрабатывает динамические условия «где» для запроса.
void addDynamic(string $segment, string $connector, array $parameters, int $index)

Добавить отдельное динамическое условие «где» в запрос.
$this groupBy(array|string ...$groups)

Добавить условие «группировать по» к запросу.
$this groupByRaw(string $sql, array $bindings = [])

Добавить в запрос условие группировки по заданному SQL-выражению.
$this having(string $column, string|null $operator = null, string|null $value = null, string $boolean = 'and')

Добавить в запрос условие "having".
$this orHaving(string $column, string|null $operator = null, string|null $value = null)

Добавить в запрос условие "or having".
$this havingBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавить в запрос условие "having between".
$this havingRaw(string $sql, array $bindings = [], string $boolean = 'and')

Добавить в запрос сырое условие "having".
$this orHavingRaw(string $sql, array $bindings = [])

Добавить в запрос сырое условие "or having".
$this orderBy(Closure|Builder|Expression|string $column, string $direction = 'asc')

Добавить в запрос условие сортировки.
$this orderByDesc(string $column)

Добавить в запрос условие сортировки по убыванию.
$this latest(string $column = 'created_at')

Добавить условие сортировки по времени (по убыванию).
$this oldest(string $column = 'created_at')

Добавить условие сортировки по времени (по возрастанию).
$this inRandomOrder(string $seed = '')

Отсортировать результаты запроса в случайном порядке.
$this orderByRaw(string $sql, array $bindings = [])

Добавить сырое условие сортировки в запрос.
$this skip(int $value)

Псевдоним для задания параметра "смещение" в запросе.
$this offset(int $value)

Установить параметр "смещение" в запросе.
$this take(int $value)

Псевдоним для задания параметра "ограничение" в запросе.
$this limit(int $value)

Установить параметр "ограничение" в запросе.
$this forPage(int $page, int $perPage = 15)

Установить параметры ограничения и смещения для заданной страницы.
$this forPageBeforeId(int $perPage = 15, int|null $lastId = 0, string $column = 'id')

Ограничить запрос предыдущей "страницей" результатов перед заданным ID.
$this forPageAfterId(int $perPage = 15, int|null $lastId = 0, string $column = 'id')

Ограничить запрос следующей "страницей" результатов после заданного ID.
$this reorder(string|null $column = null, string $direction = 'asc')

Удалить все существующие условия сортировки и, опционально, добавить новое.
array removeExistingOrdersFor(string $column)

Получить массив со всеми удалёнными условиями сортировки по заданному столбцу.
$this union(Builder|Closure $query, bool $all = false)

Добавить в запрос оператор объединения (UNION).
$this unionAll(Builder|Closure $query)

Добавить в запрос оператор объединения (UNION ALL).
$this lock(string|bool $value = true)

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

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

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

Получить строковое представление запроса SQL.
mixed|Builder find(int|string $id, array $columns = ['*'])

Выполнить запрос для получения одной записи по ID.
mixed value(string $column)

Получить значение из первого результата запроса для заданного столбца.
Collection get(array|string $columns = ['*'])

Выполнить запрос в виде "select".
array runSelect()

Выполнить запрос в виде "select" против подключения.
LengthAwarePaginator paginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить запрос на страницы с помощью пагинатора.
Paginator simplePaginate(int $perPage = 15, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор, поддерживающий только простые ссылки "следующая" и "предыдущая".
int getCountForPagination(array $columns = ['*'])

Получить количество записей для пагинатора.
array runPaginationCountQuery(array $columns = ['*'])

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

Создать клон текущего объекта запроса для использования в подзапросе пагинации.
array withoutSelectAliases(array $columns)

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

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

Выбросить исключение, если в запросе нет условия сортировки.
Collection pluck(string $column, string|null $key = null)

Получить массив со значениями из заданного столбца.
string|null stripTableForPluck(string $column)

Удалить имя таблицы или алиас из идентификатора столбца.
Collection pluckFromObjectColumn(array $queryResult, string $column, string $key)

Получить значения столбцов из строк, представленных как объекты.
Collection pluckFromArrayColumn(array $queryResult, string $column, string $key)

Извлечь значения столбца из строк, представленных в виде массивов.
string implode(string $column, string $glue = '')

Конкатенировать значения заданного столбца в строку.
bool exists()

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

Определить, не существует ли строк для текущего запроса.
mixed existsOr(Closure $callback)

Выполнить заданный обратный вызов, если для текущего запроса не существует строк.
mixed doesntExistOr(Closure $callback)

Выполнить заданный обратный вызов, если для текущего запроса существуют строки.
int count(string $columns = '*')

Получить результат «подсчёта» запроса.
mixed min(string $column)

Получить минимальное значение заданного столбца.
mixed max(string $column)

Получить максимальное значение заданного столбца.
mixed sum(string $column)

Получить сумму значений заданного столбца.
mixed avg(string $column)

Получить среднее значение значений заданного столбца.
mixed average(string $column)

Псевдоним для метода «avg».
mixed aggregate(string $function, array $columns = ['*'])

Выполнить агрегатную функцию на базе данных.
float|int numericAggregate(string $function, array $columns = ['*'])

Выполнить числовую агрегатную функцию на базе данных.
$this setAggregate(string $function, array $columns)

Установить свойство агрегации без выполнения запроса.
mixed onceWithColumns(array $columns, callable $callback)

Выполнить заданный обратный вызов, выбирая заданные столбцы.
bool insert(array $values)

Вставить новую запись в базу данных.
int insertOrIgnore(array $values)

Вставить новую запись в базу данных, игнорируя ошибки.
int insertGetId(array $values, string|null $sequence = null)

Вставить новую запись и получить значение первичного ключа.
int insertUsing(array $columns, Closure|Builder|string $query)

Вставить новые записи в таблицу с помощью подзапроса.
int update(array $values)

Обновить запись в базе данных.
bool updateOrInsert(array $attributes, array $values = [])

Вставить или обновить запись, соответствующую атрибутам, и заполнить её значениями.
int increment(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.
int decrement(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.
int delete(mixed $id = null)

Удалить запись из базы данных.
void truncate()

Выполнить операцию удаления всех данных из таблицы.
Builder newQuery()

Получить новую инстанцию билдера запросов.
Builder forSubQuery()

Создать новую инстанцию запроса для подзапроса.
Expression raw(mixed $value)

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

Получить текущие значения связываемых переменных запроса в плоском массиве.
array getRawBindings()

Получить сырой массив связываемых переменных.
$this setBindings(array $bindings, string $type = 'where')

Установить значения связываемых переменных для билдера запросов.
$this addBinding(mixed $value, string $type = 'where')

Добавить связываемую переменную к запросу.
$this mergeBindings(Builder $query)

Объединить массив связываемых переменных в наш массив.
array cleanBindings(array $bindings)

Удалить все выражения из списка связываемых переменных.
mixed flattenValue(mixed $value)

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

Получить имя по умолчанию для ключа таблицы.
ConnectionInterface getConnection()

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

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

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

Использовать write pdo для запроса.
bool isQueryable(mixed $value)

Определить, является ли значение экземпляром билдера запросов или замыканием.
Builder cloneWithout(array $properties)

Создать клон запроса без указанных свойств.
Builder cloneWithoutBindings(array $except)

Создать клон запроса без указанных связываемых переменных.
$this dump()

Вывести текущий SQL и связываемые переменные.
void dd()

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

Подробности

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

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

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

Параметры

callable $callback
int $count

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

bool

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)

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

Параметры

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

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

bool

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

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

Параметры

array|string $columns

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

Model|object|BuildsQueries|null

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

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

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

Параметры

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 mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

string $method

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

void

Исключения

BadMethodCallException

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException
END_OF_DOCUMENT_MARKER

смешанный __call(string $method, array $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

пустое значение __construct(ConnectionInterface $connection, Grammar $grammar = null, Processor $processor = null)

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

Параметры

ConnectionInterface $connection
Grammar $grammar
Processor $processor

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

пустое значение

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

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

Параметры

массив|смешанный $columns

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

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

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

$this

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

Выполнить "from" с подзапросом.

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

строка $expression
смешанный $bindings

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

$this

protected массив createSub(Closure|Builder|string $query)

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

Параметры

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

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

массив

protected массив parseSub(mixed $query)

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

Параметры

смешанный $query

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

массив

Исключения

InvalidArgumentException

$this addSelect(array|mixed $column)

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

Параметры

массив|смешанный $column

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

$this

$this distinct()

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

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

$this

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

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

Параметры

Closure|Builder|строка $table
строка|null $as

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

$this

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

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

Параметры

строка $table
Closure|строка $first
строка|null $operator
строка|null $second
строка $type
булево $where

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

Builder $parentQuery
string $type
string $table

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

JoinClause

void mergeWheres(array $wheres, array $bindings)

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

Параметры

array $wheres
array $bindings

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

void

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

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

Параметры

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

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

$this

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

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

Параметры

array $column
string $boolean
string $method

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

$this

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

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

Параметры

строка $value
строка $operator
логическое $useDefault

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

массив

Исключения

InvalidArgumentException

protected логическое invalidOperatorAndValue(string $operator, mixed $value)

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

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

Параметры

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

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

логическое

protected логическое invalidOperator(string $operator)

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

Параметры

строка $operator

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

логическое

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

строка $column
Arrayable|массив $values

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

$this

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

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

Параметры

строка $column
Arrayable|массив $values
строка $boolean

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

$this

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

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

Параметры

строка $column
Arrayable|массив $values

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

$this

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

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

Параметры

string|array $columns
string $boolean
bool $not

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

$this

$this orWhereNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

string|array $columns
string $boolean

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
array $values

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

$this

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

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

Параметры

string $column
array $values

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

$this

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

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

Параметры

string $column
array $values
string $boolean

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

$this

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

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

Параметры

string $column
array $values
string $boolean

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

$this

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

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

Параметры

string $column
array $values

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

$this

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

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

Параметры

string $column
array $values

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

$this

$this orWhereNotNull(string $column)

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

Параметры

string $column

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean

Return Value

$this

Builder forNestedWhere()

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

Return Value

Builder

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

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

Parameters

Builder $query
string $boolean

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean
bool $not

Return Value

$this

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

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

Parameters

Closure $callback
bool $not

Return Value

$this

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

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

Parameters

Closure $callback
string $boolean

Return Value

$this

$this orWhereNotExists(Closure $callback)

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

Параметры

Closure $callback

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

$this

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

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

Параметры

Builder $query
string $boolean
bool $not

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

array $columns
string $operator
array $values

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

string $column
mixed $value
string $boolean

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

$this

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

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

Параметры

string $column
mixed $value

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
mixed $operator
mixed $value

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

$this

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

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

Параметры

string $method
array $parameters

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

$this

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

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

Параметры

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

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

void

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

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

Параметры

array|string ...$groups

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

$this
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $sql
array $bindings
string $boolean

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

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

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

Параметры

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

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

$this

Исключения

InvalidArgumentException

$this orderByDesc(string $column)

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

Параметры

string $column

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

$this

$this latest(string $column = 'created_at')

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

Параметры

string $column

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

$this

$this oldest(string $column = 'created_at')

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

Параметры

string $column

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

$this

$this inRandomOrder(string $seed = '')

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

Параметры

string $seed

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

$this

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

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

Параметры

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(string|null $column = null, string $direction = 'asc')

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

Параметры

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
END_OF_DOCUMENT_MARKER

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

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

Параметры

string|bool $value

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

$this

Builder lockForUpdate()

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

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

Builder

Builder sharedLock()

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

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

Builder

string toSql()

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

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

string

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

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

Параметры

int|string $id
array $columns

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

mixed|Builder

mixed value(string $column)

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

Параметры

string $column

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

mixed

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

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

Параметры

array|string $columns

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

Collection

protected array runSelect()

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

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

array

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

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

Параметры

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

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

LengthAwarePaginator

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

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

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

Параметры

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

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

Paginator

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 Коллекция pluckFromArrayColumn(array $queryResult, string $column, string $key)

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

Параметры

массив $queryResult
строка $column
строка $key

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

Коллекция

строка implode(string $column, string $glue = '')

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

Параметры

строка $column
строка $glue

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

строка

логическое значение exists()

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

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

логическое значение

логическое значение doesntExist()

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

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

логическое значение

смешанный тип existsOr(Closure $callback)

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

Параметры

Closure $callback

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

смешанный тип

смешанный тип doesntExistOr(Closure $callback)

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

Параметры

Closure $callback

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

смешанный тип

целое число count(string $columns = '*')

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

Параметры

строка $columns

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

целое число

смешанный тип min(string $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип max(string $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип sum(string $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип avg(string $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип average(string $column)

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

Параметры

строка $column

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

смешанный тип

смешанный тип aggregate(string $function, array $columns = ['*'])

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

Параметры

строка $function
массив $columns

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

смешанный тип

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

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

Параметры

строка $function
массив $columns

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

float|int

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

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

Параметры

строка $function
массив $columns

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

$this

protected смешанный тип onceWithColumns(array $columns, callable $callback)

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

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

Параметры

массив $columns
обратный вызов $callback

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

смешанный тип

логическое значение insert(array $values)

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

Параметры

массив $values

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

логическое значение

целое число insertOrIgnore(array $values)

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

Параметры

массив $values

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

целое число

целое число insertGetId(array $values, string|null $sequence = null)

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

Параметры

массив $values
строка|null $sequence

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

целое число

целое число insertUsing(array $columns, Closure|Билдер|строка $query)

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

Параметры

массив $columns
Closure|Билдер|строка $query

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

целое число

целое число update(array $values)

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

Параметры

массив $values

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

целое число

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

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

Parameters

array $attributes
array $values

Return Value

bool

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

Exceptions

InvalidArgumentException

int delete(mixed $id = null)

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

Parameters

mixed $id

Return Value

int

void truncate()

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

Return Value

void

Builder newQuery()

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

Return Value

Builder

protected Builder forSubQuery()

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

Return Value

Builder

Expression raw(mixed $value)

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

Parameters

mixed $value

Return Value

Expression

array getBindings()

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

Return Value

array

array getRawBindings()

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

Return Value

array

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

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

Parameters

array $bindings
string $type

Return Value

$this

Exceptions

InvalidArgumentException

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

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

Parameters

mixed $value
string $type

Return Value

$this

Exceptions

InvalidArgumentException

$this mergeBindings(Builder $query)

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

Parameters

Builder $query

Return Value

$this

protected 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 cloneWithout(array $properties)

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

Параметры

array $properties

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

Builder

Builder cloneWithoutBindings(array $except)

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

Параметры

array $except

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

Builder

$this dump()

Вывести текущий SQL и связывающие значения.

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

$this

void dd()

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

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

void

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

Spec-Zone.ru

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