mako\database\midgard\Query | Mako Framework API

class Query extends Query

ORM query builder.

Properties

protected Connection	$connection	Database connection.	from Query
protected HelperInterface	$helper	Query helper.	from Query
protected Compiler	$compiler	Query compiler.	from Query
protected mixed	$table	Database table.	from Query
protected bool	$distinct	Select distinct?	from Query
protected array	$commonTableExpressions	Common table expressions.	from Query
protected array	$setOperations	Set operations.	from Query
protected array	$columns	Columns from which we are fetching data.	from Query
protected array	$wheres	WHERE clauses.	from Query
protected array	$joins	JOIN clauses.	from Query
protected array	$groupings	GROUP BY clauses.	from Query
protected array	$havings	HAVING clauses.	from Query
protected array	$orderings	ORDER BY clauses.	from Query
protected int\|null	$limit	Limit.	from Query
protected int\|null	$offset	Offset.	from Query
protected bool\|string\|null	$lock	Lock.	from Query
protected string\|null	$prefix	Prefix.	from Query
protected bool	$inSubqueryContext	Is the query in subquery context?	from Query
static protected Closure\|PaginationFactoryInterface	$paginationFactory	Pagination factory.	from Query
protected ORM	$model	Instance of the model to hydrate.
protected string	$modelClass	Class name of the model we're hydrating.
protected array	$relationCounters	Relation count subqueries.

Methods

__construct(Connection $connection, ORM $model)

Constructor.

__clone()

Create a fresh compiler instance and clone set operation queries when we clone the query.

from Query

reset()

Resets the query to its default state.

from Query

Query

newInstance()

Returns a new query builder instance.

from Query

$this

inSubqueryContext()

Sets the query to subquery context.

from Query

static

setPaginationFactory(Closure|PaginationFactoryInterface $factory)

Sets the pagination factory.

from Query

static PaginationFactoryInterface

getPaginationFactory()

Gets the pagination factory.

from Query

Connection

getConnection()

Returns the connection instance.

from Query

Compiler

getCompiler()

Returns query compiler instance.

from Query

array

getCommonTableExpressions()

Returns the common set operations.

from Query

array

getSetOperations()

Returns the set operations.

from Query

mixed

getTable()

Returns the database table.

from Query

bool

isDistinct()

Is it a distict select?

from Query

array

getColumns()

Returns the columns from which we are fetching data.

array

getWheres()

Returns WHERE clauses.

from Query

array

getJoins()

Returns JOIN clauses.

from Query

array

getGroupings()

Returns GROUP BY clauses.

from Query

array

getHavings()

Returns HAVING clauses.

from Query

array

getOrderings()

Returns ORDER BY clauses.

from Query

int|null

getLimit()

Returns the limit.

from Query

int|null

getOffset()

Returns the offset.

from Query

bool|string|null

getLock()

Returns the lock.

from Query

string|null

getPrefix()

Returns the prefix.

from Query

$this

forCompiler(string $compilerClass, Closure $query)

Executes the closure if the compiler is of the correct class.

from Query

$this

with(string $name, array $columns, Subquery $query)

Adds a common table expression.

from Query

$this

withRecursive(string $name, array $columns, Subquery $query)

Adds a recursive common table expression.

from Query

$this

setOperation(string $operation)

Adds a set operation.

from Query

$this

union()

Adds a UNION operation.

from Query

$this

unionAll()

Adds a UNION ALL operation.

from Query

$this

intersect()

Adds a INTERSECT operation.

from Query

$this

intersectAll()

Adds a INTERSECT ALL operation.

from Query

$this

except()

Adds a EXCEPT operation.

from Query

$this

exceptAll()

Adds a EXCEPT ALL operation.

from Query

$this

table(array|Raw|Subquery|string|null $table)

Sets table we want to query.

from Query

$this

from(array|Raw|Subquery|string|null $table)

Alias of Query::table().

from Query

$this

into(array|Raw|Subquery|string|null $table)

Alias of Query::table().

from Query

$this

select(array $columns)

Sets the columns we want to select.

from Query

$this

selectRaw(string $sql, array $parameters = [])

Sets the columns we want to select using raw SQL.

from Query

$this

distinct()

Select distinct?

from Query

$this

where(array|Closure|string $column, string|null $operator = null, mixed $value = null, string $separator = 'AND')

Adds a WHERE clause.

from Query

$this

whereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null, string $separator = 'AND')

Adds a raw WHERE clause.

from Query

$this

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

Adds a OR WHERE clause.

from Query

$this

orWhereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null)

Adds a raw OR WHERE clause.

from Query

$this

whereDate(string $column, string $operator, DateTimeInterface|string $date, string $separator = 'AND')

Adds a date comparison clause.

from Query

$this

orWhereDate(string $column, string $operator, DateTimeInterface|string $date)

Adds a date comparison clause.

from Query

$this

whereColumn(array|string $column1, string $operator, array|string $column2, string $separator = 'AND')

Adds a column comparison clause.

from Query

$this

orWhereColumn(array|string $column1, string $operator, array|string $column2)

Adds a column comparison clause.

from Query

$this

between(mixed $column, mixed $value1, mixed $value2, string $separator = 'AND', bool $not = false)

Adds a BETWEEN clause.

from Query

$this

orBetween(mixed $column, mixed $value1, mixed $value2)

Adds a OR BETWEEN clause.

from Query

$this

notBetween(mixed $column, mixed $value1, mixed $value2)

Adds a NOT BETWEEN clause.

from Query

$this

orNotBetween(mixed $column, mixed $value1, mixed $value2)

Adds a OR NOT BETWEEN clause.

from Query

$this

betweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2, string $separator = 'AND', bool $not = false)

Adds a date range clause.

from Query

orBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)

Adds a date range clause.

from Query

notBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)

Adds a date range clause.

from Query

orNotBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)

Adds a date range clause.

from Query

$this

in(mixed $column, array|Raw|Subquery $values, string $separator = 'AND', bool $not = false)

Adds a IN clause.

from Query

$this

orIn(mixed $column, array|Raw|Subquery $values)

Adds a OR IN clause.

from Query

$this

notIn(mixed $column, array|Raw|Subquery $values)

Adds a NOT IN clause.

from Query

$this

orNotIn(mixed $column, array|Raw|Subquery $values)

Adds a OR NOT IN clause.

from Query

$this

isNull(mixed $column, string $separator = 'AND', bool $not = false)

Adds a IS NULL clause.

from Query

$this

orIsNull(mixed $column)

Adds a OR IS NULL clause.

from Query

$this

isNotNull(mixed $column)

Adds a IS NOT NULL clause.

from Query

$this

orIsNotNull(mixed $column)

Adds a OR IS NOT NULL clause.

from Query

$this

exists(Subquery $query, string $separator = 'AND', bool $not = false)

Adds a EXISTS clause.

from Query

$this

orExists(Subquery $query)

Adds a OR EXISTS clause.

from Query

$this

notExists(Subquery $query)

Adds a NOT EXISTS clause.

from Query

$this

orNotExists(Subquery $query)

Adds a OR NOT EXISTS clause.

from Query

$this

join(string $table, Closure|string $column1 = null, string $operator = null, string $column2 = null, string $type = 'INNER', bool $raw = false)

Adds a JOIN clause.

$this

joinRaw(string $table, string $column1, string $operator, string $raw, string $type = 'INNER')

Adds a raw JOIN clause.

from Query

$this

leftJoin(string $table, Closure|string $column1 = null, string $operator = null, string $column2 = null)

Adds a LEFT OUTER JOIN clause.

from Query

$this

leftJoinRaw(string $table, string $column1, string $operator, string $raw)

Adds a raw LEFT OUTER JOIN clause.

from Query

$this

groupBy(array|string $columns)

Adds a GROUP BY clause.

from Query

$this

having(Raw|string $column, string $operator, mixed $value, string $separator = 'AND')

Adds a HAVING clause.

from Query

$this

havingRaw(string $raw, string $operator, mixed $value, string $separator = 'AND')

Adds a raw HAVING clause.

from Query

$this

orHaving(string $column, string $operator, mixed $value)

Adds a OR HAVING clause.

from Query

$this

orHavingRaw(string $raw, string $operator, mixed $value)

Adds a raw OR HAVING clause.

from Query

$this

orderBy(array|Raw|string $columns, string $order = 'ASC')

Adds a ORDER BY clause.

from Query

$this

orderByRaw(string $raw, array $parameters = [], string $order = 'ASC')

Adds a raw ORDER BY clause.

from Query

$this

ascending(array|string $columns)

Adds an ascending ORDER BY clause.

from Query

$this

ascendingRaw(string $raw, array $parameters = [])

Adds a raw ascending ORDER BY clause.

from Query

$this

descending(array|string $columns)

Adds a descending ORDER BY clause.

from Query

$this

descendingRaw(string $raw, array $parameters = [])

Adds a raw descending ORDER BY clause.

from Query

$this

clearOrderings()

Clears the ordering clauses.

from Query

$this

limit(int $limit)

Adds a LIMIT clause.

from Query

$this

offset(int $offset)

Adds a OFFSET clause.

from Query

$this

lock(bool|string $lock = true)

Enable lock.

from Query

$this

sharedLock()

Enable shared lock.

from Query

$this

prefix(string $prefix)

Adds a query prefix.

from Query

mixed

fetchFirst(mixed ...$fetchMode)

Executes a SELECT query and returns the first row of the result set or NULL if nothing is found.

from Query

mixed

first()

Returns a single record from the database.

ResultSet

createResultSet(array $results)

Creates a result set.

array|ResultSet

fetchAll(bool $returnResultSet, mixed ...$fetchMode)

Executes a SELECT query and returns an array containing all of the result set rows.

from Query

ResultSet

all()

Returns a result set from the database.

mixed

column(string $column = null)

Executes a SELECT query and returns the value of the chosen column of the first row of the result set.

from Query

array

columns(string $column = null)

Executes a SELECT query and returns an array containing the values of the indicated 0-indexed column.

from Query

array

pairs(string $key, string $value)

Executes a SELECT query and returns an array where the first column is used as keys and the second as values.

from Query

Generator

fetchYield(mixed ...$fetchMode)

Executes a SELECT query and returns a generator that lets you iterate over the results.

from Query

Generator

yield()

Returns a generator that lets you iterate over the results.

int

paginationCount()

Returns the number of records that the query will return.

from Query

ResultSet

paginate($itemsPerPage = null, array $options = [])

No description

batch(Closure $processor, int $batchSize = 1000, int $offsetStart = 0, int|null $offsetEnd = null)

Fetches data in batches and passes them to the processor closure.

mixed

aggregate(string $function, array|string $column)

Sets the selected column of the query to the chosen aggreate.

mixed

min(string $column)

Returns the minimum value for the chosen column.

from Query

mixed

max(string $column)

Returns the maximum value for the chosen column.

from Query

mixed

sum(string $column)

Returns sum of all the values in the chosen column.

from Query

mixed

avg(string $column)

Returns the average value for the chosen column.

from Query

int

count(string $column = '*')

Returns the number of rows.

from Query

int

countDistinct(array|string $column)

Returns the number of distinct values of the chosen column.

from Query

bool

insert(array $values = [])

Inserts data into the chosen table.

false|int

insertAndGetId(array $values, string $primaryKey = 'id')

Inserts data into the chosen table and returns the auto increment id.

from Query

int

update(array $values)

Updates data from the chosen table.

int

increment(string $column, int $increment = 1)

Increments column value.

int

decrement(string $column, int $decrement = 1)

Decrements column value.

int

delete()

Deletes data from the chosen table.

ORM

getModel()

Returns the model.

ORM|null

get(int|string $id, array $columns = [])

Returns a record using the value of its primary key.

$this

including(array|false|string $includes)

Adds relations to eager load.

$this

excluding(array|string|true $excludes)

Removes relations to eager load.

array

parseRelationCountName(string $relation)

Parses the count relation name and returns an array consisting of the relation name and the chosen alias.

$this

withCountOf(array|string $relations)

Adds subqueries that count the number of related records for the chosen relations.

ORM

hydrateModel(array $result)

Returns a hydrated model.

array

parseIncludes()

Parses includes.

loadIncludes(array $results)

Load includes.

array

hydrateModelsAndLoadIncludes(mixed $results)

Returns hydrated models.

$this

scope(string $scope, mixed ...$arguments)

Calls a scope method on the model.

Details

at line 65
`__construct(Connection $connection, ORM $model)`

Constructor.

Parameters

Connection	$connection	Database connection
ORM	$model	Model to hydrate

in Query at line 180
`__clone()`

Create a fresh compiler instance and clone set operation queries when we clone the query.

in Query at line 193
`protected reset()`

Resets the query to its default state.

in Query at line 208
`Query newInstance()`

Returns a new query builder instance.

Return Value

Query

in Query at line 218
`$this inSubqueryContext()`

Sets the query to subquery context.

Return Value

$this

in Query at line 230
`static setPaginationFactory(Closure|PaginationFactoryInterface $factory)`

Sets the pagination factory.

Parameters

Closure|PaginationFactoryInterface

$factory

Pagination factory

in Query at line 240
`static PaginationFactoryInterface getPaginationFactory()`

Gets the pagination factory.

Return Value

PaginationFactoryInterface

in Query at line 257
`Connection getConnection()`

Returns the connection instance.

Return Value

Connection

in Query at line 267
`Compiler getCompiler()`

Returns query compiler instance.

Return Value

Compiler

in Query at line 277
`array getCommonTableExpressions()`

Returns the common set operations.

Return Value

array

in Query at line 287
`array getSetOperations()`

Returns the set operations.

Return Value

array

in Query at line 297
`mixed getTable()`

Returns the database table.

Return Value

mixed

in Query at line 307
`bool isDistinct()`

Is it a distict select?

Return Value

bool

at line 79
`array getColumns()`

Returns the columns from which we are fetching data.

Return Value

array

in Query at line 327
`array getWheres()`

Returns WHERE clauses.

Return Value

array

in Query at line 337
`array getJoins()`

Returns JOIN clauses.

Return Value

array

in Query at line 347
`array getGroupings()`

Returns GROUP BY clauses.

Return Value

array

in Query at line 357
`array getHavings()`

Returns HAVING clauses.

Return Value

array

in Query at line 367
`array getOrderings()`

Returns ORDER BY clauses.

Return Value

array

in Query at line 377
`int|null getLimit()`

Returns the limit.

Return Value

int|null

in Query at line 387
`int|null getOffset()`

Returns the offset.

Return Value

int|null

in Query at line 397
`bool|string|null getLock()`

Returns the lock.

Return Value

bool|string|null

in Query at line 407
`string|null getPrefix()`

Returns the prefix.

Return Value

string|null

in Query at line 419
`$this forCompiler(string $compilerClass, Closure $query)`

Executes the closure if the compiler is of the correct class.

Parameters

string	$compilerClass	Compiler class name
Closure	$query	Closure

Return Value

$this

in Query at line 437
`$this with(string $name, array $columns, Subquery $query)`

Adds a common table expression.

Parameters

string	$name	Table name
array	$columns	Column names
Subquery	$query	Query

Return Value

$this

in Query at line 457
`$this withRecursive(string $name, array $columns, Subquery $query)`

Adds a recursive common table expression.

Parameters

string	$name	Table name
array	$columns	Column names
Subquery	$query	Query

Return Value

$this

in Query at line 470
`protected $this setOperation(string $operation)`

Adds a set operation.

Parameters

string

$operation

Operation

Return Value

$this

in Query at line 490
`$this union()`

Adds a UNION operation.

Return Value

$this

in Query at line 500
`$this unionAll()`

Adds a UNION ALL operation.

Return Value

$this

in Query at line 510
`$this intersect()`

Adds a INTERSECT operation.

Return Value

$this

in Query at line 520
`$this intersectAll()`

Adds a INTERSECT ALL operation.

Return Value

$this

in Query at line 530
`$this except()`

Adds a EXCEPT operation.

Return Value

$this

in Query at line 540
`$this exceptAll()`

Adds a EXCEPT ALL operation.

Return Value

$this

in Query at line 551
`$this table(array|Raw|Subquery|string|null $table)`

Sets table we want to query.

Parameters

array|Raw|Subquery|string|null

$table

Database table or subquery

Return Value

$this

in Query at line 564
`$this from(array|Raw|Subquery|string|null $table)`

Alias of Query::table().

Parameters

array|Raw|Subquery|string|null

$table

Database table or subquery

Return Value

$this

in Query at line 575
`$this into(array|Raw|Subquery|string|null $table)`

Alias of Query::table().

Parameters

array|Raw|Subquery|string|null

$table

Database table or subquery

Return Value

$this

in Query at line 586
`$this select(array $columns)`

Sets the columns we want to select.

Parameters

array

$columns

Array of columns we want to select from

Return Value

$this

in Query at line 600
`$this selectRaw(string $sql, array $parameters = [])`

Sets the columns we want to select using raw SQL.

Parameters

string	$sql	Raw sql
array	$parameters	Parameters

Return Value

$this

in Query at line 612
`$this distinct()`

Select distinct?

Return Value

$this

in Query at line 628
`$this where(array|Closure|string $column, string|null $operator = null, mixed $value = null, string $separator = 'AND')`

Adds a WHERE clause.

Parameters

array\|Closure\|string	$column	Column name, an array of column names or closure
string\|null	$operator	Operator
mixed	$value	Value
string	$separator	Clause separator

Return Value

$this

in Query at line 667
`$this whereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null, string $separator = 'AND')`

Adds a raw WHERE clause.

Parameters

array\|string	$column	Column name, an array of column names or raw SQL
array\|string\|null	$operator	Operator or parameters
string\|null	$raw	Raw SQL
string	$separator	Clause separator

Return Value

$this

in Query at line 692
`$this orWhere(array|Closure|string $column, string|null $operator = null, mixed $value = null)`

Adds a OR WHERE clause.

Parameters

array\|Closure\|string	$column	Column name, an array of column names or closure
string\|null	$operator	Operator
mixed	$value	Value

Return Value

$this

in Query at line 705
`$this orWhereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null)`

Adds a raw OR WHERE clause.

Parameters

array\|string	$column	Column name, and array of column names or raw SQL
array\|string\|null	$operator	Operator or parameters
string\|null	$raw	Raw SQL

Return Value

$this

in Query at line 719
`$this whereDate(string $column, string $operator, DateTimeInterface|string $date, string $separator = 'AND')`

Adds a date comparison clause.

Parameters

string	$column	Column name
string	$operator	Operator
DateTimeInterface\|string	$date	Date
string	$separator	Separator

Return Value

$this

in Query at line 742
`$this orWhereDate(string $column, string $operator, DateTimeInterface|string $date)`

Adds a date comparison clause.

Parameters

string	$column	Column name
string	$operator	Operator
DateTimeInterface\|string	$date	Date

Return Value

$this

in Query at line 756
`$this whereColumn(array|string $column1, string $operator, array|string $column2, string $separator = 'AND')`

Adds a column comparison clause.

Parameters

array\|string	$column1	Column name of array of column names
string	$operator	Operator
array\|string	$column2	Column name of array of column names
string	$separator	Separator

Return Value

$this

in Query at line 778
`$this orWhereColumn(array|string $column1, string $operator, array|string $column2)`

Adds a column comparison clause.

Parameters

array\|string	$column1	Column name of array of column names
string	$operator	Operator
array\|string	$column2	Column name of array of column names

Return Value

$this

in Query at line 793
`$this between(mixed $column, mixed $value1, mixed $value2, string $separator = 'AND', bool $not = false)`

Adds a BETWEEN clause.

Parameters

mixed	$column	Column name
mixed	$value1	First value
mixed	$value2	Second value
string	$separator	Clause separator
bool	$not	Not between?

Return Value

$this

in Query at line 816
`$this orBetween(mixed $column, mixed $value1, mixed $value2)`

Adds a OR BETWEEN clause.

Parameters

mixed	$column	Column name
mixed	$value1	First value
mixed	$value2	Second value

Return Value

$this

in Query at line 829
`$this notBetween(mixed $column, mixed $value1, mixed $value2)`

Adds a NOT BETWEEN clause.

Parameters

mixed	$column	Column name
mixed	$value1	First value
mixed	$value2	Second value

Return Value

$this

in Query at line 842
`$this orNotBetween(mixed $column, mixed $value1, mixed $value2)`

Adds a OR NOT BETWEEN clause.

Parameters

mixed	$column	Column name
mixed	$value1	First value
mixed	$value2	Second value

Return Value

$this

in Query at line 857
`$this betweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2, string $separator = 'AND', bool $not = false)`

Adds a date range clause.

Parameters

string	$column	Column name
DateTimeInterface\|string	$date1	First date
DateTimeInterface\|string	$date2	Second date
string	$separator	Separator
bool	$not	Not between?

Return Value

$this

in Query at line 879
`orBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

Adds a date range clause.

Parameters

string	$column	Column name
DateTimeInterface\|string	$date1	First date
DateTimeInterface\|string	$date2	Second date

in Query at line 891
`notBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

Adds a date range clause.

Parameters

string	$column	Column name
DateTimeInterface\|string	$date1	First date
DateTimeInterface\|string	$date2	Second date

in Query at line 903
`orNotBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

Adds a date range clause.

Parameters

string	$column	Column name
DateTimeInterface\|string	$date1	First date
DateTimeInterface\|string	$date2	Second date

in Query at line 917
`$this in(mixed $column, array|Raw|Subquery $values, string $separator = 'AND', bool $not = false)`

Adds a IN clause.

Parameters

mixed	$column	Column name
array\|Raw\|Subquery	$values	Array of values or Subquery
string	$separator	Clause separator
bool	$not	Not in?

Return Value

$this

in Query at line 938
`$this orIn(mixed $column, array|Raw|Subquery $values)`

Adds a OR IN clause.

Parameters

mixed	$column	Column name
array\|Raw\|Subquery	$values	Array of values or Subquery

Return Value

$this

in Query at line 950
`$this notIn(mixed $column, array|Raw|Subquery $values)`

Adds a NOT IN clause.

Parameters

mixed	$column	Column name
array\|Raw\|Subquery	$values	Array of values or Subquery

Return Value

$this

in Query at line 962
`$this orNotIn(mixed $column, array|Raw|Subquery $values)`

Adds a OR NOT IN clause.

Parameters

mixed	$column	Column name
array\|Raw\|Subquery	$values	Array of values or Subquery

Return Value

$this

in Query at line 975
`$this isNull(mixed $column, string $separator = 'AND', bool $not = false)`

Adds a IS NULL clause.

Parameters

mixed	$column	Column name
string	$separator	Clause separator
bool	$not	Not in?

Return Value

$this

in Query at line 994
`$this orIsNull(mixed $column)`

Adds a OR IS NULL clause.

Parameters

mixed

$column

Column name

Return Value

$this

in Query at line 1005
`$this isNotNull(mixed $column)`

Adds a IS NOT NULL clause.

Parameters

mixed

$column

Column name

Return Value

$this

in Query at line 1016
`$this orIsNotNull(mixed $column)`

Adds a OR IS NOT NULL clause.

Parameters

mixed

$column

Column name

Return Value

$this

in Query at line 1029
`$this exists(Subquery $query, string $separator = 'AND', bool $not = false)`

Adds a EXISTS clause.

Parameters

Subquery	$query	Subquery
string	$separator	Clause separator
bool	$not	Not exists?

Return Value

$this

in Query at line 1048
`$this orExists(Subquery $query)`

Adds a OR EXISTS clause.

Parameters

Subquery

$query

Subquery

Return Value

$this

in Query at line 1059
`$this notExists(Subquery $query)`

Adds a NOT EXISTS clause.

Parameters

Subquery

$query

Subquery

Return Value

$this

in Query at line 1070
`$this orNotExists(Subquery $query)`

Adds a OR NOT EXISTS clause.

Parameters

Subquery

$query

Subquery

Return Value

$this

at line 102
`$this join(string $table, Closure|string $column1 = null, string $operator = null, string $column2 = null, string $type = 'INNER', bool $raw = false)`

Adds a JOIN clause.

Parameters

string	$table	Table name
Closure\|string	$column1	Column name or closure
string	$operator	Operator
string	$column2	Column name
string	$type	Join type
bool	$raw	Raw join?

Return Value

$this

in Query at line 1121
`$this joinRaw(string $table, string $column1, string $operator, string $raw, string $type = 'INNER')`

Adds a raw JOIN clause.

Parameters

string	$table	Table name
string	$column1	Column name or closure
string	$operator	Operator
string	$raw	Raw SQL
string	$type	Join type

Return Value

$this

in Query at line 1135
`$this leftJoin(string $table, Closure|string $column1 = null, string $operator = null, string $column2 = null)`

Adds a LEFT OUTER JOIN clause.

Parameters

string	$table	Table name
Closure\|string	$column1	Column name or closure
string	$operator	Operator
string	$column2	Column name

Return Value

$this

in Query at line 1149
`$this leftJoinRaw(string $table, string $column1, string $operator, string $raw)`

Adds a raw LEFT OUTER JOIN clause.

Parameters

string	$table	Table name
string	$column1	Column name or closure
string	$operator	Operator
string	$raw	Raw SQL

Return Value

$this

in Query at line 1160
`$this groupBy(array|string $columns)`

Adds a GROUP BY clause.

Parameters

array|string

$columns

Column name or array of column names

Return Value

$this

in Query at line 1176
`$this having(Raw|string $column, string $operator, mixed $value, string $separator = 'AND')`

Adds a HAVING clause.

Parameters

Raw\|string	$column	Column name
string	$operator	Operator
mixed	$value	Value
string	$separator	Clause separator

Return Value

$this

in Query at line 1198
`$this havingRaw(string $raw, string $operator, mixed $value, string $separator = 'AND')`

Adds a raw HAVING clause.

Parameters

string	$raw	Raw SQL
string	$operator	Operator
mixed	$value	Value
string	$separator	Clause separator

Return Value

$this

in Query at line 1211
`$this orHaving(string $column, string $operator, mixed $value)`

Adds a OR HAVING clause.

Parameters

string	$column	Column name
string	$operator	Operator
mixed	$value	Value

Return Value

$this

in Query at line 1224
`$this orHavingRaw(string $raw, string $operator, mixed $value)`

Adds a raw OR HAVING clause.

Parameters

string	$raw	Raw SQL
string	$operator	Operator
mixed	$value	Value

Return Value

$this

in Query at line 1236
`$this orderBy(array|Raw|string $columns, string $order = 'ASC')`

Adds a ORDER BY clause.

Parameters

array\|Raw\|string	$columns	Column name or array of column names
string	$order	Sorting order

Return Value

$this

in Query at line 1255
`$this orderByRaw(string $raw, array $parameters = [], string $order = 'ASC')`

Adds a raw ORDER BY clause.

Parameters

string	$raw	Raw SQL
array	$parameters	Parameters
string	$order	Sorting order

Return Value

$this

in Query at line 1266
`$this ascending(array|string $columns)`

Adds an ascending ORDER BY clause.

Parameters

array|string

$columns

Column name or array of column names

Return Value

$this

in Query at line 1278
`$this ascendingRaw(string $raw, array $parameters = [])`

Adds a raw ascending ORDER BY clause.

Parameters

string	$raw	Raw SQL
array	$parameters	Parameters

Return Value

$this

in Query at line 1289
`$this descending(array|string $columns)`

Adds a descending ORDER BY clause.

Parameters

array|string

$columns

Column name or array of column names

Return Value

$this

in Query at line 1301
`$this descendingRaw(string $raw, array $parameters = [])`

Adds a raw descending ORDER BY clause.

Parameters

string	$raw	Raw SQL
array	$parameters	Parameters

Return Value

$this

in Query at line 1311
`$this clearOrderings()`

Clears the ordering clauses.

Return Value

$this

in Query at line 1324
`$this limit(int $limit)`

Adds a LIMIT clause.

Parameters

int

$limit

Limit

Return Value

$this

in Query at line 1337
`$this offset(int $offset)`

Adds a OFFSET clause.

Parameters

int

$offset

Offset

Return Value

$this

in Query at line 1350
`$this lock(bool|string $lock = true)`

Enable lock.

Parameters

bool|string

$lock

TRUE for exclusive, FALSE for shared and string for custom

Return Value

$this

in Query at line 1362
`$this sharedLock()`

Enable shared lock.

Return Value

$this

in Query at line 1373
`$this prefix(string $prefix)`

Adds a query prefix.

Parameters

string

$prefix

Prefix

Return Value

$this

in Query at line 1386
`protected mixed fetchFirst(mixed ...$fetchMode)`

Executes a SELECT query and returns the first row of the result set or NULL if nothing is found.

Parameters

mixed

...$fetchMode

Fetch mode

Return Value

mixed

at line 477
`mixed first()`

Returns a single record from the database.

Return Value

mixed

at line 495
`protected ResultSet createResultSet(array $results)`

Creates a result set.

Parameters

array

$results

Results

Return Value

ResultSet

in Query at line 1421
`protected array|ResultSet fetchAll(bool $returnResultSet, mixed ...$fetchMode)`

Executes a SELECT query and returns an array containing all of the result set rows.

Parameters

bool	$returnResultSet	Return result set?
mixed	...$fetchMode	Fetch mode

Return Value

array|ResultSet

at line 505
`ResultSet all()`

Returns a result set from the database.

Return Value

ResultSet

in Query at line 1446
`mixed column(string $column = null)`

Executes a SELECT query and returns the value of the chosen column of the first row of the result set.

Parameters

string

$column

The column to select

Return Value

mixed

in Query at line 1464
`array columns(string $column = null)`

Executes a SELECT query and returns an array containing the values of the indicated 0-indexed column.

Parameters

string

$column

The column to select

Return Value

array

in Query at line 1483
`array pairs(string $key, string $value)`

Executes a SELECT query and returns an array where the first column is used as keys and the second as values.

Parameters

string	$key	The column to use as keys
string	$value	The column to use as values

Return Value

array

in Query at line 1498
`protected Generator fetchYield(mixed ...$fetchMode)`

Executes a SELECT query and returns a generator that lets you iterate over the results.

Parameters

mixed

...$fetchMode

Fetch mode

Return Value

Generator

at line 522
`Generator yield()`

Returns a generator that lets you iterate over the results.

Return Value

Generator

in Query at line 1520
`protected int paginationCount()`

Returns the number of records that the query will return.

Return Value

int

at line 36
`ResultSet paginate($itemsPerPage = null, array $options = [])`

Parameters

	$itemsPerPage
array	$options

Return Value

ResultSet

at line 533
`batch(Closure $processor, int $batchSize = 1000, int $offsetStart = 0, int|null $offsetEnd = null)`

Fetches data in batches and passes them to the processor closure.

Parameters

Closure	$processor	Closure that processes the results
int	$batchSize	Batch size
int	$offsetStart	Offset start
int\|null	$offsetEnd	Offset end

at line 546
`protected mixed aggregate(string $function, array|string $column)`

Sets the selected column of the query to the chosen aggreate.

Executes the query and returns the result if not in subquery context.

Parameters

string	$function	Aggregate function
array\|string	$column	Column name or array of column names

Return Value

mixed

in Query at line 1629
`mixed min(string $column)`

Returns the minimum value for the chosen column.

Parameters

string

$column

Column name

Return Value

mixed

in Query at line 1640
`mixed max(string $column)`

Returns the maximum value for the chosen column.

Parameters

string

$column

Column name

Return Value

mixed

in Query at line 1651
`mixed sum(string $column)`

Returns sum of all the values in the chosen column.

Parameters

string

$column

Column name

Return Value

mixed

in Query at line 1662
`mixed avg(string $column)`

Returns the average value for the chosen column.

Parameters

string

$column

Column name

Return Value

mixed

in Query at line 1673
`int count(string $column = '*')`

Returns the number of rows.

Parameters

string

$column

Column name

Return Value

int

in Query at line 1684
`int countDistinct(array|string $column)`

Returns the number of distinct values of the chosen column.

Parameters

array|string

$column

Column name or array of column names

Return Value

int

at line 115
`bool insert(array $values = [])`

Inserts data into the chosen table.

Parameters

array

$values

Associative array of column values

Return Value

bool

in Query at line 1709
`false|int insertAndGetId(array $values, string $primaryKey = 'id')`

Inserts data into the chosen table and returns the auto increment id.

Parameters

array	$values	Associative array of column values
string	$primaryKey	Primary key

Return Value

false|int

at line 143
`int update(array $values)`

Updates data from the chosen table.

Parameters

array

$values

Associative array of column values

Return Value

int

at line 171
`int increment(string $column, int $increment = 1)`

Increments column value.

Parameters

string	$column	Column name
int	$increment	Increment value

Return Value

int

at line 193
`int decrement(string $column, int $decrement = 1)`

Decrements column value.

Parameters

string	$column	Column name
int	$decrement	Decrement value

Return Value

int

at line 215
`int delete()`

Deletes data from the chosen table.

Return Value

int

at line 94
`ORM getModel()`

Returns the model.

Return Value

ORM

at line 243
`ORM|null get(int|string $id, array $columns = [])`

Returns a record using the value of its primary key.

Parameters

int\|string	$id	Primary key
array	$columns	Columns to select

Return Value

ORM|null

at line 259
`$this including(array|false|string $includes)`

Adds relations to eager load.

Parameters

array|false|string

$includes

Relation or array of relations to eager load

Return Value

$this

at line 301
`$this excluding(array|string|true $excludes)`

Removes relations to eager load.

Parameters

array|string|true

$excludes

Relation or array of relations to exclude from eager loading

Return Value

$this

at line 336
`protected array parseRelationCountName(string $relation)`

Parses the count relation name and returns an array consisting of the relation name and the chosen alias.

Parameters

string

$relation

Relation name

Return Value

array

at line 354
`$this withCountOf(array|string $relations)`

Adds subqueries that count the number of related records for the chosen relations.

Parameters

array|string

$relations

Relation or array of relations to count

Return Value

$this

at line 391
`protected ORM hydrateModel(array $result)`

Returns a hydrated model.

Parameters

array

$result

Database result

Return Value

ORM

at line 403
`protected array parseIncludes()`

Parses includes.

Return Value

array

at line 440
`protected loadIncludes(array $results)`

Load includes.

Parameters

array

$results

Loaded records

at line 458
`protected array hydrateModelsAndLoadIncludes(mixed $results)`

Returns hydrated models.

Parameters

mixed

$results

Database results

Return Value

array

at line 564
`$this scope(string $scope, mixed ...$arguments)`

Calls a scope method on the model.

Parameters

string	$scope	Scope
mixed	...$arguments	Arguments

Return Value

$this

Query

Properties

Methods

Details

at line 65 __construct(Connection $connection, ORM $model)

Parameters

in Query at line 180 __clone()

in Query at line 193 protected reset()

in Query at line 208 Query newInstance()

Return Value

in Query at line 218 $this inSubqueryContext()

Return Value

in Query at line 230 static setPaginationFactory(Closure|PaginationFactoryInterface $factory)

Parameters

in Query at line 240 static PaginationFactoryInterface getPaginationFactory()

Return Value

in Query at line 257 Connection getConnection()

Return Value

in Query at line 267 Compiler getCompiler()

Return Value

in Query at line 277 array getCommonTableExpressions()

Return Value

in Query at line 287 array getSetOperations()

Return Value

in Query at line 297 mixed getTable()

Return Value

in Query at line 307 bool isDistinct()

Return Value

at line 79 array getColumns()

Return Value

in Query at line 327 array getWheres()

Return Value

in Query at line 337 array getJoins()

Return Value

in Query at line 347 array getGroupings()

Return Value

in Query at line 357 array getHavings()

Return Value

in Query at line 367 array getOrderings()

Return Value

in Query at line 377 int|null getLimit()

Return Value

in Query at line 387 int|null getOffset()

Return Value

in Query at line 397 bool|string|null getLock()

Return Value

in Query at line 407 string|null getPrefix()

Return Value

in Query at line 419 $this forCompiler(string $compilerClass, Closure $query)

Parameters

Return Value

in Query at line 437 $this with(string $name, array $columns, Subquery $query)

Parameters

Return Value

in Query at line 457 $this withRecursive(string $name, array $columns, Subquery $query)

Parameters

Return Value

in Query at line 470 protected $this setOperation(string $operation)

Parameters

Return Value

in Query at line 490 $this union()

Return Value

in Query at line 500 $this unionAll()

Return Value

in Query at line 510 $this intersect()

Return Value

in Query at line 520 $this intersectAll()

Return Value

in Query at line 530 $this except()

Return Value

in Query at line 540 $this exceptAll()

Return Value

in Query at line 551 $this table(array|Raw|Subquery|string|null $table)

Parameters

Return Value

in Query at line 564 $this from(array|Raw|Subquery|string|null $table)

Parameters

Return Value

in Query at line 575 $this into(array|Raw|Subquery|string|null $table)

Parameters

at line 65
`__construct(Connection $connection, ORM $model)`

in Query at line 180
`__clone()`

in Query at line 193
`protected reset()`

in Query at line 208
`Query newInstance()`

in Query at line 218
`$this inSubqueryContext()`

in Query at line 230
`static setPaginationFactory(Closure|PaginationFactoryInterface $factory)`

in Query at line 240
`static PaginationFactoryInterface getPaginationFactory()`

in Query at line 257
`Connection getConnection()`

in Query at line 267
`Compiler getCompiler()`

in Query at line 277
`array getCommonTableExpressions()`

in Query at line 287
`array getSetOperations()`

in Query at line 297
`mixed getTable()`

in Query at line 307
`bool isDistinct()`

at line 79
`array getColumns()`

in Query at line 327
`array getWheres()`

in Query at line 337
`array getJoins()`

in Query at line 347
`array getGroupings()`

in Query at line 357
`array getHavings()`

in Query at line 367
`array getOrderings()`

in Query at line 377
`int|null getLimit()`

in Query at line 387
`int|null getOffset()`

in Query at line 397
`bool|string|null getLock()`

in Query at line 407
`string|null getPrefix()`

in Query at line 419
`$this forCompiler(string $compilerClass, Closure $query)`

in Query at line 437
`$this with(string $name, array $columns, Subquery $query)`

in Query at line 457
`$this withRecursive(string $name, array $columns, Subquery $query)`

in Query at line 470
`protected $this setOperation(string $operation)`

in Query at line 490
`$this union()`

in Query at line 500
`$this unionAll()`

in Query at line 510
`$this intersect()`

in Query at line 520
`$this intersectAll()`

in Query at line 530
`$this except()`

in Query at line 540
`$this exceptAll()`

in Query at line 551
`$this table(array|Raw|Subquery|string|null $table)`

in Query at line 564
`$this from(array|Raw|Subquery|string|null $table)`

in Query at line 575
`$this into(array|Raw|Subquery|string|null $table)`

in Query at line 586
`$this select(array $columns)`

in Query at line 600
`$this selectRaw(string $sql, array $parameters = [])`

in Query at line 612
`$this distinct()`

in Query at line 628
`$this where(array|Closure|string $column, string|null $operator = null, mixed $value = null, string $separator = 'AND')`

in Query at line 667
`$this whereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null, string $separator = 'AND')`

in Query at line 692
`$this orWhere(array|Closure|string $column, string|null $operator = null, mixed $value = null)`

in Query at line 705
`$this orWhereRaw(array|string $column, array|string|null $operator = null, string|null $raw = null)`

in Query at line 719
`$this whereDate(string $column, string $operator, DateTimeInterface|string $date, string $separator = 'AND')`

in Query at line 742
`$this orWhereDate(string $column, string $operator, DateTimeInterface|string $date)`

in Query at line 756
`$this whereColumn(array|string $column1, string $operator, array|string $column2, string $separator = 'AND')`

in Query at line 778
`$this orWhereColumn(array|string $column1, string $operator, array|string $column2)`

in Query at line 793
`$this between(mixed $column, mixed $value1, mixed $value2, string $separator = 'AND', bool $not = false)`

in Query at line 816
`$this orBetween(mixed $column, mixed $value1, mixed $value2)`

in Query at line 829
`$this notBetween(mixed $column, mixed $value1, mixed $value2)`

in Query at line 842
`$this orNotBetween(mixed $column, mixed $value1, mixed $value2)`

in Query at line 857
`$this betweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2, string $separator = 'AND', bool $not = false)`

in Query at line 879
`orBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

in Query at line 891
`notBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

in Query at line 903
`orNotBetweenDate(string $column, DateTimeInterface|string $date1, DateTimeInterface|string $date2)`

in Query at line 917
`$this in(mixed $column, array|Raw|Subquery $values, string $separator = 'AND', bool $not = false)`

in Query at line 938
`$this orIn(mixed $column, array|Raw|Subquery $values)`

in Query at line 950
`$this notIn(mixed $column, array|Raw|Subquery $values)`

in Query at line 962
`$this orNotIn(mixed $column, array|Raw|Subquery $values)`

in Query at line 975
`$this isNull(mixed $column, string $separator = 'AND', bool $not = false)`

in Query at line 994
`$this orIsNull(mixed $column)`