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.
int 0 string 'INNER' string 'LEFT' string 'RIGHT' bool true int 1 bool|nullTracks whether or not the original query should include fields from the top level table.
boolTrue if the beforeFind event has already been triggered for this query
\Cake\Datasource\QueryCacher|nullA query cacher instance if this query has caching enabled.
\Cake\Database\ConnectionConnection instance to be used to execute this query.
callable|nullA callable function that can be used to calculate the total amount of records this query will match when not using limit
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.
boolWhether the query is standalone or the product of an eager load operation.
\Cake\ORM\EagerLoader|nullInstance of a class responsible for storing association containments and for eager loading them when this query is executed
callable[]List of formatter classes or callbacks that will post-process the results when fetched
\Cake\Database\FunctionsBuilder|nullInstance of functions builder object used for generating arbitrary SQL functions.
bool|nullWhether the user select any fields before being executed, this is used to determined if any fields should be automatically be selected.
boolWhether to hydrate results into entity objects
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 map-reduce routines that should be applied over the query result
arrayHolds any custom options passed using applyOptions that could not be processed by any method in this class.
arrayList of SQL parts that will be used to build this query.
\Cake\ORM\TableInstance of a table object this query is bound to.
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.
iterable|nullA ResultSet.
int|nullThe COUNT(*) for the query.
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.
Used to recursively add contained association column types to the query.
Inspects if there are any set fields for selecting, otherwise adds all the fields for the default table.
Sets the default types for converting the fields in the select clause
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 such as previous results
Returns an array that can be passed to the join method describing a single join clause
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 themselves when specifying conditions.
Returns a key => value array representing a single aliased field that can be passed directly to the select() method.
Runs aliasField() for each field in the provided list and returns the result under a single array.
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. {@see \Cake\Database\Query::andWhere()}
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.
Clears the internal result cache and the internal count value from the current query object.
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.
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.
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
Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query _eagerLoaded value is returned.
Compiles the SQL representation of this query and executes it using the configured connection object. Returns the resulting statement object.
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.
Registers a new formatter callback function that is to be executed when trying to fetch the results from the database.
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.
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.
Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.
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.
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.
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.
Sets the number of records that should be retrieved from database, accepts an integer or an expression object that evaluates to an integer.
Register a new MapReduce routine to be executed on top of the database results Both the mapper and caller callable should be invokable objects.
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.
Creates a tree structure by nesting the values of column $p into that with the same value for $k using $n as the nesting key.
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.
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.
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.
Set the default Table object that will be used by this query and form the FROM clause.
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.
All the fields associated with the passed table except the excluded fields will be added to the select clause of the query. Passed excluded fields should not be aliased.
Sets the connection instance to be used for executing and transforming this query.
Sets the instance of the eager loader class to use for loading associations and storing containments.
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.
Returns the first result of both the query and $c in an array, then the second results and so on.
Returns each of the results out of calling $c with the first rows of the query and each of the items, then the second rows and so on.
__call(string $method, array $arguments)
Enables calling methods from the result set as if they were from this class
string $method the method to call
array $arguments list of arguments for the method to call
mixedBadMethodCallExceptionBadMethodCallException__clone()
Handles clearing iterator and cloning all expressions and value binders.
__construct(\Cake\Database\Connection $connection, \Cake\ORM\Table $table)
Constructor
\Cake\Database\Connection $connection The connection object
\Cake\ORM\Table $table The table this query is starting on
__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_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 The table instance to pluck associations from.
\Cake\Database\TypeMap $typeMap The typemap to check for columns in. This typemap is indirectly mutated via Cake\ORM\Query::addDefaultTypes()
array $associations The nested tree of associations to walk.
_addDefaultFields()
Inspects if there are any set fields for selecting, otherwise adds all the fields for the default table.
_addDefaultSelectTypes()
Sets the default types for converting the fields in the select clause
_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
_decorateResults(\Traversable $result)
Decorates the results iterator with MapReduce routines and formatters
\Traversable $result Original results
\Cake\Datasource\ResultSetInterface_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_decoratorClass()
Returns the name of the class to be used for decorating results
string_dirty()
Marks a query as dirty, removing any preprocessed information from in memory caching such as previous results
_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\Datasource\ResultSetInterface_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
array_performCount()
Performs and returns the COUNT(*) for the query.
int_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
It also sets the default types for the columns in the select clause
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 themselves when specifying conditions.
This method returns the same query object for chaining.
\Cake\ORM\Table $table The table to pull types from
$thisaliasField(string $field, ?string $alias)
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.
string $field The field to alias
string|null $alias optional the alias used to prefix the field
arrayaliasFields(array $fields, ?string $defaultAlias)
Runs aliasField() for each field in the provided list and returns the result under a single array.
array $fields The fields to alias
string|null $defaultAlias optional The default alias
string[]all()
Fetch the results for this query.
Will return either the results set through setResult(), or execute this query and return the ResultSetDecorator object ready for streaming of results.
ResultSetDecorator is a traversable object that implements the methods found on Cake\Collection\Collection.
\Cake\Datasource\ResultSetInterfaceRuntimeExceptionandHaving(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. {@see \Cake\Database\Query::andWhere()}
mixed $conditions array $types = [] append(array|\Traversable $items)
Appends more rows to the result of the query.
array|\Traversable $items 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:
$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)
array $options the options to be applied
$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
$thiscache(mixed $key, mixed $config)
Enable result caching for this query.
If a query has caching enabled, it will do the following when executed:
// Simple string key + config
$query->cache('my_key', 'db_results');
// Function to generate key.
$query->cache(function ($q) {
$key = serialize($q->clause('select'));
$key .= serialize($q->clause('where'));
return md5($key);
});
// Using a pre-built cache engine.
$query->cache('my_key', $engine);
// Disable caching
$query->cache(false); \Closure|string|false $key Either the cache key or a function to generate the cache key. When using a function, this query instance will be supplied as an argument.
string|\Cake\Cache\CacheEngine $config optional Either the name of the cache config to use, or a cache config instance.
$thisRuntimeExceptionchunk(int $size)
Groups the results in arrays of $size rows each.
int $size 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.
string $name name of the clause to be returned
mixedInvalidArgumentExceptioncleanCopy()
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.
staticclearContain()
Clears the contained associations from the current query.
$thisclearResult()
Clears the internal result cache and the internal count value from the current query object.
$thiscombine(mixed $k, mixed $v, mixed $g)
Returns the values of the column $v index by column $k, and grouped by $g.
mixed $k mixed $v mixed $g contain(mixed $associations, mixed $override)
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:
foreignKey: Used to set a different field to match both tables, if set to false no join conditions will be generated automatically. false can only be used on joinable associations and cannot be used with hasMany or belongsToMany associations.fields: An array with the fields that should be fetched from the association.finder: The finder to use when loading associated records. Either the name of the finder as a string, or an array to define options to pass to the finder.queryBuilder: Equivalent to passing a callable instead of an options array.// Set options for the hasMany articles that will be eagerly loaded for an author
$query->contain([
'Articles' => [
'fields' => ['title', 'author_id']
]
]); Finders can be configured to use options.
// Retrieve translations for the articles, but only those for the `en` and `es` locales
$query->contain([
'Articles' => [
'finder' => [
'translations' => [
'locales' => ['en', 'es']
]
]
]
]); When containing associations, it is important to include foreign key columns. Failing to do so will trigger exceptions.
// Use a query builder to add conditions to the containment
$query->contain('Authors', function ($q) {
return $q->where(...); // add conditions
});
// Use special join conditions for multiple containments in the same method call
$query->contain([
'Authors' => [
'foreignKey' => false,
'queryBuilder' => function ($q) {
return $q->where(...); // Add full filtering conditions
}
],
'Tags' => function ($q) {
return $q->where(...); // add conditions
}
]); If called with an empty first argument and $override is set to true, the previous list will be emptied.
array|string $associations List of table aliases to be queried.
callable|bool $override optional The query builder for the association, or if associations is an array, a bool on whether to override previous list with the one passed defaults to merging previous list with the new one.
$thiscount()
Returns the total amount of results for the query.
intcountBy(string|callable $field)
Returns the number of unique values for a column
string|callable $field counter(?callable $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
callable|null $counter The counter value
$thisdecorateResults(?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.
This changes the query type to be 'delete'. Can be combined with the where() method to create delete queries.
string|null $table optional Unused parameter.
$thisdisableAutoFields()
Disables automatically appending fields.
$thisdisableBufferedResults()
Disables buffered results.
Disabling buffering will consume less memory as fetched results are not remembered for future iterations.
$thisdisableHydration()
Disable hydrating entities.
Disabling hydration will cause array results to be returned for the query instead of entities.
$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
$thiseach(callable $c)
Passes each of the query results to the callable
callable $c eagerLoaded(bool $value)
Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query _eagerLoaded value is returned.
bool $value Whether or not to eager load.
$thisenableAutoFields(bool $value)
Sets 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.
bool $value optional Set true to enable, false to disable.
$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
$thisenableHydration(bool $enable)
Toggle hydrating entities.
If set to false array results will be returned for the query.
bool $enable optional Use a boolean to set the hydration mode.
$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
$thisevery(callable $c)
Returns true if all the results pass the callable test
callable $c 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\StatementInterfaceextract(mixed $field)
Extracts a single column from each row
mixed $field filter(callable $c = null)
Keeps the results using passing the callable test
callable $c = null find(string $finder, array $options)
Apply custom finds to against an existing query object.
Allows custom find methods to be combined and applied to each other.
$repository->find('all')->find('recent'); The above is an example of stacking multiple finder methods onto a single query.
string $finder The finder method to use.
array $options optional The options for the finder.
staticReturns a modified query.
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();
\Cake\Datasource\EntityInterface|array|nullThe first result from the ResultSet.
firstOrFail()
Get the first result from the executing query or raise an exception.
\Cake\Datasource\EntityInterface|arrayThe first result from the ResultSet.
Cake\Datasource\Exception\RecordNotFoundExceptionformatResults(?callable $formatter, mixed $mode)
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, an object implementing \Cake\Collection\CollectionInterface, 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 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;
});
}); callable|null $formatter optional The formatting callable.
int|true $mode optional Whether or not to overwrite, append or prepend the formatter.
$thisInvalidArgumentExceptionfrom(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\ConnectiongetContain()
arraygetDefaultTypes()
Gets default types of current type map.
arraygetEagerLoader()
Returns the currently configured instance.
\Cake\ORM\EagerLoadergetIterator()
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\Datasource\ResultSetInterfacegetMapReducers()
Returns the list of previously registered map reduce routines.
arraygetOptions()
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]
arraygetRepository()
Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.
getResultFormatters()
Returns the list of previously registered format routines.
callable[]getSelectTypeMap()
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
$thisgroupBy(string|callable $field)
In-memory group all results by the value of a column.
string|callable $field having(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\ExpressionInterfaceindexBy(string|callable $callback)
Returns the results indexed by the value of a column.
string|callable $callback innerJoin(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.
$thisinnerJoinWith(string $assoc, ?callable $builder)
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.
string $assoc The association to join with
callable|null $builder optional a function that will receive a pre-made query object that can be used to add custom conditions or selecting some fields
$thisinsert(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.
array $columns The columns to insert into.
array $types optional A map between columns & their datatypes.
$thisinto(string $table)
Set the table name for insert queries.
string $table The table name to insert into.
$thisisAutoFieldsEnabled()
Gets whether or not the ORM should automatically append fields.
By default calling select() will disable auto-fields. You can re-enable auto-fields with enableAutoFields().
bool|nullThe current value. Returns null if neither enabled or disabled yet.
isBufferedResultsEnabled()
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.
boolisEagerLoaded()
Returns the current configured query _eagerLoaded value
boolisEmpty()
Returns true if this query found no results.
isHydrationEnabled()
Returns the current hydration mode.
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
$thisjsonSerialize()
Executes the query and converts the result set into JSON.
Part of JsonSerializable interface.
\Cake\Datasource\ResultSetInterfaceThe data to convert to JSON.
last()
Return the last row of the query result
leftJoin(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.
$thisleftJoinWith(string $assoc, ?callable $builder)
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'])
->enableAutoFields(); 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'])
->enableAutoFields(); 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.
string $assoc The association to join with
callable|null $builder optional a function that will receive a pre-made query object that can be used to add custom conditions or selecting some fields
$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
$thismap(callable $c)
Modifies each of the results using the callable
callable $c mapReduce(?callable $mapper, ?callable $reducer, bool $overwrite)
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 third argument is set to true, it will erase previous map reducers and replace it with the arguments passed.
callable|null $mapper optional The mapper callable.
callable|null $reducer optional The reducing function.
bool $overwrite optional Set to true to overwrite existing map + reduce functions.
$thismatching(string $assoc, ?callable $builder)
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.
string $assoc The association to filter by
callable|null $builder optional a function that will receive a pre-made query object that can be used to add custom conditions or selecting some fields
$thismax(mixed $field)
Returns the maximum value for a single column in all the results.
mixed $field min(mixed $field)
Returns the minimum value for a single column in all the results.
mixed $field modifier(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
$thisnest(mixed $k, mixed $p, mixed $n)
Creates a tree structure by nesting the values of column $p into that with the same value for $k using $n as the nesting key.
mixed $k mixed $p mixed $n newExpr(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\QueryExpressionnotMatching(string $assoc, ?callable $builder)
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.
string $assoc The association to filter by
callable|null $builder optional a function that will receive a pre-made query object that can be used to add custom conditions or selecting some fields
$thisoffset(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']);
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().
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.
$thisInvalidArgumentExceptionreduce(callable $c, mixed $zero)
Folds all the results into a single value using the callable.
callable $c mixed $zero reject(callable $c)
Removes the results passing the callable test
callable $c 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.
string $name The alias/name of the join to remove.
$thisrepository(\Cake\Datasource\RepositoryInterface $table)
Set the default Table object that will be used by this query and form the FROM clause.
\Cake\Datasource\RepositoryInterface|\Cake\ORM\Table $table The default table object to use
$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.
intsample(int $size = 10)
In-memory shuffle the results and return a subset of them.
int $size = 10 select(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.
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.
array|\Cake\Database\ExpressionInterface|callable|string|\Cake\ORM\Table|\Cake\ORM\Association $fields optional Fields to be added to the list.
bool $overwrite optional whether to reset fields with passed list or not
$thisselectAllExcept(mixed $table, array $excludedFields, bool $overwrite)
All the fields associated with the passed table except the excluded fields will be added to the select clause of the query. Passed excluded fields should not be aliased.
After the first call to this method, a second call cannot be used to remove fields that have already been added to the query by the first. If you need to change the list after the first call, pass overwrite boolean true which will reset the select clause removing all previous additions.
\Cake\ORM\Table|\Cake\ORM\Association $table The table to use to get an array of columns
string[] $excludedFields The un-aliased column names you do not want selected from $table
bool $overwrite optional Whether to reset/remove previous selected fields
$thisInvalidArgumentExceptionset(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.
$thissetEagerLoader(\Cake\ORM\EagerLoader $instance)
Sets the instance of the eager loader class to use for loading associations and storing containments.
\Cake\ORM\EagerLoader $instance The eager loader to use.
$thissetResult(iterable $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.
iterable $results The results this query should return.
$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.
$thisshuffle()
In-memory randomize the order the results are returned
skip(int $howMany)
Skips some rows from the start of the query result.
int $howMany some(callable $c)
Returns true if at least one of the results pass the callable test
callable $c sortBy(mixed $callback, int $dir)
Sorts the query with the callback
mixed $callback int $dir sql(?\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
stringstopWhen(callable $c)
Returns each row until the callable returns true.
callable $c sumOf(string|callable $field)
Returns the sum of all values for a single column
string|callable $field take(int $size = 1, int $from = 0)
In-memory limit and offset for the query results.
int $size = 1 int $from = 0 toArray()
Returns a key-value array with the results of this query.
toList()
Returns a numerically indexed array with the results of this query.
traverse(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
$thistriggerBeforeFind()
Trigger the beforeFind event on the query's repository object.
Will not trigger more than once, and only for select queries.
type()
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.
This changes the query type to be 'update'. Can be combined with set() and where() methods to create update queries.
string|\Cake\Database\ExpressionInterface|null $table optional Unused parameter.
$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]])
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. 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|\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.
$thiszip(array|\Traversable $c)
Returns the first result of both the query and $c in an array, then the second results and so on.
array|\Traversable $c zipWith(mixed $collections, callable $callable)
Returns each of the results out of calling $c with the first rows of the query and each of the items, then the second rows and so on.
mixed $collections callable $callable Tracks whether or not the original query should include fields from the top level table.
bool|nullTrue if the beforeFind event has already been triggered for this query
boolA query cacher instance if this query has caching enabled.
\Cake\Datasource\QueryCacher|nullConnection instance to be used to execute this query.
\Cake\Database\ConnectionA callable function that can be used to calculate the total amount of records this query will match when not using limit
callable|nullThe 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.
boolWhether the query is standalone or the product of an eager load operation.
boolInstance of a class responsible for storing association containments and for eager loading them when this query is executed
\Cake\ORM\EagerLoader|nullList of formatter classes or callbacks that will post-process the results when fetched
callable[]Instance of functions builder object used for generating arbitrary SQL functions.
\Cake\Database\FunctionsBuilder|nullWhether the user select any fields before being executed, this is used to determined if any fields should be automatically be selected.
bool|nullWhether to hydrate results into entity objects
boolThe list of query clauses to traverse for generating an INSERT statement
string[]Statement object resulting from executing this query.
\Cake\Database\StatementInterface|nullList of map-reduce routines that should be applied over the query result
arrayHolds any custom options passed using applyOptions that could not be processed by any method in this class.
arrayList of SQL parts that will be used to build this query.
arrayInstance of a table object this query is bound to.
\Cake\ORM\TableA 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[]A ResultSet.
When set, query execution will be bypassed.
iterable|nullThe COUNT(*) for the query.
When set, count query execution will be bypassed.
int|nullThe 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.ORM.Query.html