Spec-Zone.ru › Laravel 5.3

Builder

class Builder (View source)

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
protected Connection $connection Экземпляр подключения к базе данных.
protected Grammar $grammar Экземпляр синтаксического анализатора запросов к базе данных.
protected Processor $processor Экземпляр обработчика запросов к базе данных.
protected array $bindings Текущие значения связываемых данных запроса.
array $aggregate Функция агрегирования и столбец для её выполнения.
array $columns Столбцы, которые должны быть возвращены.
bool $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 Указывает, используется ли блокировка строк.
protected array $backups Текущие резервные копии полей.
protected array $bindingBackups Текущие резервные копии привязок.
protected array $operators Все доступные операторы условий.
protected bool $useWritePdo Использовать ли write pdo для выбора.

Traits

Macroable

Методы

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

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

 из Macroable
static bool hasMacro(string $name)

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

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

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

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

Обрабатывает динамические вызовы методов в метод.
void __construct(ConnectionInterface $connection, Grammar $grammar = null, Processor $processor = null)

Создает новый экземпляр построителя запросов.
$this select(array|mixed $columns = ['*'])

Устанавливает столбцы для выбора.
Builder|Builder selectRaw(string $expression, array $bindings = [])

Добавляет новое "сырое" выражение select в запрос.
Builder|Builder selectSub(Closure|Builder|string $query, string $as)

Добавляет выражение подзапроса в запрос.
$this addSelect(array|mixed $column)

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

Принудительно заставляет запрос возвращать только уникальные результаты.
$this from(string $table)

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

Добавляет предложение join в запрос.
Builder|Builder joinWhere(string $table, string $one, string $operator, string $two, string $type = 'inner')

Добавляет предложение "join where" в запрос.
Builder|Builder leftJoin(string $table, string $first, string $operator = null, string $second = null)

Добавляет левое соединение в запрос.
Builder|Builder leftJoinWhere(string $table, string $one, string $operator, string $two)

Добавляет предложение "join where" в запрос.
Builder|Builder rightJoin(string $table, string $first, string $operator = null, string $second = null)

Добавляет правое соединение в запрос.
Builder|Builder rightJoinWhere(string $table, string $one, string $operator, string $two)

Добавляет предложение "right join where" в запрос.
Builder|Builder crossJoin(string $table, string $first = null, string $operator = null, string $second = null)

Добавляет предложение "cross join" в запрос.
Builder when(bool $value, Closure $callback, Closure $default = null)

Применяет изменения запроса обратного вызова, если заданное "значение" истинно.
$this where(string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')

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

Добавляет массив предложений where в запрос.
bool invalidOperatorAndValue(string $operator, mixed $value)

Определяет, является ли допустимым сочетание заданного оператора и значения.
Builder|Builder orWhere(Closure|string $column, string $operator = null, mixed $value = null)

Добавляет предложение "or where" в запрос.
Builder|Builder whereColumn(string|array $first, string|null $operator = null, string|null $second = null, string|null $boolean = 'and')

Добавляет предложение "where", сравнивающее два столбца, в запрос.
Builder|Builder orWhereColumn(string|array $first, string|null $operator = null, string|null $second = null)

Добавляет предложение "or where", сравнивающее два столбца, в запрос.
$this whereRaw(string $sql, mixed $bindings = [], string $boolean = 'and')

Добавляет "сырое" предложение where в запрос.
Builder|Builder orWhereRaw(string $sql, array $bindings = [])

Добавляет "сырое" предложение or where в запрос.
$this whereBetween(string $column, array $values, string $boolean = 'and', bool $not = false)

Добавляет предложение where between в запрос.
Builder|Builder orWhereBetween(string $column, array $values)

Добавляет предложение or where between в запрос.
Builder|Builder whereNotBetween(string $column, array $values, string $boolean = 'and')

Добавляет предложение where not between в запрос.
Builder|Builder orWhereNotBetween(string $column, array $values)

Добавляет предложение or where not between в запрос.
Builder|Builder whereNested(Closure $callback, string $boolean = 'and')

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

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

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

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

Добавить условие exists в запрос.
Builder|Builder orWhereExists(Closure $callback, bool $not = false)

Добавить условие or exists в запрос.
Builder|Builder whereNotExists(Closure $callback, string $boolean = 'and')

Добавить условие where not exists в запрос.
Builder|Builder orWhereNotExists(Closure $callback)

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

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

Добавить условие "where in" в запрос.
Builder|Builder orWhereIn(string $column, mixed $values)

Добавить условие "or where in" в запрос.
Builder|Builder whereNotIn(string $column, mixed $values, string $boolean = 'and')

Добавить условие "where not in" в запрос.
Builder|Builder orWhereNotIn(string $column, mixed $values)

Добавить условие "or where not in" в запрос.
$this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

Добавить условие where in с подзапросом в запрос.
$this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

Добавить внешнее подзапросное условие в запрос.
$this whereNull(string $column, string $boolean = 'and', bool $not = false)

Добавить условие "where null" в запрос.
Builder|Builder orWhereNull(string $column)

Добавить условие "or where null" в запрос.
Builder|Builder whereNotNull(string $column, string $boolean = 'and')

Добавить условие "where not null" в запрос.
Builder|Builder orWhereNotNull(string $column)

Добавить условие "or where not null" в запрос.
Builder|Builder whereDate(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "where date" в запрос.
Builder|Builder orWhereDate(string $column, string $operator, string $value)

Добавить условие "or where date" в запрос.
Builder|Builder whereTime(string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие "where time" в запрос.
Builder|Builder orWhereTime(string $column, string $operator, int $value)

Добавить условие "or where time" в запрос.
Builder|Builder whereDay(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "where day" в запрос.
Builder|Builder whereMonth(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "where month" в запрос.
Builder|Builder whereYear(string $column, string $operator, mixed $value = null, string $boolean = 'and')

Добавить условие "where year" в запрос.
$this addDateBasedWhere(string $type, string $column, string $operator, int $value, string $boolean = 'and')

Добавить условие, основанное на дате (год, месяц, день, время), в запрос.
array prepareValueAndOperator(string $value, string $operator, bool $useDefault = false)

Подготовить значение и оператор для условия where.
$this dynamicWhere(string $method, string $parameters)

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

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

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

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

Добавить условие «или имеющий» к запросу.
$this havingRaw(string $sql, array $bindings = [], string $boolean = 'and')

Добавить сырое условие «имеющий» к запросу.
Builder|Builder orHavingRaw(string $sql, array $bindings = [])

Добавить сырое условие «или имеющий» к запросу.
$this orderBy(string $column, string $direction = 'asc')

Добавить условие «упорядочить по» к запросу.
Builder|Builder latest(string $column = 'created_at')

Добавить условие «упорядочить по» для временной метки к запросу.
Builder|Builder oldest(string $column = 'created_at')

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

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

Добавить сырое условие «упорядочить по» к запросу.
$this offset(int $value)

Установить значение «смещения» запроса.
Builder|Builder skip(int $value)

Псевдоним для установки значения «смещения» запроса.
$this limit(int $value)

Установить значение «лимита» запроса.
Builder|Builder take(int $value)

Псевдоним для установки значения «лимита» запроса.
Builder|Builder forPage(int $page, int $perPage = 15)

Установить лимит и смещение для указанной страницы.
Builder|Builder forPageAfterId(int $perPage = 15, int $lastId, string $column = 'id')

Ограничить запрос следующей «страницей» результатов после заданного ID.
Builder|Closure union(Builder|Closure $query, bool $all = false)

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

Добавить оператор объединения всех к запросу.
$this lock(bool $value = true)

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

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

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

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

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

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

Выполнить запрос и получить первый результат.
Collection get(array $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 = ['*'])

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

Создать резервную копию, а затем удалить некоторые поля для подсчёта на страниц.
array clearSelectAliases(array $columns)

Удалить алиасы столбцов, так как они нарушат запросы подсчёта.
void restoreFieldsForCount()

Восстановить некоторые поля после подсчёта на страниц.
Generator cursor()

Получить генератор для данного запроса.
bool chunk(int $count, callable $callback)

Разбить результаты запроса на куски.
bool chunkById(int $count, callable $callback, string $column = 'id', string $alias = null)

Разбить результаты запроса на куски, сравнивая числовые ID.
bool each(callable $callback, int $count = 1000)

Выполнить обратный вызов над каждым элементом с разбиением на куски.
Collection pluck(string $column, string|null $key = null)

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

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

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

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

Получить результат "count" запроса.
mixed min(string $column)

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

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

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

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

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

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

Выполнить числовую агрегатную функцию на базе данных.
bool insert(array $values)

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

Вставить новую запись и получить значение первичного ключа.
int update(array $values)

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

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

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

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

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

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

Получить новый экземпляр билдера запросов.
void mergeWheres(array $wheres, array $bindings)

Объединить массив условий where и bind.
array cleanBindings(array $bindings)

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

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

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

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

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

Добавить bind к запросу.
$this mergeBindings(Builder $query)

Объединить массив bind в наш массив bind.
ConnectionInterface getConnection()

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

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

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

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

Подробности

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

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

Параметры

string $name
callable $macro

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

void

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

ConnectionInterface $connection
Grammar $grammar
Processor $processor

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

void

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

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

Параметры

array|mixed $columns

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

$this

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

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

Parameters

string $expression
array $bindings

Return Value

Builder|Builder

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

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

Parameters

Closure|Builder|string $query
string $as

Return Value

Builder|Builder

Exceptions

InvalidArgumentException

$this addSelect(array|mixed $column)

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

Parameters

array|mixed $column

Return Value

$this

$this distinct()

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

Return Value

$this

$this from(string $table)

Указать таблицу для запроса.

Parameters

string $table

Return Value

$this

$this join(string $table, string $one, string $operator = null, string $two = null, string $type = 'inner', bool $where = false)

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

Parameters

string $table
string $one
string $operator
string $two
string $type
bool $where

Return Value

$this

Builder|Builder joinWhere(string $table, string $one, string $operator, string $two, string $type = 'inner')

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

Parameters

string $table
string $one
string $operator
string $two
string $type

Return Value

Builder|Builder

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

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

Parameters

string $table
string $first
string $operator
string $second

Return Value

Builder|Builder

Builder|Builder leftJoinWhere(string $table, string $one, string $operator, string $two)

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

Parameters

string $table
string $one
string $operator
string $two

Return Value

Builder|Builder

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

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

Parameters

string $table
string $first
string $operator
string $second

Return Value

Builder|Builder

Builder|Builder rightJoinWhere(string $table, string $one, string $operator, string $two)

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

Parameters

string $table
string $one
string $operator
string $two

Return Value

Builder|Builder

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

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

Parameters

string $table
string $first
string $operator
string $second

Return Value

Builder|Builder

Builder when(bool $value, Closure $callback, Closure $default = null)

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

Parameters

bool $value
Closure $callback
Closure $default

Return Value

Builder

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

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

Параметры

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

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

$this

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

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

Параметры

array $column
string $boolean
string $method

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

$this

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

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

Параметры

string $operator
mixed $value

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

bool

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

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

Параметры

Closure|string $column
string $operator
mixed $value

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

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

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

Builder|Builder

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

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

Параметры

string $sql
mixed $bindings
string $boolean

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

$this

Builder|Builder orWhereRaw(string $sql, array $bindings = [])

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

Параметры

string $sql
array $bindings

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

Builder|Builder

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

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

Параметры

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

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

$this

Builder|Builder orWhereBetween(string $column, array $values)

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

Параметры

string $column
array $values

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

Builder|Builder

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

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

Параметры

string $column
array $values
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotBetween(string $column, array $values)

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

Параметры

string $column
array $values

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

Builder|Builder

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

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

Параметры

Closure $callback
string $boolean

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

Builder|Builder

Builder forNestedWhere()

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

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

Builder

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

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

Параметры

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)

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

Параметры

Closure $callback
string $boolean
bool $not

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

$this

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

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

Параметры

Closure $callback
bool $not

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

Builder|Builder

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

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

Параметры

Closure $callback
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotExists(Closure $callback)

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

Параметры

Closure $callback

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

Builder|Builder

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

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

Параметры

Builder $query
string $boolean
bool $not

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

$this

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

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

Параметры

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

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

$this

Builder|Builder orWhereIn(string $column, mixed $values)

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

Параметры

string $column
mixed $values

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

Builder|Builder

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

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

Параметры

string $column
mixed $values
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotIn(string $column, mixed $values)

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

Параметры

string $column
mixed $values

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

Builder|Builder

protected $this whereInSub(string $column, Closure $callback, string $boolean, bool $not)

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

Параметры

string $column
Closure $callback
string $boolean
bool $not

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

$this

protected $this whereInExistingQuery(string $column, Builder|Builder $query, string $boolean, bool $not)

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

Параметры

string $column
Builder|Builder $query
string $boolean
bool $not

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

$this

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

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

Параметры

string $column
string $boolean
bool $not

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

$this

Builder|Builder orWhereNull(string $column)

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

Параметры

string $column

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

Builder|Builder

Builder|Builder whereNotNull(string $column, string $boolean = 'and')

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

Параметры

string $column
string $boolean

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

Builder|Builder

Builder|Builder orWhereNotNull(string $column)

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

Параметры

string $column

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

Builder|Builder

Builder|Builder whereDate(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

Параметры

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

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

Builder|Builder

Builder|Builder orWhereDate(string $column, string $operator, string $value)

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

Параметры

string $column
string $operator
string $value

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

Builder|Builder

Builder|Builder whereTime(string $column, string $operator, int $value, string $boolean = 'and')

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

Параметры

string $column
string $operator
int $value
string $boolean

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

Builder|Builder

Builder|Builder orWhereTime(string $column, string $operator, int $value)

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

Параметры

string $column
string $operator
int $value

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

Builder|Builder

Builder|Builder whereDay(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

Параметры

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

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

Builder|Builder

Builder|Builder whereMonth(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

Параметры

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

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

Builder|Builder

Builder|Builder whereYear(string $column, string $operator, mixed $value = null, string $boolean = 'and')

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

Параметры

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

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

Builder|Builder

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

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

Параметры

string $type
string $column
string $operator
int $value
string $boolean

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

$this

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

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

Параметры

string $value
string $operator
bool $useDefault

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

array

Исключения

InvalidArgumentException

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

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

Параметры

string $method
string $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 $groups)

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

Параметры

array $groups

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

string $column
string $operator
string $value

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

Builder|Builder

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

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

Параметры

string $sql
array $bindings
string $boolean

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

$this

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

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

Параметры

string $sql
array $bindings

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

Builder|Builder

$this orderBy(string $column, string $direction = 'asc')

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

Параметры

string $column
string $direction

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

$this

Builder|Builder latest(string $column = 'created_at')

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

Параметры

string $column

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

Builder|Builder

Builder|Builder oldest(string $column = 'created_at')

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

Параметры

string $column

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

Builder|Builder

$this inRandomOrder(string $seed = '')

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

Параметры

string $seed

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

$this

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

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

Параметры

string $sql
array $bindings

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

$this

$this offset(int $value)

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

Параметры

int $value

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

$this

Builder|Builder skip(int $value)

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

Параметры

int $value

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

Builder|Builder

$this limit(int $value)

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

Параметры

int $value

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

$this

Builder|Builder take(int $value)

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

Параметры

int $value

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

Builder|Builder

Builder|Builder forPage(int $page, int $perPage = 15)

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

Параметры

int $page
int $perPage

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

Builder|Builder

Builder|Builder forPageAfterId(int $perPage = 15, int $lastId, string $column = 'id')

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

Параметры

int $perPage
int $lastId
string $column

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

Builder|Builder

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

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

Параметры

Builder|Closure $query
bool $all

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

Builder|Builder

Builder|Builder unionAll(Builder|Closure $query)

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

Параметры

Builder|Closure $query

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

Builder|Builder

$this lock(bool $value = true)

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

Параметры

bool $value

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

$this

Builder lockForUpdate()

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

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

Builder

Builder sharedLock()

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

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

Builder

string toSql()

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

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

string

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

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

Параметры

int $id
array $columns

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

mixed|Builder

mixed value(string $column)

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

Параметры

string $column

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

mixed

stdClass|array|null first(array $columns = ['*'])

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

Параметры

array $columns

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

stdClass|array|null

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

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

Параметры

array $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 void backupFieldsForCount()

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

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

void

protected array clearSelectAliases(array $columns)

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

Параметры

array $columns

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

array

protected void restoreFieldsForCount()

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

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

void

Generator cursor()

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

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

Generator

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

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

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

Параметры

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

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

bool

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

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

Параметры

callable $callback
int $count

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

bool

Исключения

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

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

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

Параметры

string $column
string $glue

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

string

bool exists()

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

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

bool

int count(string $columns = '*')

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

Параметры

string $columns

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

int

mixed min(string $column)

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

Параметры

string $column

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

mixed

mixed max(string $column)

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

Параметры

string $column

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

mixed

mixed sum(string $column)

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

Параметры

string $column

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

mixed

mixed avg(string $column)

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

Параметры

string $column

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

mixed

mixed average(string $column)

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

Параметры

string $column

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

mixed

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

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

Параметры

string $function
array $columns

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

mixed

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

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

Параметры

string $function
array $columns

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

float|int

bool insert(array $values)

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

Параметры

array $values

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

bool

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

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

Параметры

array $values
string $sequence

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

int

int update(array $values)

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

Параметры

array $values

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

int

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

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

Параметры

array $attributes
array $values

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

bool

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

string $column
int $amount
array $extra

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

int

int delete(mixed $id = null)

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

Параметры

mixed $id

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

int

void truncate()

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

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

void

Builder newQuery()

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

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

Builder

void mergeWheres(array $wheres, array $bindings)

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

Параметры

array $wheres
array $bindings

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

void

protected array cleanBindings(array $bindings)

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

Параметры

array $bindings

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

array

Expression raw(mixed $value)

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

Параметры

mixed $value

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

Expression

array getBindings()

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

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

array

array getRawBindings()

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

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

array

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

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

Параметры

array $bindings
string $type

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

mixed $value
string $type

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

$this

Исключения

InvalidArgumentException

$this mergeBindings(Builder $query)

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

Параметры

Builder $query

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

$this

ConnectionInterface getConnection()

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

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

ConnectionInterface

Processor getProcessor()

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

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

Processor

Grammar getGrammar()

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

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

Grammar

$this useWritePdo()

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

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

$this

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

Spec-Zone.ru

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