1. class
  2. Illuminate
  3. Database
  4. Query
  5. Builder

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 = null, Processor $processor = null)

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.

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

Add a "cross join" clause to the query.

Builder
when( bool $value, Closure $callback)

Apply the callback's query changes if the given "value" is true.

$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.

Builder
forNestedWhere()

Create a new query instance for nested where condition.

$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
addWhereExistsQuery( Builder $query, string $boolean = 'and', bool $not = false)

Add an 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
orWhereDate( string $column, string $operator, int $value)

Add an "or 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
forPageAfterId( int $perPage = 15, int $lastId, string $column = 'id')

Constrain the query to the next "page" of results after a given ID.

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

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.

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

Chunk the results of a query by comparing numeric IDs.

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

Execute a callback over each item while chunking.

array
pluck( string $column, string|null $key = null)

Get an array with the values of a given column.

array
lists( string $column, string|null $key = null)

Alias for the "pluck" method.

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.

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

Insert or update a record matching the attributes, and fill it with values.

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

in Macroable at line line 24
static void macro( string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line line 35
static bool hasMacro( string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line line 49
static mixed __callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 2246
mixed __call( string $method, array $parameters)

Handle dynamic method calls into the method.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new query builder instance.

Parameters

ConnectionInterface $connection
Grammar $grammar
Processor $processor

Return Value

void

at line line 230
$this select( array|mixed $columns = array('*'))

Set the columns to be selected.

Parameters

array|mixed $columns

Return Value

$this

at line line 244
Builder|Builder selectRaw( string $expression, array $bindings = array())

Add a new "raw" select expression to the query.

Parameters

string $expression
array $bindings

Return Value

Builder|Builder

at line line 264
Builder|Builder selectSub( Closure|Builder|string $query, string $as)

Add a subselect expression to the query.

Parameters

Closure|Builder|string $query
string $as

Return Value

Builder|Builder

Exceptions

InvalidArgumentException

at line line 291
$this addSelect( array|mixed $column)

Add a new select column to the query.

Parameters

array|mixed $column

Return Value

$this

at line line 305
$this distinct()

Force the query to only return distinct results.

Return Value

$this

at line line 318
$this from( string $table)

Set the table which the query is targeting.

Parameters

string $table

Return Value

$this

at line line 336
$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.

Parameters

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

Return Value

$this

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

Add a "join where" clause to the query.

Parameters

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

Return Value

Builder|Builder

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

Add a left join to the query.

Parameters

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

Return Value

Builder|Builder

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

Add a "join where" clause to the query.

Parameters

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

Return Value

Builder|Builder

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

Add a right join to the query.

Parameters

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

Return Value

Builder|Builder

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

Add a "right join where" clause to the query.

Parameters

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

Return Value

Builder|Builder

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

Add a "cross join" clause to the query.

Parameters

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

Return Value

Builder|Builder

at line line 465
Builder when( bool $value, Closure $callback)

Apply the callback's query changes if the given "value" is true.

Parameters

bool $value
Closure $callback

Return Value

Builder

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

Add a basic where clause to the query.

Parameters

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

Return Value

$this

Exceptions

InvalidArgumentException

at line line 576
Builder|Builder orWhere( string $column, string $operator = null, mixed $value = null)

Add an "or where" clause to the query.

Parameters

string $column
string $operator
mixed $value

Return Value

Builder|Builder

at line line 603
$this whereRaw( string $sql, array $bindings = array(), string $boolean = 'and')

Add a raw where clause to the query.

Parameters

string $sql
array $bindings
string $boolean

Return Value

$this

at line line 621
Builder|Builder orWhereRaw( string $sql, array $bindings = array())

Add a raw or where clause to the query.

Parameters

string $sql
array $bindings

Return Value

Builder|Builder

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

Add a where between statement to the query.

Parameters

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

Return Value

$this

at line line 653
Builder|Builder orWhereBetween( string $column, array $values)

Add an or where between statement to the query.

Parameters

string $column
array $values

Return Value

Builder|Builder

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

Add a where not between statement to the query.

Parameters

string $column
array $values
string $boolean

Return Value

Builder|Builder

at line line 678
Builder|Builder orWhereNotBetween( string $column, array $values)

Add an or where not between statement to the query.

Parameters

string $column
array $values

Return Value

Builder|Builder

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

Add a nested where statement to the query.

Parameters

Closure $callback
string $boolean

Return Value

Builder|Builder

at line line 704
Builder forNestedWhere()

Create a new query instance for nested where condition.

Return Value

Builder

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

Add another query builder as a nested where to the query builder.

Parameters

Builder|Builder $query
string $boolean

Return Value

$this

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

Add an exists clause to the query.

Parameters

Closure $callback
string $boolean
bool $not

Return Value

$this

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

Add an or exists clause to the query.

Parameters

Closure $callback
bool $not

Return Value

Builder|Builder

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

Add a where not exists clause to the query.

Parameters

Closure $callback
string $boolean

Return Value

Builder|Builder

at line line 808
Builder|Builder orWhereNotExists( Closure $callback)

Add a where not exists clause to the query.

Parameters

Closure $callback

Return Value

Builder|Builder

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

Add an exists clause to the query.

Parameters

Builder $query
string $boolean
bool $not

Return Value

$this

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

Add a "where in" clause to the query.

Parameters

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

Return Value

$this

at line line 876
Builder|Builder orWhereIn( string $column, mixed $values)

Add an "or where in" clause to the query.

Parameters

string $column
mixed $values

Return Value

Builder|Builder

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

Add a "where not in" clause to the query.

Parameters

string $column
mixed $values
string $boolean

Return Value

Builder|Builder

at line line 901
Builder|Builder orWhereNotIn( string $column, mixed $values)

Add an "or where not in" clause to the query.

Parameters

string $column
mixed $values

Return Value

Builder|Builder

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

Add a "where null" clause to the query.

Parameters

string $column
string $boolean
bool $not

Return Value

$this

at line line 974
Builder|Builder orWhereNull( string $column)

Add an "or where null" clause to the query.

Parameters

string $column

Return Value

Builder|Builder

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

Add a "where not null" clause to the query.

Parameters

string $column
string $boolean

Return Value

Builder|Builder

at line line 997
Builder|Builder orWhereNotNull( string $column)

Add an "or where not null" clause to the query.

Parameters

string $column

Return Value

Builder|Builder

at line line 1011
Builder|Builder whereDate( string $column, string $operator, int $value, string $boolean = 'and')

Add a "where date" statement to the query.

Parameters

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

Return Value

Builder|Builder

at line line 1024
Builder|Builder orWhereDate( string $column, string $operator, int $value)

Add an "or where date" statement to the query.

Parameters

string $column
string $operator
int $value

Return Value

Builder|Builder

at line line 1038
Builder|Builder whereDay( string $column, string $operator, int $value, string $boolean = 'and')

Add a "where day" statement to the query.

Parameters

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

Return Value

Builder|Builder

at line line 1052
Builder|Builder whereMonth( string $column, string $operator, int $value, string $boolean = 'and')

Add a "where month" statement to the query.

Parameters

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

Return Value

Builder|Builder

at line line 1066
Builder|Builder whereYear( string $column, string $operator, int $value, string $boolean = 'and')

Add a "where year" statement to the query.

Parameters

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

Return Value

Builder|Builder

at line line 1097
$this dynamicWhere( string $method, string $parameters)

Handles dynamic "where" clauses to the query.

Parameters

string $method
string $parameters

Return Value

$this

at line line 1156
$this groupBy()

Add a "group by" clause to the query.

Return Value

$this

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

Add a "having" clause to the query.

Parameters

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

Return Value

$this

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

Add a "or having" clause to the query.

Parameters

string $column
string $operator
string $value

Return Value

Builder|Builder

at line line 1208
$this havingRaw( string $sql, array $bindings = array(), string $boolean = 'and')

Add a raw having clause to the query.

Parameters

string $sql
array $bindings
string $boolean

Return Value

$this

at line line 1226
Builder|Builder orHavingRaw( string $sql, array $bindings = array())

Add a raw or having clause to the query.

Parameters

string $sql
array $bindings

Return Value

Builder|Builder

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

Add an "order by" clause to the query.

Parameters

string $column
string $direction

Return Value

$this

at line line 1254
Builder|Builder latest( string $column = 'created_at')

Add an "order by" clause for a timestamp to the query.

Parameters

string $column

Return Value

Builder|Builder

at line line 1265
Builder|Builder oldest( string $column = 'created_at')

Add an "order by" clause for a timestamp to the query.

Parameters

string $column

Return Value

Builder|Builder

at line line 1277
$this orderByRaw( string $sql, array $bindings = array())

Add a raw "order by" clause to the query.

Parameters

string $sql
array $bindings

Return Value

$this

at line line 1296
$this offset( int $value)

Set the "offset" value of the query.

Parameters

int $value

Return Value

$this

at line line 1311
Builder|Builder skip( int $value)

Alias to set the "offset" value of the query.

Parameters

int $value

Return Value

Builder|Builder

at line line 1322
$this limit( int $value)

Set the "limit" value of the query.

Parameters

int $value

Return Value

$this

at line line 1339
Builder|Builder take( int $value)

Alias to set the "limit" value of the query.

Parameters

int $value

Return Value

Builder|Builder

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

Set the limit and offset for a given page.

Parameters

int $page
int $perPage

Return Value

Builder|Builder

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

Constrain the query to the next "page" of results after a given ID.

Parameters

int $perPage
int $lastId
string $column

Return Value

Builder|Builder

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

Add a union statement to the query.

Parameters

Builder|Closure $query
bool $all

Return Value

Builder|Builder

at line line 1397
Builder|Builder unionAll( Builder|Closure $query)

Add a union all statement to the query.

Parameters

Builder|Closure $query

Return Value

Builder|Builder

at line line 1408
$this lock( bool $value = true)

Lock the selected rows in the table.

Parameters

bool $value

Return Value

$this

at line line 1424
Builder lockForUpdate()

Lock the selected rows in the table for updating.

Return Value

Builder

at line line 1434
Builder sharedLock()

Share lock the selected rows in the table.

Return Value

Builder

at line line 1444
string toSql()

Get the SQL representation of the query.

Return Value

string

at line line 1456
mixed|Builder find( int $id, array $columns = array('*'))

Execute a query for a single record by ID.

Parameters

int $id
array $columns

Return Value

mixed|Builder

at line line 1467
mixed value( string $column)

Get a single column's value from the first result of a query.

Parameters

string $column

Return Value

mixed

at line line 1480
mixed|Builder first( array $columns = array('*'))

Execute the query and get the first result.

Parameters

array $columns

Return Value

mixed|Builder

at line line 1493
array|Builder[] get( array $columns = array('*'))

Execute the query as a "select" statement.

Parameters

array $columns

Return Value

array|Builder[]

at line line 1527
LengthAwarePaginator paginate( int $perPage = 15, array $columns = array('*'), string $pageName = 'page', int|null $page = null)

Paginate the given query into a simple paginator.

Parameters

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

Return Value

LengthAwarePaginator

at line line 1551
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.

Parameters

int $perPage
array $columns
string $pageName

Return Value

Paginator

at line line 1569
int getCountForPagination( array $columns = array('*'))

Get the count of the total records for the paginator.

Parameters

array $columns

Return Value

int

at line line 1648
bool chunk( int $count, callable $callback)

Chunk the results of the query.

Parameters

int $count
callable $callback

Return Value

bool

at line line 1676
bool chunkById( int $count, callable $callback, string $column = 'id')

Chunk the results of a query by comparing numeric IDs.

Parameters

int $count
callable $callback
string $column

Return Value

bool

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

Execute a callback over each item while chunking.

Parameters

callable $callback
int $count

Return Value

bool

Exceptions

RuntimeException

at line line 1726
array pluck( string $column, string|null $key = null)

Get an array with the values of a given column.

Parameters

string $column
string|null $key

Return Value

array

at line line 1749
array lists( string $column, string|null $key = null)

Alias for the "pluck" method.

Parameters

string $column
string|null $key

Return Value

array

at line line 1772
string implode( string $column, string $glue = '')

Concatenate values of a given column as a string.

Parameters

string $column
string $glue

Return Value

string

at line line 1782
bool exists()

Determine if any rows exist for the current query.

Return Value

bool

at line line 1803
int count( string $columns = '*')

Retrieve the "count" result of the query.

Parameters

string $columns

Return Value

int

at line line 1818
float|int min( string $column)

Retrieve the minimum value of a given column.

Parameters

string $column

Return Value

float|int

at line line 1829
float|int max( string $column)

Retrieve the maximum value of a given column.

Parameters

string $column

Return Value

float|int

at line line 1840
float|int sum( string $column)

Retrieve the sum of the values of a given column.

Parameters

string $column

Return Value

float|int

at line line 1853
float|int avg( string $column)

Retrieve the average of the values of a given column.

Parameters

string $column

Return Value

float|int

at line line 1864
float|int average( string $column)

Alias for the "avg" method.

Parameters

string $column

Return Value

float|int

at line line 1876
float|int aggregate( string $function, array $columns = array('*'))

Execute an aggregate function on the database.

Parameters

string $function
array $columns

Return Value

float|int

at line line 1913
bool insert( array $values)

Insert a new record into the database.

Parameters

array $values

Return Value

bool

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

Insert a new record and get the value of the primary key.

Parameters

array $values
string $sequence

Return Value

int

at line line 1979
int update( array $values)

Update a record in the database.

Parameters

array $values

Return Value

int

at line line 1995
bool updateOrInsert( array $attributes, array $values = array())

Insert or update a record matching the attributes, and fill it with values.

Parameters

array $attributes
array $values

Return Value

bool

at line line 2012
int increment( string $column, int $amount = 1, array $extra = array())

Increment a column's value by a given amount.

Parameters

string $column
int $amount
array $extra

Return Value

int

at line line 2029
int decrement( string $column, int $amount = 1, array $extra = array())

Decrement a column's value by a given amount.

Parameters

string $column
int $amount
array $extra

Return Value

int

at line line 2044
int delete( mixed $id = null)

Delete a record from the database.

Parameters

mixed $id

Return Value

int

at line line 2063
void truncate()

Run a truncate statement on the table.

Return Value

void

at line line 2075
Builder newQuery()

Get a new instance of the query builder.

Return Value

Builder

at line line 2087
void mergeWheres( array $wheres, array $bindings)

Merge an array of where clauses and bindings.

Parameters

array $wheres
array $bindings

Return Value

void

at line line 2113
Expression raw( mixed $value)

Create a raw database expression.

Parameters

mixed $value

Return Value

Expression

at line line 2123
array getBindings()

Get the current query value bindings in a flattened array.

Return Value

array

at line line 2133
array getRawBindings()

Get the raw array of bindings.

Return Value

array

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

Set the bindings on the query builder.

Parameters

array $bindings
string $type

Return Value

$this

Exceptions

InvalidArgumentException

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

Add a binding to the query.

Parameters

mixed $value
string $type

Return Value

$this

Exceptions

InvalidArgumentException

at line line 2188
$this mergeBindings( Builder $query)

Merge an array of bindings into our bindings.

Parameters

Builder $query

Return Value

$this

at line line 2200
ConnectionInterface getConnection()

Get the database connection instance.

Return Value

ConnectionInterface

at line line 2210
Processor getProcessor()

Get the database query processor instance.

Return Value

Processor

at line line 2220
Grammar getGrammar()

Get the query grammar instance.

Return Value

Grammar

at line line 2230
$this useWritePdo()

Use the write pdo for query.

Return Value

$this