This class represents a Relational database SQL Query. A query can be of different types like select, update, insert and delete. Exposes the methods for dynamically constructing each query part, execute it and transform it to a specific SQL dialect.
string 'INNER' string 'LEFT' string 'RIGHT' \Cake\Database\ConnectionConnection instance to be used to execute this query.
string[]The list of query clauses to traverse for generating a DELETE statement
boolIndicates whether internal state of this query was changed, this is used to discard internal cached objects such as the transformed query or the reference to the executed statement.
\Cake\Database\FunctionsBuilder|nullInstance of functions builder object used for generating arbitrary SQL functions.
string[]The list of query clauses to traverse for generating an INSERT statement
\Cake\Database\StatementInterface|nullStatement object resulting from executing this query.
arrayList of SQL parts that will be used to build this query.
callable[]A list of callback functions to be called to alter each row from resulting statement upon retrieval. Each one of the callback function will receive the row array as first argument.
string[]The list of query clauses to traverse for generating a SELECT statement
\Cake\Database\TypeMapThe Type map for fields in the select clause
stringType of this query (select, insert, update, delete).
\Cake\Database\TypeMapstring[]The list of query clauses to traverse for generating an UPDATE statement
boolBoolean for tracking whether or not buffered results are enabled.
\Cake\Database\ValueBinder|nullThe object responsible for generating query placeholders and temporarily store values associated to each of those.
boolTracking flag to disable casting
Returns an array that can be used to describe the internal state of this object.
Helper function used to build conditions by composing QueryExpression objects.
Auxiliary function used to wrap the original statement from the driver with any registered callbacks.
Marks a query as dirty, removing any preprocessed information from in memory caching.
Returns an array that can be passed to the join method describing a single join clause
Connects any previously defined set of conditions to the provided list using the AND operator in the HAVING clause. This method operates in exactly the same way as the method andWhere() does. Please refer to its documentation for an insight on how to using each parameter.
Connects any previously defined set of conditions to the provided list using the AND operator. This function accepts the conditions list in the same format as the method where does, hence you can use arrays, expression objects callback functions or strings.
Returns any data that was stored in the specified clause. This is useful for modifying any internal part of the query and it is used by the SQL dialects to transform the query accordingly before it is executed. The valid clauses that can be retrieved are: delete, update, set, insert, values, select, distinct, from, join, set, where, group, having, order, limit, offset and union.
Registers a callback to be executed for each result that is fetched from the result set, the callback function will receive as first parameter an array with the raw data from the database for every row that is fetched and must return the row with any possible modifications.
Disables the automatic casting of fields to their corresponding PHP data type
Compiles the SQL representation of this query and executes it using the configured connection object. Returns the resulting statement object.
Returns an instance of a functions builder object that can be used for generating arbitrary SQL functions.
Gets the connection instance to be used for executing and transforming this query.
Executes this query and returns a results iterator. This function is required for implementing the IteratorAggregate interface and allows the query to be iterated without having to call execute() manually, thus making it look like a result set instead of the query itself.
Gets the TypeMap class where the types for each of the fields in the select clause are stored.
Adds a condition or set of conditions to be used in the HAVING clause for this query. This method operates in exactly the same way as the method where() does. Please refer to its documentation for an insight on how to using each parameter.
Creates an expression that refers to an identifier. Identifiers are used to refer to field names and allow the SQL compiler to apply quotes or escape the identifier.
Sets the number of records that should be retrieved from database, accepts an integer or an expression object that evaluates to an integer.
Returns a new QueryExpression object. This is a handy function when building complex queries using a fluent interface. You can also override this function in subclasses to use a more specialized QueryExpression class if required.
Sets the number of records that should be skipped from the original result set This is commonly used for paginating large results. Accepts an integer or an expression object that evaluates to an integer.
Executes the SQL of this query and immediately closes the statement before returning the row count of records changed.
Adds new fields to be returned by a SELECT statement when this query is executed. Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.
Sets the connection instance to be used for executing and transforming this query.
Sets the TypeMap class where the types for each of the fields in the select clause are stored.
Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
Will iterate over every specified part. Traversing functions can aggregate results using variables in the closure or instance variables. This function is commonly used as a way for traversing all query parts that are going to be used for constructing a query.
This function works similar to the traverse() function, with the difference that it does a full depth traversal of the entire expression tree. This will execute the provided callback function for each ExpressionInterface object that is stored inside this query at any nesting depth in any part of the query.
Adds a complete query to be used in conjunction with an UNION operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
Adds a complete query to be used in conjunction with the UNION ALL operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
Adds a condition or set of conditions to be used in the WHERE clause for this query. Conditions can be expressed as an array of fields as keys with comparison operators in it, the values for the array will be used for comparing the field to such literal. Finally, conditions can be expressed as a single string or an array of strings.
Adds an IN condition or set of conditions to be used in the WHERE clause for this query.
Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query.
__clone()
Handles clearing iterator and cloning all expressions and value binders.
__construct(\Cake\Database\Connection $connection)
Constructor.
\Cake\Database\Connection $connection The connection object to be used for transforming and executing this query
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array__toString()
Returns string representation of this query (complete SQL statement).
string_conjugate(string $part, mixed $append, mixed $conjunction, array $types)
Helper function used to build conditions by composing QueryExpression objects.
string $part Name of the query part to append the new part to
string|array|\Cake\Database\ExpressionInterface|\Closure|null $append Expression or builder function to append. to append.
string $conjunction type of conjunction to be used to operate part
array $types associative array of type names used to bind values to query
_decorateStatement(\Cake\Database\StatementInterface $statement)
Auxiliary function used to wrap the original statement from the driver with any registered callbacks.
\Cake\Database\StatementInterface $statement to be decorated
\Cake\Database\Statement\CallbackStatement|\Cake\Database\StatementInterface_dirty()
Marks a query as dirty, removing any preprocessed information from in memory caching.
_expressionsVisitor(mixed $expression, \Closure $callback)
Query parts traversal method used by traverseExpressions()
\Cake\Database\ExpressionInterface|\Cake\Database\ExpressionInterface[] $expression Query expression or array of expressions.
\Closure $callback The callback to be executed for each ExpressionInterface found inside this query.
_makeJoin(mixed $table, mixed $conditions, mixed $type)
Returns an array that can be passed to the join method describing a single join clause
string|string[] $table The table to join with
string|array|\Cake\Database\ExpressionInterface $conditions The conditions to use for joining.
string $type the join type to use
arrayandHaving(mixed $conditions, mixed $types)
Connects any previously defined set of conditions to the provided list using the AND operator in the HAVING clause. This method operates in exactly the same way as the method andWhere() does. Please refer to its documentation for an insight on how to using each parameter.
Having fields are not suitable for use with user supplied data as they are not sanitized by the query builder.
string|array|\Cake\Database\ExpressionInterface|\Closure $conditions The AND conditions for HAVING.
array $types optional associative array of type names used to bind values to query
$thisandWhere(mixed $conditions, array $types)
Connects any previously defined set of conditions to the provided list using the AND operator. This function accepts the conditions list in the same format as the method where does, hence you can use arrays, expression objects callback functions or strings.
It is important to notice that when calling this function, any previous set of conditions defined for this query will be treated as a single argument for the AND operator. This function will not only operate the most recently defined condition, but all the conditions as a whole.
When using an array for defining conditions, creating constraints form each array entry will use the same logic as with the where() function. This means that each array entry will be joined to the other using the AND operator, unless you nest the conditions in the array using other operator.
$query->where(['title' => 'Hello World')->andWhere(['author_id' => 1]);
Will produce:
WHERE title = 'Hello World' AND author_id = 1
$query ->where(['OR' => ['published' => false, 'published is NULL']]) ->andWhere(['author_id' => 1, 'comments_count >' => 10])
Produces:
WHERE (published = 0 OR published IS NULL) AND author_id = 1 AND comments_count > 10
$query
->where(['title' => 'Foo'])
->andWhere(function ($exp, $query) {
return $exp
->or(['author_id' => 1])
->add(['author_id' => 2]);
}); Generates the following conditions:
WHERE (title = 'Foo') AND (author_id = 1 OR author_id = 2)
string|array|\Cake\Database\ExpressionInterface|\Closure $conditions The conditions to add with AND.
array $types optional associative array of type names used to bind values to query
$thisbind(mixed $param, mixed $value, mixed $type)
Associates a query placeholder to a value and a type.
$query->bind(':id', 1, 'integer'); string|int $param placeholder to be replaced with quoted version of $value
mixed $value The value to be bound
string|int|null $type optional the mapped type name, used for casting when sending to database
$thisclause(string $name)
Returns any data that was stored in the specified clause. This is useful for modifying any internal part of the query and it is used by the SQL dialects to transform the query accordingly before it is executed. The valid clauses that can be retrieved are: delete, update, set, insert, values, select, distinct, from, join, set, where, group, having, order, limit, offset and union.
The return value for each of those parts may vary. Some clauses use QueryExpression to internally store their state, some use arrays and others may use booleans or integers. This is summary of the return types for each clause.
string $name name of the clause to be returned
mixedInvalidArgumentExceptiondecorateResults(?callable $callback, bool $overwrite)
Registers a callback to be executed for each result that is fetched from the result set, the callback function will receive as first parameter an array with the raw data from the database for every row that is fetched and must return the row with any possible modifications.
Callbacks will be executed lazily, if only 3 rows are fetched for database it will called 3 times, event though there might be more rows to be fetched in the cursor.
Callbacks are stacked in the order they are registered, if you wish to reset the stack the call this function with the second parameter set to true.
If you wish to remove all decorators from the stack, set the first parameter to null and the second to true.
$query->decorateResults(function ($row) {
$row['order_total'] = $row['subtotal'] + ($row['subtotal'] * $row['tax']);
return $row;
}); callable|null $callback The callback to invoke when results are fetched.
bool $overwrite optional Whether or not this should append or replace all existing decorators.
$thisdelete(?string $table)
Create a delete query.
Can be combined with from(), where() and other methods to create delete queries with specific conditions.
string|null $table optional The table to use when deleting.
$thisdisableBufferedResults()
Disables buffered results.
Disabling buffering will consume less memory as fetched results are not remembered for future iterations.
$thisdisableResultsCasting()
Disables the automatic casting of fields to their corresponding PHP data type
$thisdistinct(mixed $on, mixed $overwrite)
Adds a DISTINCT clause to the query to remove duplicates from the result set.
This clause can only be used for select statements.
If you wish to filter duplicates based of those rows sharing a particular field or set of fields, you may pass an array of fields to filter on. Beware that this option might not be fully supported in all database systems.
// Filters products with the same name and city
$query->select(['name', 'city'])->from('products')->distinct();
// Filters products in the same city
$query->distinct(['city']);
$query->distinct('city');
// Filter products with the same name
$query->distinct(['name'], true);
$query->distinct('name', true); array|\Cake\Database\ExpressionInterface|string|bool $on optional Enable/disable distinct class or list of fields to be filtered on
bool $overwrite optional whether to reset fields with passed list or not
$thisenableBufferedResults(bool $enable)
Enables/Disables buffered results.
When enabled the results returned by this Query will be buffered. This enables you to iterate a result set multiple times, or both cache and iterate it.
When disabled it will consume less memory as fetched results are not remembered for future iterations.
bool $enable optional Whether or not to enable buffering
$thisenableResultsCasting()
Enables the automatic casting of fields to their corresponding type
$thisepilog(mixed $expression)
A string or expression that will be appended to the generated query
$query->select('id')->where(['author_id' => 1])->epilog('FOR UPDATE');
$query
->insert('articles', ['title'])
->values(['author_id' => 1])
->epilog('RETURNING id'); Epliog content is raw SQL and not suitable for use with user supplied data.
string|\Cake\Database\ExpressionInterface|null $expression optional The expression to be appended
$thisexecute()
Compiles the SQL representation of this query and executes it using the configured connection object. Returns the resulting statement object.
Executing a query internally executes several steps, the first one is letting the connection transform this object to fit its particular dialect, this might result in generating a different Query object that will be the one to actually be executed. Immediately after, literal values are passed to the connection so they are bound to the query in a safe way. Finally, the resulting statement is decorated with custom objects to execute callbacks for each row retrieved if necessary.
Resulting statement is traversable, so it can be used in any loop as you would with an array.
This method can be overridden in query subclasses to decorate behavior around query execution.
\Cake\Database\StatementInterfacefrom(mixed $tables, mixed $overwrite)
Adds a single or multiple tables to be used in the FROM clause for this query.
Tables can be passed as an array of strings, array of expression objects, a single expression or a single string.
If an array is passed, keys will be used to alias tables using the value as the real field to be aliased. It is possible to alias strings, ExpressionInterface objects or even other Query objects.
By default this function will append any passed argument to the list of tables to be selected from, unless the second argument is set to true.
This method can be used for select, update and delete statements.
$query->from(['p' => 'posts']); // Produces FROM posts p
$query->from('authors'); // Appends authors: FROM posts p, authors
$query->from(['products'], true); // Resets the list: FROM products
$query->from(['sub' => $countQuery]); // FROM (SELECT ...) sub array|string $tables optional tables to be added to the list. This argument, can be passed as an array of strings, array of expression objects, or a single string. See the examples above for the valid call types.
bool $overwrite optional whether to reset tables with passed list or not
$thisfunc()
Returns an instance of a functions builder object that can be used for generating arbitrary SQL functions.
$query->func()->count('*');
$query->func()->dateDiff(['2012-01-05', '2012-01-02']) \Cake\Database\FunctionsBuildergetConnection()
Gets the connection instance to be used for executing and transforming this query.
\Cake\Database\ConnectiongetDefaultTypes()
Gets default types of current type map.
arraygetIterator()
Executes this query and returns a results iterator. This function is required for implementing the IteratorAggregate interface and allows the query to be iterated without having to call execute() manually, thus making it look like a result set instead of the query itself.
\Cake\Database\StatementInterfacegetSelectTypeMap()
Gets the TypeMap class where the types for each of the fields in the select clause are stored.
\Cake\Database\TypeMapgetTypeMap()
Returns the existing type map.
\Cake\Database\TypeMapgetValueBinder()
Returns the currently used ValueBinder instance.
A ValueBinder is responsible for generating query placeholders and temporarily associate values to those placeholders so that they can be passed correctly to the statement object.
\Cake\Database\ValueBindergroup(mixed $fields, mixed $overwrite)
Adds a single or multiple fields to be used in the GROUP BY clause for this query.
Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.
By default this function will append any passed argument to the list of fields to be grouped, unless the second argument is set to true.
// Produces GROUP BY id, title
$query->group(['id', 'title']);
// Produces GROUP BY title
$query->group('title'); Group fields are not suitable for use with user supplied data as they are not sanitized by the query builder.
array|\Cake\Database\ExpressionInterface|string $fields fields to be added to the list
bool $overwrite optional whether to reset fields with passed list or not
$thishaving(mixed $conditions, mixed $types, mixed $overwrite)
Adds a condition or set of conditions to be used in the HAVING clause for this query. This method operates in exactly the same way as the method where() does. Please refer to its documentation for an insight on how to using each parameter.
Having fields are not suitable for use with user supplied data as they are not sanitized by the query builder.
string|array|\Cake\Database\ExpressionInterface|\Closure|null $conditions optional The having conditions.
array $types optional associative array of type names used to bind values to query
bool $overwrite optional whether to reset conditions with passed list or not
$thisidentifier(string $identifier)
Creates an expression that refers to an identifier. Identifiers are used to refer to field names and allow the SQL compiler to apply quotes or escape the identifier.
The value is used as is, and you might be required to use aliases or include the table reference in the identifier. Do not use this method to inject SQL methods or logical statements.
$query->newExpr()->lte('count', $query->identifier('total')); string $identifier The identifier for an expression
\Cake\Database\ExpressionInterfaceinnerJoin(mixed $table, mixed $conditions, mixed $types)
Adds a single INNER JOIN clause to the query.
This is a shorthand method for building joins via join().
The arguments of this method are identical to the leftJoin() shorthand, please refer to that methods description for further details.
string|array $table The table to join with
string|array|\Cake\Database\ExpressionInterface $conditions optional The conditions to use for joining.
array $types optional a list of types associated to the conditions used for converting values to the corresponding database representation.
$thisinsert(array $columns, array $types)
Create an insert query.
Note calling this method will reset any data previously set with Query::values().
array $columns The columns to insert into.
string[] $types optional A map between columns & their datatypes.
$thisRuntimeExceptioninto(string $table)
Set the table name for insert queries.
string $table The table name to insert into.
$thisisBufferedResultsEnabled()
Returns whether buffered results are enabled/disabled.
When enabled the results returned by this Query will be buffered. This enables you to iterate a result set multiple times, or both cache and iterate it.
When disabled it will consume less memory as fetched results are not remembered for future iterations.
booljoin(mixed $tables, mixed $types, mixed $overwrite)
Adds a single or multiple tables to be used as JOIN clauses to this query.
Tables can be passed as an array of strings, an array describing the join parts, an array with multiple join descriptions, or a single string.
By default this function will append any passed argument to the list of tables to be joined, unless the third argument is set to true.
When no join type is specified an INNER JOIN is used by default: $query->join(['authors']) will produce INNER JOIN authors ON 1 = 1
It is also possible to alias joins using the array key: $query->join(['a' => 'authors']) will produce INNER JOIN authors a ON 1 = 1
A join can be fully described and aliased using the array notation:
$query->join([
'a' => [
'table' => 'authors',
'type' => 'LEFT',
'conditions' => 'a.id = b.author_id'
]
]);
// Produces LEFT JOIN authors a ON a.id = b.author_id You can even specify multiple joins in an array, including the full description:
$query->join([
'a' => [
'table' => 'authors',
'type' => 'LEFT',
'conditions' => 'a.id = b.author_id'
],
'p' => [
'table' => 'publishers',
'type' => 'INNER',
'conditions' => 'p.id = b.publisher_id AND p.name = "Cake Software Foundation"'
]
]);
// LEFT JOIN authors a ON a.id = b.author_id
// INNER JOIN publishers p ON p.id = b.publisher_id AND p.name = "Cake Software Foundation" Conditions can be expressed, as in the examples above, using a string for comparing columns, or string with already quoted literal values. Additionally it is possible to use conditions expressed in arrays or expression objects.
When using arrays for expressing conditions, it is often desirable to convert the literal values to the correct database representation. This is achieved using the second parameter of this function.
$query->join(['a' => [
'table' => 'articles',
'conditions' => [
'a.posted >=' => new DateTime('-3 days'),
'a.published' => true,
'a.author_id = authors.id'
]
]], ['a.posted' => 'datetime', 'a.published' => 'boolean']) When creating aliased joins using the array notation, you can override previous join definitions by using the same alias in consequent calls to this function or you can replace all previously defined joins with another list if the third parameter for this function is set to true.
$query->join(['alias' => 'table']); // joins table with as alias $query->join(['alias' => 'another_table']); // joins another_table with as alias $query->join(['something' => 'different_table'], [], true); // resets joins list
array|string $tables list of tables to be joined in the query
array $types optional associative array of type names used to bind values to query
bool $overwrite optional whether to reset joins with passed list or not
$thisleftJoin(mixed $table, mixed $conditions, mixed $types)
Adds a single LEFT JOIN clause to the query.
This is a shorthand method for building joins via join().
The table name can be passed as a string, or as an array in case it needs to be aliased:
// LEFT JOIN authors ON authors.id = posts.author_id
$query->leftJoin('authors', 'authors.id = posts.author_id');
// LEFT JOIN authors a ON a.id = posts.author_id
$query->leftJoin(['a' => 'authors'], 'a.id = posts.author_id'); Conditions can be passed as strings, arrays, or expression objects. When using arrays it is possible to combine them with the $types parameter in order to define how to convert the values:
$query->leftJoin(['a' => 'articles'], [
'a.posted >=' => new DateTime('-3 days'),
'a.published' => true,
'a.author_id = authors.id'
], ['a.posted' => 'datetime', 'a.published' => 'boolean']); See join() for further details on conditions and types.
string|string[] $table The table to join with
string|array|\Cake\Database\ExpressionInterface $conditions optional The conditions to use for joining.
array $types optional a list of types associated to the conditions used for converting values to the corresponding database representation.
$thislimit(mixed $num)
Sets the number of records that should be retrieved from database, accepts an integer or an expression object that evaluates to an integer.
In some databases, this operation might not be supported or will require the query to be transformed in order to limit the result set size.
$query->limit(10) // generates LIMIT 10 $query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)
int|\Cake\Database\ExpressionInterface|null $num number of records to be returned
$thismodifier(mixed $modifiers, mixed $overwrite)
Adds a single or multiple SELECT modifiers to be used in the SELECT.
By default this function will append any passed argument to the list of modifiers to be applied, unless the second argument is set to true.
// Ignore cache query in MySQL
$query->select(['name', 'city'])->from('products')->modifier('SQL_NO_CACHE');
// It will produce the SQL: SELECT SQL_NO_CACHE name, city FROM products
// Or with multiple modifiers
$query->select(['name', 'city'])->from('products')->modifier(['HIGH_PRIORITY', 'SQL_NO_CACHE']);
// It will produce the SQL: SELECT HIGH_PRIORITY SQL_NO_CACHE name, city FROM products array|\Cake\Database\ExpressionInterface|string $modifiers modifiers to be applied to the query
bool $overwrite optional whether to reset order with field list or not
$thisnewExpr(mixed $rawExpression)
Returns a new QueryExpression object. This is a handy function when building complex queries using a fluent interface. You can also override this function in subclasses to use a more specialized QueryExpression class if required.
You can optionally pass a single raw SQL string or an array or expressions in any format accepted by \Cake\Database\Expression\QueryExpression:
$expression = $query->newExpr(); // Returns an empty expression object
$expression = $query->newExpr('Table.column = Table2.column'); // Return a raw SQL expression string|array|\Cake\Database\ExpressionInterface|null $rawExpression optional A string, array or anything you want wrapped in an expression object
\Cake\Database\Expression\QueryExpressionoffset(mixed $num)
Sets the number of records that should be skipped from the original result set This is commonly used for paginating large results. Accepts an integer or an expression object that evaluates to an integer.
In some databases, this operation might not be supported or will require the query to be transformed in order to limit the result set size.
$query->offset(10) // generates OFFSET 10 $query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1)
int|\Cake\Database\ExpressionInterface|null $num number of records to be skipped
$thisorder(mixed $fields, mixed $overwrite)
Adds a single or multiple fields to be used in the ORDER clause for this query.
Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.
If an array is passed, keys will be used as the field itself and the value will represent the order in which such field should be ordered. When called multiple times with the same fields as key, the last order definition will prevail over the others.
By default this function will append any passed argument to the list of fields to be selected, unless the second argument is set to true.
$query->order(['title' => 'DESC', 'author_id' => 'ASC']);
Produces:
ORDER BY title DESC, author_id ASC
$query->order(['title' => 'DESC NULLS FIRST'])->order('author_id'); Will generate:
ORDER BY title DESC NULLS FIRST, author_id
$expression = $query->newExpr()->add(['id % 2 = 0']); $query->order($expression)->order(['title' => 'ASC']);
and
$query->order(function ($exp, $query) {
return [$exp->add(['id % 2 = 0']), 'title' => 'ASC'];
}); Will both become:
ORDER BY (id %2 = 0), title ASC
Order fields/directions are not sanitized by the query builder. You should use an allowed list of fields/directions when passing in user-supplied data to order().
If you need to set complex expressions as order conditions, you should use orderAsc() or orderDesc().
array|\Cake\Database\ExpressionInterface|\Closure|string $fields fields to be added to the list
bool $overwrite optional whether to reset order with field list or not
$thisorderAsc(mixed $field, mixed $overwrite)
Add an ORDER BY clause with an ASC direction.
This method allows you to set complex expressions as order conditions unlike order()
Order fields are not suitable for use with user supplied data as they are not sanitized by the query builder.
string|\Cake\Database\Expression\QueryExpression|\Closure $field The field to order on.
bool $overwrite optional Whether or not to reset the order clauses.
$thisorderDesc(mixed $field, mixed $overwrite)
Add an ORDER BY clause with a DESC direction.
This method allows you to set complex expressions as order conditions unlike order()
Order fields are not suitable for use with user supplied data as they are not sanitized by the query builder.
string|\Cake\Database\Expression\QueryExpression|\Closure $field The field to order on.
bool $overwrite optional Whether or not to reset the order clauses.
$thispage(int $num, ?int $limit)
Set the page of results you want.
This method provides an easier to use interface to set the limit + offset in the record set you want as results. If empty the limit will default to the existing limit clause, and if that too is empty, then 25 will be used.
Pages must start at 1.
int $num The page number you want.
int|null $limit optional The number of rows you want in the page. If null the current limit clause will be used.
$thisInvalidArgumentExceptionremoveJoin(string $name)
Remove a join if it has been defined.
Useful when you are redefining joins or want to re-order the join clauses.
string $name The alias/name of the join to remove.
$thisrightJoin(mixed $table, mixed $conditions, mixed $types)
Adds a single RIGHT JOIN clause to the query.
This is a shorthand method for building joins via join().
The arguments of this method are identical to the leftJoin() shorthand, please refer to that methods description for further details.
string|string[] $table The table to join with
string|array|\Cake\Database\ExpressionInterface $conditions optional The conditions to use for joining.
array $types optional a list of types associated to the conditions used for converting values to the corresponding database representation.
$thisrowCountAndClose()
Executes the SQL of this query and immediately closes the statement before returning the row count of records changed.
This method can be used with UPDATE and DELETE queries, but is not recommended for SELECT queries and is not used to count records.
$rowCount = $query->update('articles')
->set(['published'=>true])
->where(['published'=>false])
->rowCountAndClose(); The above example will change the published column to true for all false records, and return the number of records that were updated.
intselect(mixed $fields, bool $overwrite)
Adds new fields to be returned by a SELECT statement when this query is executed. Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.
If an array is passed, keys will be used to alias fields using the value as the real field to be aliased. It is possible to alias strings, Expression objects or even other Query objects.
If a callable function is passed, the returning array of the function will be used as the list of fields.
By default this function will append any passed argument to the list of fields to be selected, unless the second argument is set to true.
$query->select(['id', 'title']); // Produces SELECT id, title
$query->select(['author' => 'author_id']); // Appends author: SELECT id, title, author_id as author
$query->select('id', true); // Resets the list: SELECT id
$query->select(['total' => $countQuery]); // SELECT id, (SELECT ...) AS total
$query->select(function ($query) {
return ['article_id', 'total' => $query->count('*')];
}) By default no fields are selected, if you have an instance of Cake\ORM\Query and try to append fields you should also call Cake\ORM\Query::enableAutoFields() to select the default fields from the table.
array|\Cake\Database\ExpressionInterface|string|callable $fields optional fields to be added to the list.
bool $overwrite optional whether to reset fields with passed list or not
$thisset(mixed $key, mixed $value, mixed $types)
Set one or many fields to update.
Passing a string:
$query->update('articles')->set('title', 'The Title'); Passing an array:
$query->update('articles')->set(['title' => 'The Title'], ['title' => 'string']); Passing a callable:
$query->update('articles')->set(function ($exp) {
return $exp->eq('title', 'The title', 'string');
}); string|array|\Closure|\Cake\Database\Expression\QueryExpression $key The column name or array of keys
mixed $value optional The value to update $key to. Can be null if $key is an array or QueryExpression. When $key is an array, this parameter will be used as $types instead.
array|string $types optional The column types to treat data as.
$thissetConnection(\Cake\Database\Connection $connection)
Sets the connection instance to be used for executing and transforming this query.
\Cake\Database\Connection $connection Connection instance
$thissetDefaultTypes(array $types)
Overwrite the default type mappings for fields in the implementing object.
This method is useful if you need to set type mappings that are shared across multiple functions/expressions in a query.
To add a default without overwriting existing ones use getTypeMap()->addDefaults()
array $types The array of types to set.
$thissetSelectTypeMap(\Cake\Database\TypeMap $typeMap)
Sets the TypeMap class where the types for each of the fields in the select clause are stored.
\Cake\Database\TypeMap $typeMap The map object to use
$thissetTypeMap(mixed $typeMap)
Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
array|\Cake\Database\TypeMap $typeMap Creates a TypeMap if array, otherwise sets the given TypeMap
$thissetValueBinder(?\Cake\Database\ValueBinder $binder)
Overwrite the current value binder
A ValueBinder is responsible for generating query placeholders and temporarily associate values to those placeholders so that they can be passed correctly to the statement object.
\Cake\Database\ValueBinder|null $binder The binder or null to disable binding.
$thissql(?\Cake\Database\ValueBinder $generator)
Returns the SQL representation of this object.
This function will compile this query to make it compatible with the SQL dialect that is used by the connection, This process might add, remove or alter any query part or internal expression to make it executable in the target platform.
The resulting query may have placeholders that will be replaced with the actual values when the query is executed, hence it is most suitable to use with prepared statements.
\Cake\Database\ValueBinder|null $generator optional A placeholder object that will hold associated values for expressions
stringtraverse(mixed $visitor)
Will iterate over every specified part. Traversing functions can aggregate results using variables in the closure or instance variables. This function is commonly used as a way for traversing all query parts that are going to be used for constructing a query.
The callback will receive 2 parameters, the first one is the value of the query part that is being iterated and the second the name of such part.
$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
if ($clause === 'select') {
var_dump($value);
}
}); callable $visitor A function or callable to be executed for each part
$thistraverseExpressions(callable $callback)
This function works similar to the traverse() function, with the difference that it does a full depth traversal of the entire expression tree. This will execute the provided callback function for each ExpressionInterface object that is stored inside this query at any nesting depth in any part of the query.
Callback will receive as first parameter the currently visited expression.
callable $callback the function to be executed for each ExpressionInterface found inside this query.
$thistraverseParts(callable $visitor, array $parts)
Will iterate over the provided parts.
Traversing functions can aggregate results using variables in the closure or instance variables. This method can be used to traverse a subset of query parts in order to render a SQL query.
The callback will receive 2 parameters, the first one is the value of the query part that is being iterated and the second the name of such part.
$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
if ($clause === 'select') {
var_dump($value);
}
}, ['select', 'from']); callable $visitor A function or callable to be executed for each part
string[] $parts The list of query parts to traverse
$thistype()
Returns the type of this query (select, insert, update, delete)
stringunion(mixed $query, mixed $overwrite)
Adds a complete query to be used in conjunction with an UNION operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
By default, the UNION operator will remove duplicate rows, if you wish to include every row for all queries, use unionAll().
$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']); $query->select(['id', 'name'])->from(['d' => 'things'])->union($union);
Will produce:
SELECT id, name FROM things d UNION SELECT id, title FROM articles a
string|\Cake\Database\Query $query full SQL query to be used in UNION operator
bool $overwrite optional whether to reset the list of queries to be operated or not
$thisunionAll(mixed $query, mixed $overwrite)
Adds a complete query to be used in conjunction with the UNION ALL operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
Unlike UNION, UNION ALL will not remove duplicate rows.
$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']); $query->select(['id', 'name'])->from(['d' => 'things'])->unionAll($union);
Will produce:
SELECT id, name FROM things d UNION ALL SELECT id, title FROM articles a
string|\Cake\Database\Query $query full SQL query to be used in UNION operator
bool $overwrite optional whether to reset the list of queries to be operated or not
$thisupdate(mixed $table)
Create an update query.
Can be combined with set() and where() methods to create update queries.
string|\Cake\Database\ExpressionInterface $table The table you want to update.
$thisvalues(mixed $data)
Set the values for an insert query.
Multi inserts can be performed by calling values() more than one time, or by providing an array of value sets. Additionally $data can be a Query instance to insert data from another SELECT statement.
array|\Cake\Database\Query|\Cake\Database\Expression\ValuesExpression $data The data to insert.
$thisCake\Database\Exceptionwhere(mixed $conditions, array $types, bool $overwrite)
Adds a condition or set of conditions to be used in the WHERE clause for this query. Conditions can be expressed as an array of fields as keys with comparison operators in it, the values for the array will be used for comparing the field to such literal. Finally, conditions can be expressed as a single string or an array of strings.
When using arrays, each entry will be joined to the rest of the conditions using an AND operator. Consecutive calls to this function will also join the new conditions specified using the AND operator. Additionally, values can be expressed using expression objects which can include other query objects.
Any conditions created with this methods can be used with any SELECT, UPDATE and DELETE type of queries.
$query->where([
'posted >=' => new DateTime('3 days ago'),
'title LIKE' => 'Hello W%',
'author_id' => 1,
], ['posted' => 'datetime']); The previous example produces:
WHERE posted >= 2012-01-27 AND title LIKE 'Hello W%' AND author_id = 1
Second parameter is used to specify what type is expected for each passed key. Valid types can be used from the mapped with Database\Type class.
$query->where([
'author_id !=' => 1,
'OR' => ['published' => true, 'posted <' => new DateTime('now')],
'NOT' => ['title' => 'Hello']
], ['published' => boolean, 'posted' => 'datetime'] The previous example produces:
WHERE author_id = 1 AND (published = 1 OR posted < '2012-02-01') AND NOT (title = 'Hello')
You can nest conditions using conjunctions as much as you like. Sometimes, you may want to define 2 different options for the same key, in that case, you can wrap each condition inside a new array:
$query->where(['OR' => [['published' => false], ['published' => true]])
Would result in:
WHERE (published = false) OR (published = true)
Keep in mind that every time you call where() with the third param set to false (default), it will join the passed conditions to the previous stored list using the AND operator. Also, using the same array key twice in consecutive calls to this method will not override the previous value.
$exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR');
$query->where(['published' => true], ['published' => 'boolean'])->where($exp); The previous example produces:
WHERE (id != 100 OR author_id != 1) AND published = 1
Other Query objects that be used as conditions for any field.
You can use callable functions to construct complex expressions, functions receive as first argument a new QueryExpression object and this query instance as second argument. Functions must return an expression object, that will be added the list of conditions for the query using the AND operator.
$query
->where(['title !=' => 'Hello World'])
->where(function ($exp, $query) {
$or = $exp->or(['id' => 1]);
$and = $exp->and(['id >' => 2, 'id <' => 10]);
return $or->add($and);
}); WHERE title != 'Hello World' AND (id = 1 OR (id > 2 AND id < 10))
$query->where(['articles.author_id = authors.id', 'modified IS NULL']);
The previous example produces:
WHERE articles.author_id = authors.id AND modified IS NULL
Please note that when using the array notation or the expression objects, all values will be correctly quoted and transformed to the correspondent database data type automatically for you, thus securing your application from SQL injections. The keys however, are not treated as unsafe input, and should be validated/sanitized.
If you use string conditions make sure that your values are correctly quoted. The safest thing you can do is to never use string conditions.
string|array|\Cake\Database\ExpressionInterface|\Closure|null $conditions optional The conditions to filter on.
array $types optional associative array of type names used to bind values to query
bool $overwrite optional whether to reset conditions with passed list or not
$thiswhereInList(string $field, array $values, array $options)
Adds an IN condition or set of conditions to be used in the WHERE clause for this query.
This method does allow empty inputs in contrast to where() if you set 'allowEmpty' to true. Be careful about using it without proper sanity checks.
Options:
types - Associative array of type names used to bind values to queryallowEmpty - Allow empty array.string $field Field
array $values Array of values
array $options optional Options
$thiswhereNotInList(string $field, array $values, array $options)
Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query.
This method does allow empty inputs in contrast to where() if you set 'allowEmpty' to true. Be careful about using it without proper sanity checks.
string $field Field
array $values Array of values
array $options optional Options
$thiswhereNotNull(mixed $fields)
Convenience method that adds a NOT NULL condition to the query
array|string|\Cake\Database\ExpressionInterface $fields A single field or expressions or a list of them that should be not null.
$thiswhereNull(mixed $fields)
Convenience method that adds a IS NULL condition to the query
array|string|\Cake\Database\ExpressionInterface $fields A single field or expressions or a list of them that should be null.
$thiswindow(string $name, mixed $window, bool $overwrite)
Adds a named window expression.
You are responsible for adding windows in the order your database requires.
string $name Window name
\Cake\Database\Expression\WindowExpression|\Closure $window Window expression
bool $overwrite optional Clear all previous query window expressions
$thiswith(mixed $cte, bool $overwrite)
Adds a new common table expression (CTE) to the query.
Common table expressions can either be passed as preconstructed expression objects:
$cte = new \Cake\Database\Expression\CommonTableExpression(
'cte',
$connection
->newQuery()
->select('*')
->from('articles')
);
$query->with($cte); or returned from a closure, which will receive a new common table expression object as the first argument, and a new blank query object as the second argument:
$query->with(function (
\Cake\Database\Expression\CommonTableExpression $cte,
\Cake\Database\Query $query
) {
$cteQuery = $query
->select('*')
->from('articles');
return $cte
->name('cte')
->query($cteQuery);
}); \Closure|\Cake\Database\Expression\CommonTableExpression $cte The CTE to add.
bool $overwrite optional Whether to reset the list of CTEs.
$thisConnection instance to be used to execute this query.
\Cake\Database\ConnectionThe list of query clauses to traverse for generating a DELETE statement
string[]Indicates whether internal state of this query was changed, this is used to discard internal cached objects such as the transformed query or the reference to the executed statement.
boolInstance of functions builder object used for generating arbitrary SQL functions.
\Cake\Database\FunctionsBuilder|nullThe list of query clauses to traverse for generating an INSERT statement
string[]Statement object resulting from executing this query.
\Cake\Database\StatementInterface|nullList of SQL parts that will be used to build this query.
arrayA list of callback functions to be called to alter each row from resulting statement upon retrieval. Each one of the callback function will receive the row array as first argument.
callable[]The list of query clauses to traverse for generating a SELECT statement
string[]The Type map for fields in the select clause
\Cake\Database\TypeMapType of this query (select, insert, update, delete).
string\Cake\Database\TypeMapThe list of query clauses to traverse for generating an UPDATE statement
string[]Boolean for tracking whether or not buffered results are enabled.
boolThe object responsible for generating query placeholders and temporarily store values associated to each of those.
\Cake\Database\ValueBinder|nullTracking flag to disable casting
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Database.Query.html