Builder (Database\Query)
Builder
class Builder (View source)
Traits
Macroable |
Properties
array | $aggregate | An aggregate function and column to be run. | |
array | $columns | The columns that should be returned. | |
bool | $distinct | Indicates if the query returns distinct results. | |
string | $from | The table which the query is targeting. | |
array | $joins | The table joins for the query. | |
array | $wheres | The where constraints for the query. | |
array | $groups | The groupings for the query. | |
array | $havings | The having constraints for the query. | |
array | $orders | The orderings for the query. | |
int | $limit | The maximum number of records to return. | |
int | $offset | The number of records to skip. | |
array | $unions | The query union statements. | |
int | $unionLimit | The maximum number of union records to return. | |
int | $unionOffset | The number of union records to skip. | |
array | $unionOrders | The orderings for the union query. | |
string|bool | $lock | Indicates whether row locking is being used. |
Methods
static void | macro( string $name, callable $macro) Register a custom macro. | from Macroable |
static bool | hasMacro( string $name) Checks if macro is registered. | from Macroable |
static mixed | __callStatic( string $method, array $parameters) Dynamically handle calls to the class. | from Macroable |
mixed | __call( string $method, array $parameters) Handle dynamic method calls into the method. | |
void | __construct( ConnectionInterface $connection, Grammar $grammar, Processor $processor) Create a new query builder instance. | |
$this | select( array|mixed $columns = array('*')) Set the columns to be selected. | |
Builder|Builder | selectRaw( string $expression, array $bindings = array()) Add a new "raw" select expression to the query. | |
Builder|Builder | selectSub( Closure|Builder|string $query, string $as) Add a subselect expression to the query. | |
$this | addSelect( array|mixed $column) Add a new select column to the query. | |
$this | distinct() Force the query to only return distinct results. | |
$this | from( string $table) Set the table which the query is targeting. | |
$this | join( string $table, string $one, string $operator = null, string $two = null, string $type = 'inner', bool $where = false) Add a join clause to the query. | |
Builder|Builder | joinWhere( string $table, string $one, string $operator, string $two, string $type = 'inner') Add a "join where" clause to the query. | |
Builder|Builder | leftJoin( string $table, string $first, string $operator = null, string $second = null) Add a left join to the query. | |
Builder|Builder | leftJoinWhere( string $table, string $one, string $operator, string $two) Add a "join where" clause to the query. | |
Builder|Builder | rightJoin( string $table, string $first, string $operator = null, string $second = null) Add a right join to the query. | |
Builder|Builder | rightJoinWhere( string $table, string $one, string $operator, string $two) Add a "right join where" clause to the query. | |
$this | where( string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and') Add a basic where clause to the query. | |
Builder|Builder | orWhere( string $column, string $operator = null, mixed $value = null) Add an "or where" clause to the query. | |
$this | whereRaw( string $sql, array $bindings = array(), string $boolean = 'and') Add a raw where clause to the query. | |
Builder|Builder | orWhereRaw( string $sql, array $bindings = array()) Add a raw or where clause to the query. | |
$this | whereBetween( string $column, array $values, string $boolean = 'and', bool $not = false) Add a where between statement to the query. | |
Builder|Builder | orWhereBetween( string $column, array $values) Add an or where between statement to the query. | |
Builder|Builder | whereNotBetween( string $column, array $values, string $boolean = 'and') Add a where not between statement to the query. | |
Builder|Builder | orWhereNotBetween( string $column, array $values) Add an or where not between statement to the query. | |
Builder|Builder | whereNested( Closure $callback, string $boolean = 'and') Add a nested where statement to the query. | |
$this | addNestedWhereQuery( Builder|Builder $query, string $boolean = 'and') Add another query builder as a nested where to the query builder. | |
$this | whereExists( Closure $callback, string $boolean = 'and', bool $not = false) Add an exists clause to the query. | |
Builder|Builder | orWhereExists( Closure $callback, bool $not = false) Add an or exists clause to the query. | |
Builder|Builder | whereNotExists( Closure $callback, string $boolean = 'and') Add a where not exists clause to the query. | |
Builder|Builder | orWhereNotExists( Closure $callback) Add a where not exists clause to the query. | |
$this | whereIn( string $column, mixed $values, string $boolean = 'and', bool $not = false) Add a "where in" clause to the query. | |
Builder|Builder | orWhereIn( string $column, mixed $values) Add an "or where in" clause to the query. | |
Builder|Builder | whereNotIn( string $column, mixed $values, string $boolean = 'and') Add a "where not in" clause to the query. | |
Builder|Builder | orWhereNotIn( string $column, mixed $values) Add an "or where not in" clause to the query. | |
$this | whereNull( string $column, string $boolean = 'and', bool $not = false) Add a "where null" clause to the query. | |
Builder|Builder | orWhereNull( string $column) Add an "or where null" clause to the query. | |
Builder|Builder | whereNotNull( string $column, string $boolean = 'and') Add a "where not null" clause to the query. | |
Builder|Builder | orWhereNotNull( string $column) Add an "or where not null" clause to the query. | |
Builder|Builder | whereDate( string $column, string $operator, int $value, string $boolean = 'and') Add a "where date" statement to the query. | |
Builder|Builder | whereDay( string $column, string $operator, int $value, string $boolean = 'and') Add a "where day" statement to the query. | |
Builder|Builder | whereMonth( string $column, string $operator, int $value, string $boolean = 'and') Add a "where month" statement to the query. | |
Builder|Builder | whereYear( string $column, string $operator, int $value, string $boolean = 'and') Add a "where year" statement to the query. | |
$this | dynamicWhere( string $method, string $parameters) Handles dynamic "where" clauses to the query. | |
$this | groupBy() Add a "group by" clause to the query. | |
$this | having( string $column, string $operator = null, string $value = null, string $boolean = 'and') Add a "having" clause to the query. | |
Builder|Builder | orHaving( string $column, string $operator = null, string $value = null) Add a "or having" clause to the query. | |
$this | havingRaw( string $sql, array $bindings = array(), string $boolean = 'and') Add a raw having clause to the query. | |
Builder|Builder | orHavingRaw( string $sql, array $bindings = array()) Add a raw or having clause to the query. | |
$this | orderBy( string $column, string $direction = 'asc') Add an "order by" clause to the query. | |
Builder|Builder | latest( string $column = 'created_at') Add an "order by" clause for a timestamp to the query. | |
Builder|Builder | oldest( string $column = 'created_at') Add an "order by" clause for a timestamp to the query. | |
$this | orderByRaw( string $sql, array $bindings = array()) Add a raw "order by" clause to the query. | |
$this | offset( int $value) Set the "offset" value of the query. | |
Builder|Builder | skip( int $value) Alias to set the "offset" value of the query. | |
$this | limit( int $value) Set the "limit" value of the query. | |
Builder|Builder | take( int $value) Alias to set the "limit" value of the query. | |
Builder|Builder | forPage( int $page, int $perPage = 15) Set the limit and offset for a given page. | |
Builder|Builder | union( Builder|Closure $query, bool $all = false) Add a union statement to the query. | |
Builder|Builder | unionAll( Builder|Closure $query) Add a union all statement to the query. | |
$this | lock( bool $value = true) Lock the selected rows in the table. | |
Builder | lockForUpdate() Lock the selected rows in the table for updating. | |
Builder | sharedLock() Share lock the selected rows in the table. | |
string | toSql() Get the SQL representation of the query. | |
mixed|Builder | find( int $id, array $columns = array('*')) Execute a query for a single record by ID. | |
mixed | value( string $column) Get a single column's value from the first result of a query. | |
mixed | pluck( string $column) Get a single column's value from the first result of a query. | |
mixed|Builder | first( array $columns = array('*')) Execute the query and get the first result. | |
array|Builder[] | get( array $columns = array('*')) Execute the query as a "select" statement. | |
array|Builder[] | getFresh( array $columns = array('*')) Execute the query as a fresh "select" statement. | |
LengthAwarePaginator | paginate( int $perPage = 15, array $columns = array('*'), string $pageName = 'page', int|null $page = null) Paginate the given query into a simple paginator. | |
Paginator | simplePaginate( int $perPage = 15, array $columns = array('*'), string $pageName = 'page') Get a paginator only supporting simple next and previous links. | |
int | getCountForPagination( array $columns = array('*')) Get the count of the total records for the paginator. | |
bool | chunk( int $count, callable $callback) Chunk the results of the query. | |
array | lists( string $column, string|null $key = null) Get an array with the values of a given column. | |
string | implode( string $column, string $glue = '') Concatenate values of a given column as a string. | |
bool | exists() Determine if any rows exist for the current query. | |
int | count( string $columns = '*') Retrieve the "count" result of the query. | |
float|int | min( string $column) Retrieve the minimum value of a given column. | |
float|int | max( string $column) Retrieve the maximum value of a given column. | |
float|int | sum( string $column) Retrieve the sum of the values of a given column. | |
float|int | avg( string $column) Retrieve the average of the values of a given column. | |
float|int | average( string $column) Alias for the "avg" method. | |
float|int | aggregate( string $function, array $columns = array('*')) Execute an aggregate function on the database. | |
bool | insert( array $values) Insert a new record into the database. | |
int | insertGetId( array $values, string $sequence = null) Insert a new record and get the value of the primary key. | |
int | update( array $values) Update a record in the database. | |
int | increment( string $column, int $amount = 1, array $extra = array()) Increment a column's value by a given amount. | |
int | decrement( string $column, int $amount = 1, array $extra = array()) Decrement a column's value by a given amount. | |
int | delete( mixed $id = null) Delete a record from the database. | |
void | truncate() Run a truncate statement on the table. | |
Builder | newQuery() Get a new instance of the query builder. | |
void | mergeWheres( array $wheres, array $bindings) Merge an array of where clauses and bindings. | |
Expression | raw( mixed $value) Create a raw database expression. | |
array | getBindings() Get the current query value bindings in a flattened array. | |
array | getRawBindings() Get the raw array of bindings. | |
$this | setBindings( array $bindings, string $type = 'where') Set the bindings on the query builder. | |
$this | addBinding( mixed $value, string $type = 'where') Add a binding to the query. | |
$this | mergeBindings( Builder $query) Merge an array of bindings into our bindings. | |
ConnectionInterface | getConnection() Get the database connection instance. | |
Processor | getProcessor() Get the database query processor instance. | |
Grammar | getGrammar() Get the query grammar instance. | |
$this | useWritePdo() Use the write pdo for query. |
Details
static void macro( string $name, callable $macro)
Register a custom macro.
static bool hasMacro( string $name)
Checks if macro is registered.
static mixed __callStatic( string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call( string $method, array $parameters)
Handle dynamic method calls into the method.
void __construct( ConnectionInterface $connection, Grammar $grammar, Processor $processor)
Create a new query builder instance.
$this select( array|mixed $columns = array('*'))
Set the columns to be selected.
Builder|Builder selectRaw( string $expression, array $bindings = array())
Add a new "raw" select expression to the query.
Builder|Builder selectSub( Closure|Builder|string $query, string $as)
Add a subselect expression to the query.
$this addSelect( array|mixed $column)
Add a new select column to the query.
$this distinct()
Force the query to only return distinct results.
$this from( string $table)
Set the table which the query is targeting.
$this join( string $table, string $one, string $operator = null, string $two = null, string $type = 'inner', bool $where = false)
Add a join clause to the query.
Builder|Builder joinWhere( string $table, string $one, string $operator, string $two, string $type = 'inner')
Add a "join where" clause to the query.
Builder|Builder leftJoin( string $table, string $first, string $operator = null, string $second = null)
Add a left join to the query.
Builder|Builder leftJoinWhere( string $table, string $one, string $operator, string $two)
Add a "join where" clause to the query.
Builder|Builder rightJoin( string $table, string $first, string $operator = null, string $second = null)
Add a right join to the query.
Builder|Builder rightJoinWhere( string $table, string $one, string $operator, string $two)
Add a "right join where" clause to the query.
$this where( string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')
Add a basic where clause to the query.
Builder|Builder orWhere( string $column, string $operator = null, mixed $value = null)
Add an "or where" clause to the query.
$this whereRaw( string $sql, array $bindings = array(), string $boolean = 'and')
Add a raw where clause to the query.
Builder|Builder orWhereRaw( string $sql, array $bindings = array())
Add a raw or where clause to the query.
$this whereBetween( string $column, array $values, string $boolean = 'and', bool $not = false)
Add a where between statement to the query.
Builder|Builder orWhereBetween( string $column, array $values)
Add an or where between statement to the query.
Builder|Builder whereNotBetween( string $column, array $values, string $boolean = 'and')
Add a where not between statement to the query.
Builder|Builder orWhereNotBetween( string $column, array $values)
Add an or where not between statement to the query.
Builder|Builder whereNested( Closure $callback, string $boolean = 'and')
Add a nested where statement to the query.
$this addNestedWhereQuery( Builder|Builder $query, string $boolean = 'and')
Add another query builder as a nested where to the query builder.
$this whereExists( Closure $callback, string $boolean = 'and', bool $not = false)
Add an exists clause to the query.
Builder|Builder orWhereExists( Closure $callback, bool $not = false)
Add an or exists clause to the query.
Builder|Builder whereNotExists( Closure $callback, string $boolean = 'and')
Add a where not exists clause to the query.
$this whereIn( string $column, mixed $values, string $boolean = 'and', bool $not = false)
Add a "where in" clause to the query.
Builder|Builder whereNotIn( string $column, mixed $values, string $boolean = 'and')
Add a "where not in" clause to the query.
Builder|Builder orWhereNotIn( string $column, mixed $values)
Add an "or where not in" clause to the query.
$this whereNull( string $column, string $boolean = 'and', bool $not = false)
Add a "where null" clause to the query.
Builder|Builder whereNotNull( string $column, string $boolean = 'and')
Add a "where not null" clause to the query.
Builder|Builder whereDate( string $column, string $operator, int $value, string $boolean = 'and')
Add a "where date" statement to the query.
Builder|Builder whereDay( string $column, string $operator, int $value, string $boolean = 'and')
Add a "where day" statement to the query.
Builder|Builder whereMonth( string $column, string $operator, int $value, string $boolean = 'and')
Add a "where month" statement to the query.
Builder|Builder whereYear( string $column, string $operator, int $value, string $boolean = 'and')
Add a "where year" statement to the query.
$this dynamicWhere( string $method, string $parameters)
Handles dynamic "where" clauses to the query.
$this groupBy()
Add a "group by" clause to the query.
$this having( string $column, string $operator = null, string $value = null, string $boolean = 'and')
Add a "having" clause to the query.
Builder|Builder orHaving( string $column, string $operator = null, string $value = null)
Add a "or having" clause to the query.
$this havingRaw( string $sql, array $bindings = array(), string $boolean = 'and')
Add a raw having clause to the query.
Builder|Builder orHavingRaw( string $sql, array $bindings = array())
Add a raw or having clause to the query.
$this orderBy( string $column, string $direction = 'asc')
Add an "order by" clause to the query.
Builder|Builder latest( string $column = 'created_at')
Add an "order by" clause for a timestamp to the query.
Builder|Builder oldest( string $column = 'created_at')
Add an "order by" clause for a timestamp to the query.
$this orderByRaw( string $sql, array $bindings = array())
Add a raw "order by" clause to the query.
$this offset( int $value)
Set the "offset" value of the query.
$this limit( int $value)
Set the "limit" value of the query.
Builder|Builder union( Builder|Closure $query, bool $all = false)
Add a union statement to the query.
$this lock( bool $value = true)
Lock the selected rows in the table.
Builder lockForUpdate()
Lock the selected rows in the table for updating.
Builder sharedLock()
Share lock the selected rows in the table.
string toSql()
Get the SQL representation of the query.
mixed|Builder find( int $id, array $columns = array('*'))
Execute a query for a single record by ID.
mixed value( string $column)
Get a single column's value from the first result of a query.
mixed pluck( string $column)
Get a single column's value from the first result of a query.
This is an alias for the "value" method.
mixed|Builder first( array $columns = array('*'))
Execute the query and get the first result.
array|Builder[] get( array $columns = array('*'))
Execute the query as a "select" statement.
array|Builder[] getFresh( array $columns = array('*'))
Execute the query as a fresh "select" statement.
LengthAwarePaginator paginate( int $perPage = 15, array $columns = array('*'), string $pageName = 'page', int|null $page = null)
Paginate the given query into a simple paginator.
Paginator simplePaginate( int $perPage = 15, array $columns = array('*'), string $pageName = 'page')
Get a paginator only supporting simple next and previous links.
This is more efficient on larger data-sets, etc.
int getCountForPagination( array $columns = array('*'))
Get the count of the total records for the paginator.
bool chunk( int $count, callable $callback)
Chunk the results of the query.
array lists( string $column, string|null $key = null)
Get an array with the values of a given column.
string implode( string $column, string $glue = '')
Concatenate values of a given column as a string.
bool exists()
Determine if any rows exist for the current query.
int count( string $columns = '*')
Retrieve the "count" result of the query.
float|int min( string $column)
Retrieve the minimum value of a given column.
float|int max( string $column)
Retrieve the maximum value of a given column.
float|int sum( string $column)
Retrieve the sum of the values of a given column.
float|int avg( string $column)
Retrieve the average of the values of a given column.
float|int average( string $column)
Alias for the "avg" method.
float|int aggregate( string $function, array $columns = array('*'))
Execute an aggregate function on the database.
bool insert( array $values)
Insert a new record into the database.
int insertGetId( array $values, string $sequence = null)
Insert a new record and get the value of the primary key.
int update( array $values)
Update a record in the database.
int increment( string $column, int $amount = 1, array $extra = array())
Increment a column's value by a given amount.
int decrement( string $column, int $amount = 1, array $extra = array())
Decrement a column's value by a given amount.
int delete( mixed $id = null)
Delete a record from the database.
void truncate()
Run a truncate statement on the table.
Builder newQuery()
Get a new instance of the query builder.
void mergeWheres( array $wheres, array $bindings)
Merge an array of where clauses and bindings.
Expression raw( mixed $value)
Create a raw database expression.
array getBindings()
Get the current query value bindings in a flattened array.
array getRawBindings()
Get the raw array of bindings.
$this setBindings( array $bindings, string $type = 'where')
Set the bindings on the query builder.
$this addBinding( mixed $value, string $type = 'where')
Add a binding to the query.
$this mergeBindings( Builder $query)
Merge an array of bindings into our bindings.
ConnectionInterface getConnection()
Get the database connection instance.
Processor getProcessor()
Get the database query processor instance.
Grammar getGrammar()
Get the query grammar instance.
$this useWritePdo()
Use the write pdo for query.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Database/Query/Builder.html