Whatever message this page gives is out now! Go check it out!

ORMExecuteQuery

Last update:
May 18, 2026
Description
Executes a Hibernate Query Language (HQL) query. By default, this function works on ORM's default data source. To use this function for another data source, specify the data source key-value pair within the queryoptions.

Syntax

ORMExecuteQuery(hql, params [,unique]) 
 
ORMExecuteQuery(hql, [,unique] [, options]) 
 
ORMExecuteQuery(hql, params [,unique] [,options])
Parameters
Parameter
Description
hql
The HQL query that has to be executed.
params
Object parameter for the entity.
unique
Specifies if the object parameter is unique.
options
Key-value pair of options for the query.
You can specify several options to control the behavior of retrieval using queryOptions:
  • ignorecase : Ignores the case of sort order when you set it to true. Use this option only when you specify the sortorder parameter.
  • maxResults: Specifies the maximum number of objects to be retrieved.
  • offset: Specifies the start index of the resultset from where it has to start the retrieval.
  • cacheable: Whether the result of this query is to be cached in the secondary cache. Default is false.
  • cachename : Name of the cache in secondary cache.
  • timeout: Specifies the timeout value (in seconds) for the query
  • datasource : Specifies the datasource  in which to execute HQL.
Note: Maxresults and timeout are used for pagination.

Example

ORMExecuteQuery("from cemployees where EmployeeID=2");
ORMExecuteQuery("from cemployees where EmployeeID IN (?, ?, ?)", [1, 3, 5]);
ORMExecuteQuery("select count(*) from cemployees", [], false);
ORMExecuteQuery("from Artists where artistid=1", true, {datasource="cfartgallery"});
ORMExecuteQuery("select count(*) from Authors", [], false, {datasource="cfbookclub"});

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page