1. Documentation
  2. API
  3. Library
  4. Database
  5. QueryBuilder

October\Rain\Database\QueryBuilder

Overview

QueryBuilder restores some features that were removed from base, it also adds some new ones

Extends
  • Illuminate\Database\Query\Builder
Implements
  • Illuminate\Contracts\Database\Query\Builder

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

  • $connection - The database connection instance. (defined in Illuminate\Database\Query\Builder)
  • $grammar - The database query grammar instance. (defined in Illuminate\Database\Query\Builder)
  • $processor - The database query post processor instance. (defined in Illuminate\Database\Query\Builder)
  • $bindings - The current query value bindings. (defined in Illuminate\Database\Query\Builder)
  • $aggregate - An aggregate function and column to be run. (defined in Illuminate\Database\Query\Builder)
  • $columns - The columns that should be returned. (defined in Illuminate\Database\Query\Builder)
  • $distinct - Indicates if the query returns distinct results. (defined in Illuminate\Database\Query\Builder)
  • $from - The table which the query is targeting. (defined in Illuminate\Database\Query\Builder)
  • $indexHint - The index hint for the query. (defined in Illuminate\Database\Query\Builder)
  • $joins - The table joins for the query. (defined in Illuminate\Database\Query\Builder)
  • $wheres - The where constraints for the query. (defined in Illuminate\Database\Query\Builder)
  • $groups - The groupings for the query. (defined in Illuminate\Database\Query\Builder)
  • $havings - The having constraints for the query. (defined in Illuminate\Database\Query\Builder)
  • $orders - The orderings for the query. (defined in Illuminate\Database\Query\Builder)
  • $limit - The maximum number of records to return. (defined in Illuminate\Database\Query\Builder)
  • $offset - The number of records to skip. (defined in Illuminate\Database\Query\Builder)
  • $unions - The query union statements. (defined in Illuminate\Database\Query\Builder)
  • $unionLimit - The maximum number of union records to return. (defined in Illuminate\Database\Query\Builder)
  • $unionOffset - The number of union records to skip. (defined in Illuminate\Database\Query\Builder)
  • $unionOrders - The orderings for the union query. (defined in Illuminate\Database\Query\Builder)
  • $lock - Indicates whether row locking is being used. (defined in Illuminate\Database\Query\Builder)
  • $beforeQueryCallbacks - The callbacks that should be invoked before the query is executed. (defined in Illuminate\Database\Query\Builder)
  • $operators - All of the available clause operators. (defined in Illuminate\Database\Query\Builder)
  • $bitwiseOperators - All of the available bitwise operators. (defined in Illuminate\Database\Query\Builder)
  • $useWritePdo - Whether to use write pdo for the select. (defined in Illuminate\Database\Query\Builder)

Protected Properties

protected string $cacheKey

cacheKey is the key that should be used when caching the query

protected int $cacheMinutes

cacheMinutes is the number of minutes to cache the query

protected array $cacheTags

cacheTags is the tags for the query cache

Show inherited protected properties

Inherited Protected Properties

  • $macros - The registered string macros. (defined in Illuminate\Database\Query\Builder)

Public Methods

public cacheTags()

public cacheTags(array|mixed $cacheTags): $this

Indicate that the results, if cached, should use the given cache tags.

public count()

public count(string $columns = '*'): int

Retrieve the "count" result of the query, also strips off any orderBy clause.

public generateCacheKey()

public generateCacheKey(): string

Generate the unique cache key for the query.

public get()

public get($columns = [ 0 => '*']): void

public getCacheKey()

public getCacheKey(): string

getCacheKey returns a unique cache key for the complete query

public getCached()

public getCached($columns = [ 0 => '*']): void

getCached executes the query as a cached "select" statement.

public lists()

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

Get an array with the values of a given column.

public remember()

public remember(DateTime|int $minutes, string $key = null): $this

Indicate that the query results should be cached.

public rememberForever()

public rememberForever(
    string $key = null
): Illuminate\Database\Query\Builder|static

Indicate that the query results should be cached forever.

Show inherited public methods

Inherited Public Methods

  • __call() - Handle dynamic method calls into the method. (defined in Illuminate\Database\Query\Builder)
  • __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Database\Query\Builder)
  • __construct() - Create a new query builder instance. (defined in Illuminate\Database\Query\Builder)
  • addBinding() - Add a binding to the query. (defined in Illuminate\Database\Query\Builder)
  • addNestedHavingQuery() - Add another query builder as a nested having to the query builder. (defined in Illuminate\Database\Query\Builder)
  • addNestedWhereQuery() - Add another query builder as a nested where to the query builder. (defined in Illuminate\Database\Query\Builder)
  • addSelect() - Add a new select column to the query. (defined in Illuminate\Database\Query\Builder)
  • addWhereExistsQuery() - Add an exists clause to the query. (defined in Illuminate\Database\Query\Builder)
  • aggregate() - Execute an aggregate function on the database. (defined in Illuminate\Database\Query\Builder)
  • applyBeforeQueryCallbacks() - Invoke the "before query" modification callbacks. (defined in Illuminate\Database\Query\Builder)
  • average() - Alias for the "avg" method. (defined in Illuminate\Database\Query\Builder)
  • avg() - Retrieve the average of the values of a given column. (defined in Illuminate\Database\Query\Builder)
  • beforeQuery() - Register a closure to be invoked before the query is executed. (defined in Illuminate\Database\Query\Builder)
  • castBinding() - Cast the given binding value. (defined in Illuminate\Database\Query\Builder)
  • chunk() - Chunk the results of the query. (defined in Illuminate\Database\Query\Builder)
  • chunkById() - Chunk the results of a query by comparing IDs. (defined in Illuminate\Database\Query\Builder)
  • chunkMap() - Run a map over each item while chunking. (defined in Illuminate\Database\Query\Builder)
  • cleanBindings() - Remove all of the expressions from a list of bindings. (defined in Illuminate\Database\Query\Builder)
  • clone() - Clone the query. (defined in Illuminate\Database\Query\Builder)
  • cloneWithout() - Clone the query without the given properties. (defined in Illuminate\Database\Query\Builder)
  • cloneWithoutBindings() - Clone the query without the given bindings. (defined in Illuminate\Database\Query\Builder)
  • crossJoin() - Add a "cross join" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • crossJoinSub() - Add a subquery cross join to the query. (defined in Illuminate\Database\Query\Builder)
  • cursor() - Get a lazy collection for the given query. (defined in Illuminate\Database\Query\Builder)
  • cursorPaginate() - Get a paginator only supporting simple next and previous links. (defined in Illuminate\Database\Query\Builder)
  • dd() - Die and dump the current SQL and bindings. (defined in Illuminate\Database\Query\Builder)
  • decrement() - Decrement a column's value by a given amount. (defined in Illuminate\Database\Query\Builder)
  • decrementEach() - Decrement the given column's values by the given amounts. (defined in Illuminate\Database\Query\Builder)
  • delete() - Delete records from the database. (defined in Illuminate\Database\Query\Builder)
  • distinct() - Force the query to only return distinct results. (defined in Illuminate\Database\Query\Builder)
  • doesntExist() - Determine if no rows exist for the current query. (defined in Illuminate\Database\Query\Builder)
  • doesntExistOr() - Execute the given callback if rows exist for the current query. (defined in Illuminate\Database\Query\Builder)
  • dump() - Dump the current SQL and bindings. (defined in Illuminate\Database\Query\Builder)
  • dynamicWhere() - Handles dynamic "where" clauses to the query. (defined in Illuminate\Database\Query\Builder)
  • each() - Execute a callback over each item while chunking. (defined in Illuminate\Database\Query\Builder)
  • eachById() - Execute a callback over each item while chunking by ID. (defined in Illuminate\Database\Query\Builder)
  • exists() - Determine if any rows exist for the current query. (defined in Illuminate\Database\Query\Builder)
  • existsOr() - Execute the given callback if no rows exist for the current query. (defined in Illuminate\Database\Query\Builder)
  • explain() - Explains the query. (defined in Illuminate\Database\Query\Builder)
  • find() - Execute a query for a single record by ID. (defined in Illuminate\Database\Query\Builder)
  • findOr() - Execute a query for a single record by ID or call a callback. (defined in Illuminate\Database\Query\Builder)
  • first() - Execute the query and get the first result. (defined in Illuminate\Database\Query\Builder)
  • flushMacros() - Flush the existing macros. (defined in Illuminate\Database\Query\Builder)
  • forNestedWhere() - Create a new query instance for nested where condition. (defined in Illuminate\Database\Query\Builder)
  • forPage() - Set the limit and offset for a given page. (defined in Illuminate\Database\Query\Builder)
  • forPageAfterId() - Constrain the query to the next "page" of results after a given ID. (defined in Illuminate\Database\Query\Builder)
  • forPageBeforeId() - Constrain the query to the previous "page" of results before a given ID. (defined in Illuminate\Database\Query\Builder)
  • forceIndex() - Add an index hint to force a query index. (defined in Illuminate\Database\Query\Builder)
  • from() - Set the table which the query is targeting. (defined in Illuminate\Database\Query\Builder)
  • fromRaw() - Add a raw from clause to the query. (defined in Illuminate\Database\Query\Builder)
  • fromSub() - Makes "from" fetch from a subquery. (defined in Illuminate\Database\Query\Builder)
  • getBindings() - Get the current query value bindings in a flattened array. (defined in Illuminate\Database\Query\Builder)
  • getConnection() - Get the database connection instance. (defined in Illuminate\Database\Query\Builder)
  • getCountForPagination() - Get the count of the total records for the paginator. (defined in Illuminate\Database\Query\Builder)
  • getGrammar() - Get the query grammar instance. (defined in Illuminate\Database\Query\Builder)
  • getProcessor() - Get the database query processor instance. (defined in Illuminate\Database\Query\Builder)
  • getRawBindings() - Get the raw array of bindings. (defined in Illuminate\Database\Query\Builder)
  • groupBy() - Add a "group by" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • groupByRaw() - Add a raw groupBy clause to the query. (defined in Illuminate\Database\Query\Builder)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Database\Query\Builder)
  • having() - Add a "having" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • havingBetween() - Add a "having between " clause to the query. (defined in Illuminate\Database\Query\Builder)
  • havingNested() - Add a nested having statement to the query. (defined in Illuminate\Database\Query\Builder)
  • havingNotNull() - Add a "having not null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • havingNull() - Add a "having null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • havingRaw() - Add a raw having clause to the query. (defined in Illuminate\Database\Query\Builder)
  • ignoreIndex() - Add an index hint to ignore a query index. (defined in Illuminate\Database\Query\Builder)
  • implode() - Concatenate values of a given column as a string. (defined in Illuminate\Database\Query\Builder)
  • inRandomOrder() - Put the query's results in random order. (defined in Illuminate\Database\Query\Builder)
  • increment() - Increment a column's value by a given amount. (defined in Illuminate\Database\Query\Builder)
  • incrementEach() - Increment the given column's values by the given amounts. (defined in Illuminate\Database\Query\Builder)
  • insert() - Insert new records into the database. (defined in Illuminate\Database\Query\Builder)
  • insertGetId() - Insert a new record and get the value of the primary key. (defined in Illuminate\Database\Query\Builder)
  • insertOrIgnore() - Insert new records into the database while ignoring errors. (defined in Illuminate\Database\Query\Builder)
  • insertUsing() - Insert new records into the table using a subquery. (defined in Illuminate\Database\Query\Builder)
  • join() - Add a join clause to the query. (defined in Illuminate\Database\Query\Builder)
  • joinSub() - Add a subquery join clause to the query. (defined in Illuminate\Database\Query\Builder)
  • joinWhere() - Add a "join where" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • latest() - Add an "order by" clause for a timestamp to the query. (defined in Illuminate\Database\Query\Builder)
  • lazy() - Query lazily, by chunks of the given size. (defined in Illuminate\Database\Query\Builder)
  • lazyById() - Query lazily, by chunking the results of a query by comparing IDs. (defined in Illuminate\Database\Query\Builder)
  • lazyByIdDesc() - Query lazily, by chunking the results of a query by comparing IDs in descending order. (defined in Illuminate\Database\Query\Builder)
  • leftJoin() - Add a left join to the query. (defined in Illuminate\Database\Query\Builder)
  • leftJoinSub() - Add a subquery left join to the query. (defined in Illuminate\Database\Query\Builder)
  • leftJoinWhere() - Add a "join where" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • limit() - Set the "limit" value of the query. (defined in Illuminate\Database\Query\Builder)
  • lock() - Lock the selected rows in the table. (defined in Illuminate\Database\Query\Builder)
  • lockForUpdate() - Lock the selected rows in the table for updating. (defined in Illuminate\Database\Query\Builder)
  • macro() - Register a custom macro. (defined in Illuminate\Database\Query\Builder)
  • macroCall() - Dynamically handle calls to the class. (defined in Illuminate\Database\Query\Builder)
  • max() - Retrieve the maximum value of a given column. (defined in Illuminate\Database\Query\Builder)
  • mergeBindings() - Merge an array of bindings into our bindings. (defined in Illuminate\Database\Query\Builder)
  • mergeWheres() - Merge an array of where clauses and bindings. (defined in Illuminate\Database\Query\Builder)
  • min() - Retrieve the minimum value of a given column. (defined in Illuminate\Database\Query\Builder)
  • mixin() - Mix another object into the class. (defined in Illuminate\Database\Query\Builder)
  • newQuery() - Get a new instance of the query builder. (defined in Illuminate\Database\Query\Builder)
  • numericAggregate() - Execute a numeric aggregate function on the database. (defined in Illuminate\Database\Query\Builder)
  • offset() - Set the "offset" value of the query. (defined in Illuminate\Database\Query\Builder)
  • oldest() - Add an "order by" clause for a timestamp to the query. (defined in Illuminate\Database\Query\Builder)
  • orHaving() - Add an "or having" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orHavingNotNull() - Add an "or having not null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orHavingNull() - Add an "or having null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orHavingRaw() - Add a raw or having clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhere() - Add an "or where" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereBetween() - Add an or where between statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereBetweenColumns() - Add an or where between statement using columns to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereColumn() - Add an "or where" clause comparing two columns to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereDate() - Add an "or where date" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereDay() - Add an "or where day" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereExists() - Add an or exists clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereFullText() - Add a "or where fulltext" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereIn() - Add an "or where in" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereIntegerInRaw() - Add an "or where in raw" clause for integer values to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereIntegerNotInRaw() - Add an "or where not in raw" clause for integer values to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereJsonContains() - Add an "or where JSON contains" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereJsonContainsKey() - Add an "or" clause that determines if a JSON path exists to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereJsonDoesntContain() - Add an "or where JSON not contains" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereJsonDoesntContainKey() - Add an "or" clause that determines if a JSON path does not exist to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereJsonLength() - Add an "or where JSON length" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereMonth() - Add an "or where month" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNot() - Add an "or where not" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNotBetween() - Add an or where not between statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNotBetweenColumns() - Add an or where not between statement using columns to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNotExists() - Add a where not exists clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNotIn() - Add an "or where not in" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNotNull() - Add an "or where not null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereNull() - Add an "or where null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereRaw() - Add a raw or where clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereRowValues() - Adds an or where condition using row values. (defined in Illuminate\Database\Query\Builder)
  • orWhereTime() - Add an "or where time" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orWhereYear() - Add an "or where year" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • orderBy() - Add an "order by" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orderByDesc() - Add a descending "order by" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • orderByRaw() - Add a raw "order by" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • paginate() - Paginate the given query into a simple paginator. (defined in Illuminate\Database\Query\Builder)
  • pluck() - Get a collection instance containing the values of a given column. (defined in Illuminate\Database\Query\Builder)
  • prepareValueAndOperator() - Prepare the value and operator for a where clause. (defined in Illuminate\Database\Query\Builder)
  • raw() - Create a raw database expression. (defined in Illuminate\Database\Query\Builder)
  • rawValue() - Get a single expression value from the first result of a query. (defined in Illuminate\Database\Query\Builder)
  • reorder() - Remove all existing orders and optionally add a new order. (defined in Illuminate\Database\Query\Builder)
  • rightJoin() - Add a right join to the query. (defined in Illuminate\Database\Query\Builder)
  • rightJoinSub() - Add a subquery right join to the query. (defined in Illuminate\Database\Query\Builder)
  • rightJoinWhere() - Add a "right join where" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • select() - Set the columns to be selected. (defined in Illuminate\Database\Query\Builder)
  • selectRaw() - Add a new "raw" select expression to the query. (defined in Illuminate\Database\Query\Builder)
  • selectSub() - Add a subselect expression to the query. (defined in Illuminate\Database\Query\Builder)
  • setBindings() - Set the bindings on the query builder. (defined in Illuminate\Database\Query\Builder)
  • sharedLock() - Share lock the selected rows in the table. (defined in Illuminate\Database\Query\Builder)
  • simplePaginate() - Get a paginator only supporting simple next and previous links. (defined in Illuminate\Database\Query\Builder)
  • skip() - Alias to set the "offset" value of the query. (defined in Illuminate\Database\Query\Builder)
  • sole() - Execute the query and get the first result if it's the sole matching record. (defined in Illuminate\Database\Query\Builder)
  • soleValue() - Get a single column's value from the first result of a query if it's the sole matching record. (defined in Illuminate\Database\Query\Builder)
  • sum() - Retrieve the sum of the values of a given column. (defined in Illuminate\Database\Query\Builder)
  • take() - Alias to set the "limit" value of the query. (defined in Illuminate\Database\Query\Builder)
  • tap() - Pass the query to a given callback. (defined in Illuminate\Database\Query\Builder)
  • toSql() - Get the SQL representation of the query. (defined in Illuminate\Database\Query\Builder)
  • truncate() - Run a truncate statement on the table. (defined in Illuminate\Database\Query\Builder)
  • union() - Add a union statement to the query. (defined in Illuminate\Database\Query\Builder)
  • unionAll() - Add a union all statement to the query. (defined in Illuminate\Database\Query\Builder)
  • unless() - Apply the callback if the given "value" is (or resolves to) falsy. (defined in Illuminate\Database\Query\Builder)
  • update() - Update records in the database. (defined in Illuminate\Database\Query\Builder)
  • updateFrom() - Update records in a PostgreSQL database using the update from syntax. (defined in Illuminate\Database\Query\Builder)
  • updateOrInsert() - Insert or update a record matching the attributes, and fill it with values. (defined in Illuminate\Database\Query\Builder)
  • upsert() - Insert new records or update the existing ones. (defined in Illuminate\Database\Query\Builder)
  • useIndex() - Add an index hint to suggest a query index. (defined in Illuminate\Database\Query\Builder)
  • useWritePdo() - Use the "write" PDO connection when executing the query. (defined in Illuminate\Database\Query\Builder)
  • value() - Get a single column's value from the first result of a query. (defined in Illuminate\Database\Query\Builder)
  • when() - Apply the callback if the given "value" is (or resolves to) truthy. (defined in Illuminate\Database\Query\Builder)
  • where() - Add a basic where clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereBetween() - Add a where between statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereBetweenColumns() - Add a where between statement using columns to the query. (defined in Illuminate\Database\Query\Builder)
  • whereColumn() - Add a "where" clause comparing two columns to the query. (defined in Illuminate\Database\Query\Builder)
  • whereDate() - Add a "where date" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereDay() - Add a "where day" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereExists() - Add an exists clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereFullText() - Add a "where fulltext" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereIn() - Add a "where in" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereIntegerInRaw() - Add a "where in raw" clause for integer values to the query. (defined in Illuminate\Database\Query\Builder)
  • whereIntegerNotInRaw() - Add a "where not in raw" clause for integer values to the query. (defined in Illuminate\Database\Query\Builder)
  • whereJsonContains() - Add a "where JSON contains" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereJsonContainsKey() - Add a clause that determines if a JSON path exists to the query. (defined in Illuminate\Database\Query\Builder)
  • whereJsonDoesntContain() - Add a "where JSON not contains" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereJsonDoesntContainKey() - Add a clause that determines if a JSON path does not exist to the query. (defined in Illuminate\Database\Query\Builder)
  • whereJsonLength() - Add a "where JSON length" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereMonth() - Add a "where month" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNested() - Add a nested where statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNot() - Add a basic "where not" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNotBetween() - Add a where not between statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNotBetweenColumns() - Add a where not between statement using columns to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNotExists() - Add a where not exists clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNotIn() - Add a "where not in" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNotNull() - Add a "where not null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereNull() - Add a "where null" clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereRaw() - Add a raw where clause to the query. (defined in Illuminate\Database\Query\Builder)
  • whereRowValues() - Adds a where condition using row values. (defined in Illuminate\Database\Query\Builder)
  • whereTime() - Add a "where time" statement to the query. (defined in Illuminate\Database\Query\Builder)
  • whereYear() - Add a "where year" statement to the query. (defined in Illuminate\Database\Query\Builder)

Protected Methods

protected getCache()

protected getCache(): Illuminate\Cache\CacheManager

Get the cache object with tags assigned, if applicable.

protected getCacheCallback()

protected getCacheCallback(array $columns): Closure

Get the Closure callback used when caching queries.

protected getCacheInfo()

protected getCacheInfo(): array

getCacheInfo returns key and cache minutes

Show inherited protected methods

Inherited Protected Methods

  • addArrayOfWheres() - Add an array of where clauses to the query. (defined in Illuminate\Database\Query\Builder)
  • addDateBasedWhere() - Add a date based (year, month, day, time) statement to the query. (defined in Illuminate\Database\Query\Builder)
  • addDynamic() - Add a single dynamic where clause statement to the query. (defined in Illuminate\Database\Query\Builder)
  • cloneForPaginationCount() - Clone the existing query instance for usage in a pagination subquery. (defined in Illuminate\Database\Query\Builder)
  • createSub() - Creates a subquery and parse it. (defined in Illuminate\Database\Query\Builder)
  • cursorPaginator() - Create a new cursor paginator instance. (defined in Illuminate\Database\Query\Builder)
  • defaultKeyName() - Get the default key name of the table. (defined in Illuminate\Database\Query\Builder)
  • enforceOrderBy() - Throw an exception if the query doesn't have an orderBy clause. (defined in Illuminate\Database\Query\Builder)
  • ensureOrderForCursorPagination() - Ensure the proper order by required for cursor pagination. (defined in Illuminate\Database\Query\Builder)
  • flattenValue() - Get a scalar type value from an unknown type of input. (defined in Illuminate\Database\Query\Builder)
  • forSubQuery() - Create a new query instance for a sub-query. (defined in Illuminate\Database\Query\Builder)
  • forwardCallTo() - Forward a method call to the given object. (defined in Illuminate\Database\Query\Builder)
  • forwardDecoratedCallTo() - Forward a method call to the given object, returning $this if the forwarded call returned itself. (defined in Illuminate\Database\Query\Builder)
  • getOriginalColumnNameForCursorPagination() - Get the original column name of the given column, without any aliasing. (defined in Illuminate\Database\Query\Builder)
  • invalidOperator() - Determine if the given operator is supported. (defined in Illuminate\Database\Query\Builder)
  • invalidOperatorAndValue() - Determine if the given operator and value combination is legal. (defined in Illuminate\Database\Query\Builder)
  • isBitwiseOperator() - Determine if the operator is a bitwise operator. (defined in Illuminate\Database\Query\Builder)
  • isQueryable() - Determine if the value is a query builder instance or a Closure. (defined in Illuminate\Database\Query\Builder)
  • newJoinClause() - Get a new join clause. (defined in Illuminate\Database\Query\Builder)
  • onceWithColumns() - Execute the given callback while selecting the given columns. (defined in Illuminate\Database\Query\Builder)
  • orderedLazyById() - Query lazily, by chunking the results of a query by comparing IDs in a given order. (defined in Illuminate\Database\Query\Builder)
  • paginateUsingCursor() - Paginate the given query using a cursor paginator. (defined in Illuminate\Database\Query\Builder)
  • paginator() - Create a new length-aware paginator instance. (defined in Illuminate\Database\Query\Builder)
  • parseSub() - Parse the subquery into SQL and bindings. (defined in Illuminate\Database\Query\Builder)
  • pluckFromArrayColumn() - Retrieve column values from rows represented as arrays. (defined in Illuminate\Database\Query\Builder)
  • pluckFromObjectColumn() - Retrieve column values from rows represented as objects. (defined in Illuminate\Database\Query\Builder)
  • prependDatabaseNameIfCrossDatabaseQuery() - Prepend the database name if the given query is on another database. (defined in Illuminate\Database\Query\Builder)
  • removeExistingOrdersFor() - Get an array with all orders with a given column removed. (defined in Illuminate\Database\Query\Builder)
  • runPaginationCountQuery() - Run a pagination count query. (defined in Illuminate\Database\Query\Builder)
  • runSelect() - Run the query as a "select" statement against the connection. (defined in Illuminate\Database\Query\Builder)
  • setAggregate() - Set the aggregate property without running the query. (defined in Illuminate\Database\Query\Builder)
  • simplePaginator() - Create a new simple paginator instance. (defined in Illuminate\Database\Query\Builder)
  • stripTableForPluck() - Strip off the table name or alias from a column identifier. (defined in Illuminate\Database\Query\Builder)
  • throwBadMethodCallException() - Throw a bad method call exception for the given method. (defined in Illuminate\Database\Query\Builder)
  • whereSub() - Add a full sub-select to the query. (defined in Illuminate\Database\Query\Builder)
  • withoutSelectAliases() - Remove the column aliases since they will break count queries. (defined in Illuminate\Database\Query\Builder)