Query
class Query
Query builder.
Properties
protected Connection | $connection | Database connection. | |
protected HelperInterface | $helper | Query helper. | |
protected Compiler | $compiler | Query compiler. | |
protected mixed | $table | Database table. | |
protected bool | $distinct | Select distinct? | |
protected array | $setOperations | Set operations. | |
protected array | $columns | Columns from which we are fetching data. | |
protected array | $wheres | WHERE clauses. | |
protected array | $joins | JOIN clauses. | |
protected array | $groupings | GROUP BY clauses. | |
protected array | $havings | HAVING clauses. | |
protected array | $orderings | ORDER BY clauses. | |
protected int|null | $limit | Limit. | |
protected int|null | $offset | Offset. | |
protected bool|string|null | $lock | Lock. | |
protected string|null | $prefix | Prefix. | |
protected bool | $inSubqueryContext | Is the query in subquery context? | |
static protected PaginationFactoryInterface | $paginationFactory | Pagination factory. |
Methods
Create a fresh compiler instance when we clone the query.
Returns a new query builder instance.
Sets the query to subquery context.
Gets the pagination factory.
Returns the connection instance.
Returns query compiler instance.
Returns the set operations.
Returns the database table.
Is it a distict select?
Returns the columns from which we are fetching data.
Returns WHERE clauses.
Returns JOIN clauses.
Returns GROUP BY clauses.
Returns HAVING clauses.
Returns ORDER BY clauses.
Returns the limit.
Returns the offset.
Returns the lock.
Returns the prefix.
Adds a raw WHERE clause.
Adds a raw OR WHERE clause.
Adds a BETWEEN clause.
Adds a NOT BETWEEN clause.
Adds a OR NOT BETWEEN clause.
Adds a OR IS NOT NULL clause.
Adds a raw JOIN clause.
Adds a raw LEFT OUTER JOIN clause.
Adds a HAVING clause.
Adds a raw HAVING clause.
Adds a raw OR HAVING clause.
Adds a raw ORDER BY clause.
Adds a raw ascending ORDER BY clause.
Adds a descending ORDER BY clause.
Adds a raw descending ORDER BY clause.
Clears the ordering clauses.
Enable shared lock.
Executes a SELECT query and returns the value of the chosen column of the first row of the result set.
Executes a SELECT query and returns an array containing the values of the indicated 0-indexed column.
Executes a SELECT query and returns an array where the first column is used as keys and the second as values.
Executes a SELECT query and returns the first row of the result set.
Executes a SELECT query and returns the first row of the result set.
Creates a result set.
Executes a SELECT query and returns an array containing all of the result set rows.
Executes a SELECT query and returns a generator that lets you iterate over the results.
Executes a SELECT query and returns a generator that lets you iterate over the results.
Returns the number of records that the query will return.
Paginates the results using a pagination instance.
Sets the selected column of the query to the chosen aggreate.
Returns the minimum value for the chosen column.
Returns the maximum value for the chosen column.
Returns sum of all the values in the chosen column.
Returns the average value for the chosen column.
Returns the number of rows.
Returns the number of distinct values of the chosen column.
Inserts data into the chosen table.
Inserts data into the chosen table and returns the auto increment id.
Updates data from the chosen table.
Increments column value.
Decrements column value.
Deletes data from the chosen table.
Details
at line 157
__construct(Connection $connection)
Constructor.
at line 169
__clone()
Create a fresh compiler instance when we clone the query.
at line 179
Query
newInstance()
Returns a new query builder instance.
at line 189
Query
inSubqueryContext()
Sets the query to subquery context.
at line 201
static
setPaginationFactory(PaginationFactoryInterface|Closure $factory)
Sets the pagination factory.
at line 211
static PaginationFactoryInterface
getPaginationFactory()
Gets the pagination factory.
at line 228
Connection
getConnection()
Returns the connection instance.
at line 238
Compiler
getCompiler()
Returns query compiler instance.
at line 248
array
getSetOperations()
Returns the set operations.
at line 258
mixed
getTable()
Returns the database table.
at line 268
bool
isDistinct()
Is it a distict select?
at line 278
array
getColumns()
Returns the columns from which we are fetching data.
at line 288
array
getWheres()
Returns WHERE clauses.
at line 298
array
getJoins()
Returns JOIN clauses.
at line 308
array
getGroupings()
Returns GROUP BY clauses.
at line 318
array
getHavings()
Returns HAVING clauses.
at line 328
array
getOrderings()
Returns ORDER BY clauses.
at line 338
int|null
getLimit()
Returns the limit.
at line 348
int|null
getOffset()
Returns the offset.
at line 358
bool|string|null
getLock()
Returns the lock.
at line 368
string|null
getPrefix()
Returns the prefix.
at line 380
protected Query
setOperation(Closure|Query|Subquery $query, string $operation)
Adds a set operation.
at line 508
Query
select(array $columns)
Sets the columns we want to select.
at line 520
Query
distinct()
Select distinct?
at line 536
Query
where(string|array|Closure $column, string|null $operator = null, mixed $value = null, string $separator = 'AND')
Adds a WHERE clause.
at line 575
Query
whereRaw(string|array $column, string|array|null $operator = null, string|null $raw = null, string $separator = 'AND')
Adds a raw WHERE clause.
at line 600
Query
orWhere(string|array|Closure $column, string|null $operator = null, mixed $value = null)
Adds a OR WHERE clause.
at line 613
Query
orWhereRaw(string|array $column, string|array|null $operator = null, string|null $raw = null)
Adds a raw OR WHERE clause.
at line 628
Query
between(string $column, mixed $value1, mixed $value2, string $separator = 'AND', bool $not = false)
Adds a BETWEEN clause.
at line 651
Query
orBetween(string $column, mixed $value1, mixed $value2)
Adds a OR BETWEEN clause.
at line 664
Query
notBetween(string $column, mixed $value1, mixed $value2)
Adds a NOT BETWEEN clause.
at line 677
Query
orNotBetween(string $column, mixed $value1, mixed $value2)
Adds a OR NOT BETWEEN clause.
at line 691
Query
in(string $column, array|Raw|Closure|Subquery $values, string $separator = 'AND', bool $not = false)
Adds a IN clause.
at line 721
Query
orIn(string $column, mixed $values)
Adds a OR IN clause.
at line 733
Query
notIn(string $column, mixed $values)
Adds a NOT IN clause.
at line 745
Query
orNotIn(string $column, mixed $values)
Adds a OR NOT IN clause.
at line 758
Query
isNull(mixed $column, string $separator = 'AND', bool $not = false)
Adds a IS NULL clause.
at line 777
Query
orIsNull(mixed $column)
Adds a OR IS NULL clause.
at line 788
Query
isNotNull(mixed $column)
Adds a IS NOT NULL clause.
at line 799
Query
orIsNotNull(mixed $column)
Adds a OR IS NOT NULL clause.
at line 812
Query
exists(Closure|Subquery $query, string $separator = 'AND', bool $not = false)
Adds a EXISTS clause.
at line 874
Query
join(string $table, string|Closure $column1 = null, string $operator = null, string $column2 = null, string $type = 'INNER', bool $raw = false)
Adds a JOIN clause.
at line 909
Query
joinRaw(string $table, string $column1, string $operator, string $raw, string $type = 'INNER')
Adds a raw JOIN clause.
at line 923
Query
leftJoin(string $table, string|Closure $column1 = null, string $operator = null, string $column2 = null)
Adds a LEFT OUTER JOIN clause.
at line 937
Query
leftJoinRaw(string $table, string $column1, string $operator, string $raw)
Adds a raw LEFT OUTER JOIN clause.
at line 948
Query
groupBy(string|array $columns)
Adds a GROUP BY clause.
at line 964
Query
having(string $column, string $operator, mixed $value, string $separator = 'AND')
Adds a HAVING clause.
at line 986
Query
havingRaw(string $raw, string $operator, mixed $value, string $separator = 'AND')
Adds a raw HAVING clause.
at line 999
Query
orHaving(string $column, string $operator, mixed $value)
Adds a OR HAVING clause.
at line 1012
Query
orHavingRaw(string $raw, string $operator, mixed $value)
Adds a raw OR HAVING clause.
at line 1024
Query
orderBy(string|array $columns, string $order = 'ASC')
Adds a ORDER BY clause.
at line 1042
Query
orderByRaw(string $raw, string $order = 'ASC')
Adds a raw ORDER BY clause.
at line 1053
Query
ascending(string|array $columns)
Adds an ascending ORDER BY clause.
at line 1064
Query
ascendingRaw(string $raw)
Adds a raw ascending ORDER BY clause.
at line 1075
Query
descending(string|array $columns)
Adds a descending ORDER BY clause.
at line 1086
Query
descendingRaw(string $raw)
Adds a raw descending ORDER BY clause.
at line 1096
Query
clearOrderings()
Clears the ordering clauses.
at line 1109
Query
limit(int $limit)
Adds a LIMIT clause.
at line 1122
Query
offset(int $offset)
Adds a OFFSET clause.
at line 1135
Query
lock(bool|string $lock = true)
Enable lock.
at line 1147
Query
sharedLock()
Enable shared lock.
at line 1158
Query
prefix(string $prefix)
Adds a query prefix.
at line 1171
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.
at line 1189
array
columns(string $column = null)
Executes a SELECT query and returns an array containing the values of the indicated 0-indexed column.
at line 1208
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.
at line 1223
protected mixed
fetchFirst(mixed ...$fetchMode)
Executes a SELECT query and returns the first row of the result set.
at line 1235
mixed
first()
Executes a SELECT query and returns the first row of the result set.
at line 1246
protected ResultSet
createResultSet(array $results)
Creates a result set.
at line 1258
protected array|ResultSet
fetchAll(bool $returnResultSet, mixed ...$fetchMode)
Executes a SELECT query and returns an array containing all of the result set rows.
at line 1272
ResultSet
all()
Executes a SELECT query and returns an array containing all of the result set rows.
at line 1283
protected Generator
fetchYield(mixed ...$fetchMode)
Executes a SELECT query and returns a generator that lets you iterate over the results.
at line 1295
Generator
yield()
Executes a SELECT query and returns a generator that lets you iterate over the results.
at line 1305
protected int
paginationCount()
Returns the number of records that the query will return.
at line 1324
ResultSet
paginate(int|null $itemsPerPage = null, array $options = [])
Paginates the results using a pagination instance.
at line 1352
batch(Closure $processor, int $batchSize = 1000, int $offsetStart = 0, int $offsetEnd = null)
Fetches data in batches and passes them to the processor closure.
at line 1393
protected mixed
aggregate(string $function, string|array $column)
Sets the selected column of the query to the chosen aggreate.
Executes the query and returns the result if not in subquery context.
at line 1411
int
min(string $column)
Returns the minimum value for the chosen column.
at line 1422
int
max(string $column)
Returns the maximum value for the chosen column.
at line 1433
int
sum(string $column)
Returns sum of all the values in the chosen column.
at line 1444
float
avg(string $column)
Returns the average value for the chosen column.
at line 1455
int
count(string $column = '*')
Returns the number of rows.
at line 1466
int
countDistinct(string|array $column)
Returns the number of distinct values of the chosen column.
at line 1477
bool
insert(array $values = [])
Inserts data into the chosen table.
at line 1491
int|bool
insertAndGetId(array $values, string $primaryKey = 'id')
Inserts data into the chosen table and returns the auto increment id.
at line 1502
int
update(array $values)
Updates data from the chosen table.
at line 1516
int
increment(string $column, int $increment = 1)
Increments column value.
at line 1528
int
decrement(string $column, int $decrement = 1)
Decrements column value.
at line 1538
int
delete()
Deletes data from the chosen table.