ColdBox ORM Module
Search…
v3.x
Base ORM Service
Virtual Services
Criteria Queries
Results
Once you have concatenated criterias together, you can execute the query via the execution methods. Please remember that these methods return the results, so they must be executed last.
So the idea is the you request a query, add all kinds of restrictions and modifiers and then you request the results from it.
Method
Description
count( propertyName="" )Note, count() can't be called on a criteria after list() has been executed.
get( [properties=""] )Get a single entity. If you pass in the
properties then you will get a struct of those properties.getOrFail( [properties=""] )Convenience method to return a single instance that matches the built up criterias query, or throws an exception if the query returns no results
list( max, offset, timeout, sortOrder, ignoreCase, asQuery=false asStream=false)Execute the criterias and give you the results.
count( propertyName = "' )
Get the record count using hibernate projections for the given criterias. You can optionally pass in the name of the property to do the count on, else it doesn
* by default.1
service
2
.newCriteria()
3
.joinTo( "categories", "categories" )
4
.isEq( "categories.categoryID", getCategoryID() )
5
.isTrue( "isPublished" )
6
.isLE( "publishedDate", now() )
7
.isEq( "passwordProtection", "" )
8
.$or(
9
service.getRestrictions().isNull( "expireDate" ),
10
service.getRestrictions().isGT( "expireDate", now() )
11
)
12
.cache( true )
13
.count( "contentID" );
Copied!
get( properties="" )
Convenience method to return a single instance that matches the built up criterias, or
null if the query returns no results. It can also throw the following exception: NonUniqueResultException - if there is more than one matching result. It can also take in a property list in the properties argument so instead of giving you a full ORM entity object, it will give you a struct of those properties.1
// Get an entity
2
var oTargetCategory = newCriteria()
3
.isEq( "slug", arguments.category.getSlug() )
4
.joinTo( "site", "site" )
5
.isEq( "site.slug", arguments.site.getSlug() )
6
.get();
7
8
// Get a struct of only the properties we need
9
var data = newCriteria()
10
.isEq( "slug", arguments.category.getSlug() )
11
.joinTo( "site", "site" )
12
.isEq( "site.slug", arguments.site.getSlug() )
13
.get( "id,slug" );
Copied!
getOrFail( properties="" )
Convenience method to return a single instance that matches the built up criterias, or throw an exception (
EntityNotFound) if the query returns no results. It can also throw the following exception: NonUniqueResultException - if there is more than one matching result. It can also take in a property list in the properties argument so instead of giving you a full ORM entity object, it will give you a struct of those properties.1
// Get an entity
2
var oTargetCategory = newCriteria()
3
.isEq( "slug", arguments.category.getSlug() )
4
.joinTo( "site", "site" )
5
.isEq( "site.slug", arguments.site.getSlug() )
6
.getOrFail();
7
8
// Get a struct of only the properties we need
9
var data = newCriteria()
10
.isEq( "slug", arguments.category.getSlug() )
11
.joinTo( "site", "site" )
12
.isEq( "site.slug", arguments.site.getSlug() )
13
.getOrFail( "id,slug" );
Copied!
list( ... )
Execute the criteria queries you have defined and return the results, you can pass optional parameters to manipulate the way the results are sent back to you. Let's look at the method signature for this awesome method:
1
/**
2
* Execute the criteria queries you have defined and return the results, you can pass optional parameters or define them via our methods
3
*
4
* @offset The pagination offset, defaults to 0
5
* @max The max number of records to get, defaults to all
6
* @timeout The query timeout
7
* @sortOrder The sorting order
8
* @ignoreCase For the sorting and SQL
9
* @asQuery Return a query or array of data (objects/struct), defaults to arrays
10
* @asStream Return a cbStream of array data, defaults to the `asStream` property
11
*/
12
any function list(
13
numeric offset = 0,
14
numeric max = 0,
15
numeric timeout = 0,
16
string sortOrder = "",
17
boolean ignoreCase = false,
18
boolean asQuery = false,
19
boolean asStream = getAsStream()
20
)
Copied!
As you can see from the signature above, the first two arguments (
offset, max) are used for pagination. So you can easily paginate the result set. The timeout argument can be used if the query is expected to be heavy duty, we want to make sure we timeout the execution (throws exception). The ignorecase is only used for sorting orders.Then we get to the last two arguments:
asQuery, asStream. By default the list() method will return an array of objects. However, if you want different results you can use this two modifiers to give you a ColdFusion query or a Java stream.1
// Listing
2
var results = c
3
.like("name", "lui%")
4
.list();
5
​
6
var c = newCriteria()
7
// only approved comments
8
.isTrue( "isApproved" )
9
// By Content?
10
.when( !isNull( arguments.contentID ) AND len( arguments.contentID ), function( c ){
11
c.isEq( "relatedContent.contentID", contentID );
12
} )
13
// By Content Type Discriminator: class is a special hibernate deal
14
.when( !isNull( arguments.contentType ) AND len( arguments.contentType ), function( c ){
15
c.createCriteria( "relatedContent" ).isEq( "class", contentType );
16
} )
17
// Site Filter
18
.when( len( arguments.siteID ), function( c ){
19
c.joinTo( "relatedContent", "relatedContent" )
20
.isEq( "relatedContent.site.siteID", siteID );
21
} );
22
​
23
// run criteria query and projections count
24
results.count = c.count();
25
results.comments = c.list(
26
offset : arguments.offset,
27
max : arguments.max,
28
sortOrder: "createdDate #arguments.sortOrder#",
29
asQuery : false
30
);
Copied!
Tip: You can call
count() and list() on the same criteria, but due to the internal workings of Hibernate, you must call count() first, then list().Last modified 4mo ago
Export as PDF
Copy link
Edit on GitHub