Extends the base Query class to provide new methods related to association loading, automatic fields selection, automatic type casting and to wrap results into a specific iterator that will be responsible for hydrating results if required.
__call( mixed $method , mixed $arguments )
BadMethodCallException
__clone( )
Object clone hook.
Destroys the clones inner iterator and clones the value binder, and eagerloader instances.
Cake\Database\Query::__clone()
__construct( Cake\Database\Connection $connection , Cake\ORM\Table $table )
Constructor
Cake\Database\Connection
$connection
Cake\ORM\Table
$table
Cake\Database\Query::__construct()
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
array
Cake\Database\Query::__debugInfo()
_addAssociationsToTypeMap( Cake\ORM\Table $table , Cake\Database\TypeMap $typeMap , array $associations )
Used to recursively add contained association column types to the query.
Cake\ORM\Table
$table
Cake\Database\TypeMap
$typeMap
$associations
_addDefaultFields( )
Inspects if there are any set fields for selecting, otherwise adds all the fields for the default table.
_decorateResults( Traversable $result )
Decorates the results iterator with MapReduce routines and formatters
$result
Cake\Datasource\ResultSetInterface
_dirty( )
Marks a query as dirty, removing any preprocessed information from in memory caching such as previous results
Cake\Database\Query::_dirty()
_execute( )
Executes this query and returns a ResultSet object containing the results. This will also setup the correct statement class in order to eager load deep associations.
Cake\ORM\ResultSet
_performCount( )
Performs and returns the COUNT(*) for the query.
integer
_transformQuery( )
Applies some defaults to the query object before it is executed.
Specifically add the FROM clause, adds default table fields if none are specified and applies the joins required to eager load associations defined using contain
Cake\Database\Query::execute()
addDefaultTypes( Cake\ORM\Table $table )
Hints this object to associate the correct types when casting conditions for the database. This is done by extracting the field types from the schema associated to the passed table object. This prevents the user from repeating himself when specifying conditions.
This method returns the same query object for chaining.
Cake\ORM\Table
$table
mixed
all( )
Fetch the results for this query.
Cake\Datasource\ResultSetInterface
RuntimeException
Cake\Datasource\QueryInterface::all()
applyOptions( array $options )
Populates or adds parts to current query clauses using an array. This is handy for passing all query clauses at once. The option array accepts:
Populates or adds parts to current query clauses using an array. This is handy for passing all query clauses at once. The option array accepts:
$query->applyOptions([ 'fields' => ['id', 'name'], 'conditions' => [ 'created >=' => '2013-01-01' ], 'limit' => 10 ]);
Is equivalent to:
$query ->select(['id', 'name']) ->where(['created >=' => '2013-01-01']) ->limit(10)
$options
mixed
Cake\Datasource\QueryInterface::applyOptions()
autoFields( boolean|null $value null )
Get/Set whether or not the ORM should automatically append fields.
By default calling select() will disable auto-fields. You can re-enable auto-fields with this method.
$value
optional null boolean|$this
cache( mixed $key , mixed $config 'default' )
mixed
RuntimeException
cleanCopy( )
Creates a copy of this current query, triggers beforeFind and resets some state.
The following state will be cleared:
This method creates query clones that are useful when working with subqueries.
Cake\ORM\Query
contain( array|string $associations null , boolean $override false )
Sets the list of associations that should be eagerly loaded along with this query. The list of associated tables passed must have been previously set as associations using the Table API.
// Bring articles' author information $query->contain('Author'); // Also bring the category and tags associated to each article $query->contain(['Category', 'Tag']);
Associations can be arbitrarily nested using dot notation or nested arrays, this allows this object to calculate joins or any additional queries that must be executed to bring the required associated data.
// Eager load the product info, and for each product load other 2 associations $query->contain(['Product' => ['Manufacturer', 'Distributor']); // Which is equivalent to calling $query->contain(['Products.Manufactures', 'Products.Distributors']); // For an author query, load his region, state and country $query->contain('Regions.States.Countries');
It is possible to control the conditions and fields selected for each of the contained associations:
$query->contain(['Tags' => function ($q) { return $q->where(['Tags.is_popular' => true]); }]); $query->contain(['Products.Manufactures' => function ($q) { return $q->select(['name'])->where(['Manufactures.active' => true]); }]);
Each association might define special options when eager loaded, the allowed options that can be set per association are:
false
can only be used on joinable associations and cannot be used with hasMany or belongsToMany associations.// Set options for the hasMany articles that will be eagerly loaded for an author $query->contain([ 'Articles' => [ 'fields' => ['title', 'author_id'] ] ]);
When containing associations, it is important to include foreign key columns. Failing to do so will trigger exceptions.
// Use special join conditions for getting an Articles's belongsTo 'authors' $query->contain([ 'Authors' => [ 'foreignKey' => false, 'queryBuilder' => function ($q) { return $q->where(...); // Add full filtering conditions } ] ]);
If called with no arguments, this function will return an array with with the list of previously configured associations to be contained in the result.
If called with an empty first argument and $override is set to true, the previous list will be emptied.
$associations
optional null $override
optional false array|$this
count( )
Returns the total amount of results for the query.
Returns the COUNT(*) for the query. If the query has not been modified, and the count has already been performed the cached value is returned
integer
Cake\Datasource\QueryInterface::count()
counter( callable|null $counter )
Registers a callable function that will be executed when the count
method in this query is called. The return value for the function will be set as the return value of the count
method.
This is particularly useful when you need to optimize a query for returning the count, for example removing unnecessary joins, removing group by or just return an estimated number of rows.
The callback will receive as first argument a clone of this query and not this query itself.
If the first param is a null value, the built-in counter function will be called instead
$counter
mixed
delete( string|null $table null )
Create a delete query.
This changes the query type to be 'delete'. Can be combined with the where() method to create delete queries.
$table
optional null mixed
Cake\Database\Query::delete()
eagerLoader( Cake\ORM\EagerLoader $instance null )
Sets the instance of the eager loader class to use for loading associations and storing containments. If called with no arguments, it will return the currently configured instance.
Cake\ORM\EagerLoader
$instance
optional null Cake\ORM\EagerLoader|$this
find( string $finder , array $options [] )
Apply custom finds to against an existing query object.
$finder
$options
optional [] mixed
Cake\ORM\Table::find()
Cake\Datasource\QueryInterface::find()
hydrate( boolean|null $enable null )
Toggle hydrating entities.
If set to false array results will be returned
$enable
optional null boolean|$this
innerJoinWith( string $assoc , callable $builder null )
Creates an INNER JOIN with the passed association table while preserving the foreign key matching and the custom conditions that were originally set for it.
This function will add entries in the contain
graph.
// Bring only articles that were tagged with 'cake' $query->innerJoinWith('Tags', function ($q) { return $q->where(['name' => 'cake']); );
This will create the following SQL:
SELECT Articles.* FROM articles Articles INNER JOIN tags Tags ON Tags.name = 'cake' INNER JOIN articles_tags ArticlesTags ON ArticlesTags.tag_id = Tags.id AND ArticlesTags.articles_id = Articles.id
This function works the same as matching()
with the difference that it will select no fields from the association.
$assoc
$builder
optional null mixed
Cake\ORM\Query::matching()
insert( array $columns , array $types [] )
Create an insert query.
This changes the query type to be 'insert'. Note calling this method will reset any data previously set with Query::values()
Can be combined with the where() method to create delete queries.
$columns
$types
optional [] mixed
RuntimeException
Cake\Database\Query::insert()
jsonSerialize( )
Executes the query and converts the result set into JSON.
Part of JsonSerializable interface.
Cake\Datasource\ResultSetInterface
JsonSerializable::jsonSerialize()
leftJoinWith( string $assoc , callable $builder null )
Creates a LEFT JOIN with the passed association table while preserving the foreign key matching and the custom conditions that were originally set for it.
This function will add entries in the contain
graph.
// Get the count of articles per user $usersQuery ->select(['total_articles' => $query->func()->count('Articles.id')]) ->leftJoinWith('Articles') ->group(['Users.id']) ->autoFields(true);
You can also customize the conditions passed to the LEFT JOIN:
// Get the count of articles per user with at least 5 votes $usersQuery ->select(['total_articles' => $query->func()->count('Articles.id')]) ->leftJoinWith('Articles', function ($q) { return $q->where(['Articles.votes >=' => 5]); }) ->group(['Users.id']) ->autoFields(true);
This will create the following SQL:
SELECT COUNT(Articles.id) AS total_articles, Users.* FROM users Users LEFT JOIN articles Articles ON Articles.user_id = Users.id AND Articles.votes >= 5 GROUP BY USers.id
It is possible to left join deep associations by using dot notation
// Total comments in articles by 'markstory' $query ->select(['total_comments' => $query->func()->count('Comments.id')]) ->leftJoinWith('Comments.Users', function ($q) { return $q->where(['username' => 'markstory']); ) ->group(['Users.id']);
Please note that the query passed to the closure will only accept calling select
, where
, andWhere
and orWhere
on it. If you wish to add more complex clauses you can do it directly in the main query.
$assoc
$builder
optional null mixed
matching( string $assoc , callable $builder null )
Adds filtering conditions to this query to only bring rows that have a relation to another from an associated table, based on conditions in the associated table.
This function will add entries in the contain
graph.
// Bring only articles that were tagged with 'cake' $query->matching('Tags', function ($q) { return $q->where(['name' => 'cake']); );
It is possible to filter by deep associations by using dot notation:
// Bring only articles that were commented by 'markstory' $query->matching('Comments.Users', function ($q) { return $q->where(['username' => 'markstory']); );
As this function will create INNER JOIN
, you might want to consider calling distinct
on this query as you might get duplicate rows if your conditions don't filter them already. This might be the case, for example, of the same user commenting more than once in the same article.
// Bring unique articles that were commented by 'markstory' $query->distinct(['Articles.id']) ->matching('Comments.Users', function ($q) { return $q->where(['username' => 'markstory']); );
Please note that the query passed to the closure will only accept calling select
, where
, andWhere
and orWhere
on it. If you wish to add more complex clauses you can do it directly in the main query.
$assoc
$builder
optional null mixed
notMatching( string $assoc , callable $builder null )
Adds filtering conditions to this query to only bring rows that have no match to another from an associated table, based on conditions in the associated table.
This function will add entries in the contain
graph.
// Bring only articles that were not tagged with 'cake' $query->notMatching('Tags', function ($q) { return $q->where(['name' => 'cake']); );
It is possible to filter by deep associations by using dot notation:
// Bring only articles that weren't commented by 'markstory' $query->notMatching('Comments.Users', function ($q) { return $q->where(['username' => 'markstory']); );
As this function will create a LEFT JOIN
, you might want to consider calling distinct
on this query as you might get duplicate rows if your conditions don't filter them already. This might be the case, for example, of the same article having multiple comments.
// Bring unique articles that were commented by 'markstory' $query->distinct(['Articles.id']) ->notMatching('Comments.Users', function ($q) { return $q->where(['username' => 'markstory']); );
Please note that the query passed to the closure will only accept calling select
, where
, andWhere
and orWhere
on it. If you wish to add more complex clauses you can do it directly in the main query.
$assoc
$builder
optional null mixed
select( array|Cake\Database\ExpressionInterface|string|Cake\ORM\Table|Cake\ORM\Association $fields [] , boolean $overwrite false )
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 you pass an instance of a Cake\ORM\Table
or Cake\ORM\Association
class, all the fields in the schema of the table or the association will be added to the select clause.
Cake\Database\ExpressionInterface
|string|Cake\ORM\Table
|Cake\ORM\Association
$fields
optional [] $overwrite
optional false mixed
Cake\Database\Query::select()
sql( Cake\Database\ValueBinder $binder null )
Returns the SQL representation of this object.
$binder
optional null string
Cake\Database\Query::sql()
triggerBeforeFind( )
Trigger the beforeFind event on the query's repository object.
Will not trigger more than once, and only for select queries.
update( string|null $table null )
Create an update query.
This changes the query type to be 'update'. Can be combined with set() and where() methods to create update queries.
$table
optional null mixed
Cake\Database\Query::update()
__toString( )
Returns string representation of this query (complete SQL statement).
string
_conjugate( string $part , string|null|array|Cake\Database\ExpressionInterface|callable $append , string $conjunction , array $types )
Helper function used to build conditions by composing QueryExpression objects.
$part
Cake\Database\ExpressionInterface
|callable $append
$conjunction
$types
_decorateStatement( Cake\Database\StatementInterface $statement )
Auxiliary function used to wrap the original statement from the driver with any registered callbacks.
Cake\Database\StatementInterface
$statement
Cake\Database\Statement\CallbackStatement
_makeJoin( string|array $table , string|array|Cake\Database\ExpressionInterface $conditions , string $type )
Returns an array that can be passed to the join method describing a single join clause
$table
Cake\Database\ExpressionInterface
$conditions
$type
array
andHaving( string|array|Cake\Database\ExpressionInterface|callable $conditions , array $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.
Cake\Database\ExpressionInterface
|callable $conditions
$types
optional [] mixed
Cake\Database\Query::andWhere()
andWhere( string|array|Cake\Database\ExpressionInterface|callable $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 ->add(['author_id' => 1]) ->or_(['author_id' => 2]); });
Generates the following conditions:
WHERE (title = 'Foo') AND (author_id = 1 OR author_id = 2)
Cake\Database\ExpressionInterface
|callable $conditions
$types
optional [] mixed
Cake\Database\Query::where()
Cake\Database\Type
bind( string|integer $param , mixed $value , string|integer $type 'string' )
Associates a query placeholder to a value and a type.
If type is expressed as "atype[]" (note braces) then it will cause the placeholder to be re-written dynamically so if the value is an array, it will create as many placeholders as values are in it. For example "string[]" will create several placeholders of type string.
$param
$value
$type
optional 'string' mixed
bufferResults( boolean|null $enable null )
Enable/Disable 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.
If called with no arguments, it will return whether or not buffering is enabled.
$enable
optional null boolean|$this
clause( 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.
$name
mixed
connection( Cake\Datasource\ConnectionInterface $connection null )
Sets the connection instance to be used for executing and transforming this query When called with a null argument, it will return the current connection instance.
Cake\Datasource\ConnectionInterface
$connection
optional null mixed
decorateResults( null|callable $callback , boolean $overwrite false )
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; });
$callback
$overwrite
optional false mixed
distinct( array|Cake\Database\ExpressionInterface|string|boolean $on [] , boolean $overwrite false )
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);
Cake\Database\ExpressionInterface
|string|boolean $on
optional [] $overwrite
optional false mixed
epilog( string|Cake\Database\Expression\QueryExpression $expression null )
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');
Cake\Database\Expression\QueryExpression
$expression
optional null mixed
execute( )
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\StatementInterface
from( array|Cake\Database\ExpressionInterface|string $tables [] , boolean $overwrite false )
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
Cake\Database\ExpressionInterface
|string $tables
optional [] $overwrite
optional false mixed
func( )
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\FunctionsBuilder
getIterator( )
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.
Iterator
IteratorAggregate::getIterator()
group( array|Cake\Database\ExpressionInterface|string $fields , boolean $overwrite false )
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');
Cake\Database\ExpressionInterface
|string $fields
$overwrite
optional false mixed
having( string|array|Cake\Database\ExpressionInterface|callable $conditions null , array $types [] , boolean $overwrite false )
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.
Cake\Database\ExpressionInterface
|callable $conditions
optional null $types
optional [] $overwrite
optional false mixed
Cake\Database\Query::where()
innerJoin( string|array $table , string|array|Cake\Database\ExpressionInterface $conditions [] , array $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.
$table
Cake\Database\ExpressionInterface
$conditions
optional [] $types
optional [] mixed
into( string $table )
Set the table name for insert queries.
$table
mixed
join( array|string|null $tables null , array $types [] , boolean $overwrite false )
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
$tables
optional null $types
optional [] $overwrite
optional false mixed
Cake\Database\Type
leftJoin( string|array $table , string|array|Cake\Database\ExpressionInterface $conditions [] , array $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.
$table
Cake\Database\ExpressionInterface
$conditions
optional [] $types
optional [] mixed
limit( integer|Cake\Database\ExpressionInterface $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)
Cake\Database\ExpressionInterface
$num
mixed
modifier( array|Cake\Database\ExpressionInterface|string $modifiers , boolean $overwrite false )
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
Cake\Database\ExpressionInterface
|string $modifiers
$overwrite
optional false mixed
newExpr( mixed $rawExpression null )
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
$rawExpression
optional null Cake\Database\Expression\QueryExpression
offset( integer|Cake\Database\ExpressionInterface $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)
Cake\Database\ExpressionInterface
$num
mixed
orHaving( string|array|Cake\Database\ExpressionInterface|callable $conditions , array $types [] )
Connects any previously defined set of conditions to the provided list using the OR operator in the HAVING clause. This method operates in exactly the same way as the method orWhere()
does. Please refer to its documentation for an insight on how to using each parameter.
Cake\Database\ExpressionInterface
|callable $conditions
$types
optional [] mixed
Cake\Database\Query::orWhere()
orWhere( string|array|Cake\Database\ExpressionInterface|callable $conditions , array $types [] )
Connects any previously defined set of conditions to the provided list using the OR 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 OR 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 OR operator, unless you nest the conditions in the array using other operator.
$query->where(['title' => 'Hello World')->orWhere(['title' => 'Foo']);
Will produce:
WHERE title = 'Hello World' OR title = 'Foo'
$query ->where(['OR' => ['published' => false, 'published is NULL']]) ->orWhere(['author_id' => 1, 'comments_count >' => 10])
Produces:
WHERE (published = 0 OR published IS NULL) OR (author_id = 1 AND comments_count > 10)
$query ->where(['title' => 'Foo']) ->orWhere(function ($exp, $query) { return $exp ->add(['author_id' => 1]) ->or_(['author_id' => 2]); });
Generates the following conditions:
WHERE (title = 'Foo') OR (author_id = 1 OR author_id = 2)
Cake\Database\ExpressionInterface
|callable $conditions
$types
optional [] mixed
Cake\Database\Query::where()
Cake\Database\Type
order( array|Cake\Database\ExpressionInterface|string $fields , boolean $overwrite false )
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']);
Will become:
ORDER BY (id %2 = 0), title ASC
If you need to set complex expressions as order conditions, you should use orderAsc()
or orderDesc()
.
Cake\Database\ExpressionInterface
|string $fields
$overwrite
optional false mixed
orderAsc( string|Cake\Database\Expression\QueryExpression $field , boolean $overwrite false )
Add an ORDER BY clause with an ASC direction.
This method allows you to set complex expressions as order conditions unlike order()
Cake\Database\Expression\QueryExpression
$field
$overwrite
optional false mixed
orderDesc( string|Cake\Database\Expression\QueryExpression $field , boolean $overwrite false )
Add an ORDER BY clause with an ASC direction.
This method allows you to set complex expressions as order conditions unlike order()
Cake\Database\Expression\QueryExpression
$field
$overwrite
optional false mixed
page( integer $num , integer $limit null )
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 should start at 1.
$num
$limit
optional null mixed
removeJoin( string $name )
Remove a join if it has been defined.
Useful when you are redefining joins or want to re-order the join clauses.
$name
mixed
rightJoin( string|array $table , string|array|Cake\Database\ExpressionInterface $conditions [] , array $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.
$table
Cake\Database\ExpressionInterface
$conditions
optional [] $types
optional [] mixed
set( string|array|callable|Cake\Database\Expression\QueryExpression $key , mixed $value null , array $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'); });
Cake\Database\Expression\QueryExpression
$key
$value
optional null $types
optional [] mixed
traverse( callable $visitor , array $parts [] )
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); } }, ['select', 'from']);
$visitor
$parts
optional [] mixed
Cake\Database\ExpressionInterface::traverse()
traverseExpressions( 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.
$callback
mixed
type( )
Returns the type of this query (select, insert, update, delete)
string
union( string|Cake\Database\Query $query , boolean $overwrite false )
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
Cake\Database\Query
$query
$overwrite
optional false mixed
unionAll( string|Cake\Database\Query $query , boolean $overwrite false )
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
Cake\Database\Query
$query
$overwrite
optional false mixed
valueBinder( Cake\Database\ValueBinder $binder null )
Returns the currently used ValueBinder instance. If a value is passed, it will be set as the new instance to be used.
A ValueBinder is responsible for generating query placeholders and temporarily associate values to those placeholders so that they can be passed correctly statement object.
$binder
optional null mixed
values( array|Cake\Database\Query $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.
Cake\Database\Query
$data
mixed
Cake\Database\Exception
where( string|array|Cake\Database\ExpressionInterface|callable|null $conditions null , array $types [] , boolean $overwrite false )
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]])
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])->type('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. 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.
Cake\Database\ExpressionInterface
|callable|null $conditions
optional null $types
optional [] $overwrite
optional false mixed
Cake\Database\Type
Cake\Database\Expression\QueryExpression
_decoratorClass( )
Returns the name of the class to be used for decorating results
string
aliasField( string $field , string $alias null )
Returns a key => value array representing a single aliased field that can be passed directly to the select() method. The key will contain the alias and the value the actual field name.
If the field is already aliased, then it will not be changed. If no $alias is passed, the default table for this query will be used.
$field
$alias
optional null array
Cake\Datasource\QueryInterface::aliasField()
aliasFields( array $fields , string|null $defaultAlias null )
Runs aliasField()
for each field in the provided list and returns the result under a single array.
$fields
$defaultAlias
optional null array
Cake\Datasource\QueryInterface::aliasFields()
eagerLoaded( boolean|null $value null )
Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query _eagerLoaded
value is returned.
$value
optional null mixed
first( )
Returns the first result out of executing this query, if the query has not been executed before, it will set the limit clause to 1 for performance reasons.
$singleUser = $query->select(['id', 'username'])->first();
mixed
Cake\Datasource\QueryInterface::first()
firstOrFail( )
Get the first result from the executing query or raise an exception.
mixed
Cake\Datasource\Exception\RecordNotFoundException
formatResults( callable $formatter null , boolean|integer $mode 0 )
Registers a new formatter callback function that is to be executed when trying to fetch the results from the database.
Formatting callbacks will get a first parameter, a ResultSetDecorator
, that can be traversed and modified at will.
Callbacks are required to return an iterator object, which will be used as the return value for this query's result. Formatter functions are applied after all the MapReduce
routines for this query have been executed.
If the first argument is set to null, it will return the list of previously registered map reduce routines.
If the second argument is set to true, it will erase previous formatters and replace them with the passed first argument.
// Return all results from the table indexed by id $query->select(['id', 'name'])->formatResults(function ($results) { return $results->indexBy('id'); }); // Add a new column to the ResultSet $query->select(['name', 'birth_date'])->formatResults(function ($results) { return $results->map(function ($row) { $row['age'] = $row['birth_date']->diff(new DateTime)->y; return $row; }); });
$formatter
optional null $mode
optional 0 mixed
getIterator( )
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.
Iterator
Cake\Database\Query::getIterator()
getOptions( )
Returns an array with the custom options that were applied to this query and that were not already processed by another method in this class.
$query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']); $query->getOptions(); // Returns ['doABarrelRoll' => true]
array
mapReduce( callable $mapper null , callable $reducer null , boolean $overwrite false )
Register a new MapReduce routine to be executed on top of the database results Both the mapper and caller callable should be invokable objects.
The MapReduce routing will only be run when the query is executed and the first result is attempted to be fetched.
If the first argument is set to null, it will return the list of previously registered map reduce routines.
If the third argument is set to true, it will erase previous map reducers and replace it with the arguments passed.
$mapper
optional null $reducer
optional null $overwrite
optional false mixed
repository( Cake\Datasource\RepositoryInterface $table null )
Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.
When called with a Table argument, the default table object will be set and this query object will be returned for chaining.
Cake\Datasource\RepositoryInterface
$table
optional null Cake\Datasource\RepositoryInterface|$this
Cake\Datasource\QueryInterface::repository()
setResult( Cake\Datasource\ResultSetInterface $results )
Set the result set for a query.
Setting the resultset of a query will make execute() a no-op. Instead of executing the SQL query and fetching results, the ResultSet provided to this method will be returned.
This method is most useful when combined with results stored in a persistent cache.
Cake\Datasource\ResultSetInterface
$results
mixed
toArray( )
Returns an array representation of the results after executing the query.
array
Cake\Datasource\QueryInterface::toArray()
defaultTypes( array $types null )
Allows setting default types when chaining query
$types
optional null mixed
typeMap( array|Cake\Database\TypeMap $typeMap null )
Creates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
Cake\Database\TypeMap
$typeMap
optional null mixed
integer | APPEND Indicates that the operation should append to the list | 0 |
boolean | OVERWRITE Indicates that the operation should overwrite the list | true |
integer | PREPEND Indicates that the operation should prepend to the list | 1 |
protected Cake\Datasource\ConnectionInterface
Connection instance to be used to execute this query.
protected boolean
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.
false
protected Cake\Database\FunctionsBuilder
Instance of functions builder object used for generating arbitrary SQL functions.
protected Cake\Database\StatementInterface
Statement object resulting from executing this query.
protected array
List of SQL parts that will be used to build this query.
[ 'delete' => true, 'update' => [], 'set' => [], 'insert' => [], 'values' => [], 'select' => [], 'distinct' => false, 'modifier' => [], 'from' => [], 'join' => [], 'where' => null, 'group' => [], 'having' => null, 'order' => null, 'limit' => null, 'offset' => null, 'union' => [], 'epilog' => null ]
protected array
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.
[]
protected boolean
Boolean for tracking whether or not buffered results are enabled.
true
protected ValueBinder
The object responsible for generating query placeholders and temporarily store values associated to each of those.
protected Cake\Database\TypeMap
protected Cake\Datasource\QueryCacher
A query cacher instance if this query has caching enabled.
protected boolean
Whether the query is standalone or the product of an eager load operation.
false
protected array
List of formatter classes or callbacks that will post-process the results when fetched
[]
protected array
List of map-reduce routines that should be applied over the query result
[]
protected array
Holds any custom options passed using applyOptions that could not be processed by any method in this class.
[]
protected Cake\Datasource\RepositoryInterface
Instance of a table object this query is bound to
protected Cake\Datasource\ResultSetInterface
A ResultSet.
When set, query execution will be bypassed.
Cake\Datasource\QueryTrait::setResult()
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.ORM.Query.html