Query Builder Predicate Reference

May 3, 2023

Topics:
Developing

CREATED FOR:

Developer

CAUTION

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

General

root
group
orderby

Predicates

boolproperty

Matches on JCR BOOLEAN properties. Only accepts the values " true" and " false". In case of " false", it will match if the property has the value " false" or if it does not exist at all. This can be useful for checking for boolean flags that are only set when enabled.

The inherited " operation" parameter has no meaning.

Supports facet extraction. Will provide buckets for each true or false value, but only for existing properties.

Properties

boolproperty
relative path to property, for example myFeatureEnabled or jcr:content/myFeatureEnabled
value
value to check property for, " true" or " false"

contentfragment

Restricts the result to content fragments.

Does not support filtering.

Does not support facet extraction.

Properties

contentfragment
It can be used with any value to check for content fragments.

dateComparison

Compares two JCR DATE properties with each other. Can test if they are equal, unequal, greater than or greater-than-or-equal.

This is a filtering-only predicate and cannot leverage a search index.

Properties

property1

path to first date property
property2

path to second date property
operation

" =" for exact match, " !=" for unequality comparison, " >" for property1 greater than property2, " >=" for property1 greater than or equal to property2. The default value is " =".

daterange

Matches JCR DATE properties against a date/time interval. This uses the ISO8601
format for dates and times ( YYYY-MM-DDTHH:mm:ss.SSSZ) and allows also partial representations, like YYYY-MM-DD. Alternatively, the timestamp can be provided as number of milliseconds since 1970 in the UTC timezone, the unix time format.

You can look for anything between two timestamps, anything newer or older than a given date, and also chose between inclusive and open intervals.

Supports facet extraction. Will provide buckets “today”, “this week”, “this month”, “last 3 months”, “this year”, “last year” and “earlier than last year”.

Does not support filtering.

Properties

property

relative path to a DATE property, for example jcr:lastModified
lowerBound

lower date bound to check property for, for example 2014-10-01
lowerOperation

" >" (newer) or " >=" (at or newer), applies to the lowerBound. The default is " >".
upperBound

upper bound to check property for, for example 2014-10-01T12:15:00
upperOperation

" <" (older) or " <=" (at or older), applies to the upperBound. The default is " <".
timeZone

ID of timezone to use when it is not given as an ISO-8601 date string. The default is the default timezone of the system.

excludepaths

Excludes nodes from the result where their path matches a regular expression.

This is a filtering-only predicate and cannot leverage a search index.

Does not support facet extraction.

Properties

excludepaths

regular expression matched against result paths, excluding matching ones from the result.

fulltext

Searches for terms in the fulltext index.

Does not support filtering.

Does not support facet extraction.

Properties

fulltext

the fulltext search term(s)
relPath

the relative path to search in the property or subnode. This property is optional.

group

Allows to build nested conditions. Groups can contain nested groups. Everything in a querybuilder query is implicitly in a root group, which can have p.or and p.not parameters as well.

Example for matching either one of two properties against a value:

group.p.or=true
group.1_property=jcr:title
group.1_property.value=My Page
group.2_property=navTitle
group.2_property.value=My Page

This is conceptually (1_property OR 2_property).

Example for nested groups:

fulltext=Management
group.p.or=true
group.1_group.path=/content/geometrixx/en
group.1_group.type=cq:Page
group.2_group.path=/content/dam/geometrixx
group.2_group.type=dam:Asset

This searches for the term “Management” within pages in /content/geometrixx/en or in assets in /content/dam/geometrixx.

This is conceptually fulltext AND ( (path AND type) OR (path AND type) ). Be aware that such OR joins need good indexes for performance.

Properties

p.or

if set to " true", only one predicate in the group must match. This defaults to " false", meaning all must match
p.not

if set to " true", it negates the group (defaults to " false")
<predicate>

adds nested predicates
N_<predicate>

adds multiple nested predicates of the same time, like 1_property, 2_property, ...

hasPermission

Restricts the result to items where the current session has the specified JCR privileges.

This is a filtering-only predicate and cannot leverage a search index. It does not support facet extraction.

Properties

hasPermission

comma-separated JCR privileges that the current user session must ALL have for the node in question; for example jcr:write, jcr:modifyAccessControl

language

Finds CQ pages in a specific language. This looks at both the page language property and the page path which often includes the language or locale in a top level site structure.

This is a filtering-only predicate and cannot leverage a search index.

Supports facet extraction. Will provide buckets for each unique language code.

Properties

language

ISO language code, for example " de"

mainasset

Checks if a node is a DAM main asset and not a sub asset. This is basically every node not inside a “subassets” node. Note that this does not check for the dam:Asset node type. To use this predicate, simply set " mainasset=true" or " mainasset=false", there are no further properties.

This is a filtering-only predicate and cannot leverage a search index.

Supports facet extraction. Will provide 2 buckets for main and subassets.

Properties

mainasset

boolean, " true" for main assets, " false" for sub assets

memberOf

Finds items that are member of a specific sling resource collection.

This is a filtering-only predicate and cannot leverage a search index. Does not support facet extraction.

Properties

memberOf

path of Sling resource collection

nodename

Matches on JCR node names.

Supports facet extraction. Will provide buckets for each unique node name (filename).

Properties

nodename

node name pattern that allows wildcards: * = any or no char, ? = any char, [abc] = only chars in brackets

notexpired

Matches items by checking if a JCR DATE property is greater or equal than the current server time. This can be used to check on an " expiresAt" like date property and limit to only the ones that have not expired yet ( notexpired=true) or that have expired already ( notexpired=false).

Does not support filtering.

Supports facet extraction in the same way as the daterange predicate.

Properties

notexpired

boolean, " true" for not expired yet (date in the future or equal), " false" for expired (date in the past) (required)
property

relative path to the DATE property to check (required)

orderby

Allows to sort the result. If ordering by multiple properties is required, this predicate needs to be added multiple times using the number prefix, such as 1_orderby=first, 2_oderby=second.

Properties

orderby

either JCR property name indicated by a leading @, for example @jcr:lastModified or @jcr:content/jcr:title, or another predicate in the query, for example 2_property, on which to sort
sort

sort direction, either " desc" for descending or " asc" for ascending (default)
case

if set to " ignore" will make sorting case insensitive, meaning “a” comes before “B”; if empty or left out, sorting is case sensitive, meaning “B” comes before “a”

path

Searches within a given path.

Does not support facet extraction.

Properties

path

path pattern; depending on exact, either the entire subtree will match (like appending //* in xpath, but note that this does not include the base path) (exact=false, default) or only an exact path matches, which can include wildcards ( *); if self is set, the entire subtree including the base node will be searched
exact

if exact is true/on, the exact path must match, but it can contain simple wildcards ( *), that match names, but not " /"; if it is false (default) all descendents are included (optional)
flat

searches only the direct children (like appending " /*" in xpath) (only used if ’ exact’ is not true, optional)
self

searches the subtree but includes the base node given as path (no wildcards)

property

Matches on JCR properties and their values.

Supports facet extraction. Will provide buckets for each unique property value in the results.

Properties

property

relative path to property, for example jcr:title
value

value to check property for; follows the JCR property type to string conversions
N_value

use 1_value, 2_value, … to check for multiple values (combined with OR by default, with AND if and=true) (since 5.3)
and

set to true for combining multiple values ( N_value) with AND (since 5.3)
operation

" equals" for exact match (default), " unequals" for unequality comparison, " like" for using the jcr:like xpath function (optional), " not" for no match (eg. " not(@prop)" in xpath, value param will be ignored) or " exists" for existence check (value can be true - property must exist, the default - or false - same as " not")
depth

number of wildcard levels underneath which the property/relative path can exist (for instance, property=size depth=2 will check node/size, node/*/size and node/*/*/size)

rangeproperty

Matches a JCR property against an interval. This applies to properties with linear types such as LONG, DOUBLE and DECIMAL. For DATE please see the daterange predicate that has optimized date format input.

You can define a lower bound and an upper bound or only one of them. The operation (eg. “lesser than” or “lesser or equals”) can also be specified for lower and upper bound individually.

Does not support facet extraction.

Properties

property

relative path to property
lowerBound

lower bound to check property for
lowerOperation

" >" (default) or " >=", applies to the lowerValue
upperBound

upper bound to check property for
upperOperation

" <" (default) or " <=", applies to the lowerValue
decimal

" true" if the checked property is of type Decimal

relativedaterange

Matches JCR DATE properties against a date/time interval using time offsets relative to the current server time. You can specify lowerBound and upperBound using either a millisecond value or the bugzilla syntax 1s 2m 3h 4d 5w 6M 7y (one second, two minutes, three hours, four days, five weeks, six months, seven years). Prefix with " -" to indicate a negative offset before the current time. If you only specify lowerBound or upperBound, the other one will default to 0, meaning the current time.

For example:

upperBound=1h (and no lowerBound) would select anything in the next hour
lowerBound=-1d (and no upperBound) would select anything in the last 24 hours
lowerBound=-6M and upperBound=-3M would select anything 6 months to 3 months old
lowerBound=-1500 and upperBound=5500 would select anything between 1500 milliseconds in the past and 5500 milliseconds in the future
lowerBound=1d and upperBound=2d would select anything in the day after tomorrow

Note that it does not take leap years into consideration and all months are 30 days.

Does not support filtering.

Supports facet extraction in the same way as the daterange predicate.

Properties

upperBound

upper date bound in milliseconds or 1s 2m 3h 4d 5w 6M 7y (one second, two minutes, three hours, four days, five weeks, six months, seven years) relative to current server time, use “-” for negative offset
lowerBound

lower date bound in milliseconds or 1s 2m 3h 4d 5w 6M 7y (one second, two minutes, three hours, four days, five weeks, six months, seven years) relative to current server time, use “-” for negative offset

root

Root predicate group. Supports all features of a group and allows to set global query parameters.

The name “root” is never used in a query, it’s implicit.

Properties

p.offset

number indicating the start of the result page, i.e. how many items to skip
p.limit

number indicating the page size
p.guessTotal

recommended: avoid calculating the full result total which can be costly; either a number indicating the maximum total to count up to (for example 1000, a number that gives users enough feedback on the rough size and exact numbers for smaller results) or " true" to count only up to the minimum necessary p.offset + p.limit
p.excerpt

if set to " true", include full text excerpt in the result
p.hits

(only for the JSON servlet) select the way the hits are written as JSON, with these standard ones (extensible via the ResultHitWriter service):
- simple:
  
  minimal items like path, title, lastmodified, excerpt (if set)
- full:
  
  sling JSON rendering of the node, with jcr:path indicating the path of the hit: by default just lists the direct properties of the node, include a deeper tree with p.nodedepth=N, with 0 meaning the entire, infinite subtree; add p.acls=true to include the JCR permissions of the current session on the given result item (mappings: create = add_node, modify = set_property, delete = remove)
- selective:
  
  only properties specified in p.properties, which is a space separated (use “+” in URLs) list of relative paths; if the relative path has a depth > 1 these will be represented as child objects; the special jcr:path property includes the path of the hit

savedquery

Includes all predicates of a persisted querybuilder query into the current query as a sub group predicate.

Note that this will not execute an extra query but extend the current query.

Queries can be persisted programmatically using QueryBuilder#storeQuery(). The format can be either a multi-line String property or a nt:file node that contains the query as a text file in Java properties format.

Does not support facet extraction for the predicates of the saved query.

Properties

savedquery

path to the saved query (String property or nt:file node)

similar

Similarity search using JCR XPath’s rep:similar().

Does not support filtering. Does not support facet extraction.

Properties

similar
absolute path to the node for which to find similar nodes
local
a relative path to a descendant node or . for the current node (optional, default is " .")

tag

Searches for content tagged with one or more tags, by specifying tag title paths.

Supports facet extraction. Will provide buckets for each unique tag, using their current tag title path.

Properties

tag

tag title path to look for, for example “Asset Properties : Orientation / Landscape”
N_value

use 1_value, 2_value, … to check for multiple tags (combined with OR by default, with AND if and=true) (since 5.6)
property

property (or relative path to property) to look at (default " cq:tags")

tagid

Searches for content tagged with one or more tags, by specifying tag IDs.

Supports facet extraction. Will provide buckets for each unique tag, using their current tag ID.

Properties

tagid

tag id to look for, for example " properties:orientation/landscape"
N_value

use 1_value, 2_value, … to check for multiple tagids (combined with OR by default, with AND if and=true) (since 5.6)
property

property (or relative path to property) to look at (default " cq:tags")

tagsearch

Searches for content tagged with one or more tags, by specifying keywords. This will first search for tags containing these keywords in their titles, then restricting the result to only items tagged with these.

Does not support facet extraction.

Properties

tagsearch

keyword to search for in tag titles
property

property (or relative path to property) to look at (default " cq:tags")
lang

to search in a certain localized tag title only (e.g. " de")
all

(bool) search entire tag fulltext, i.e. all titles, description etc. (takes precedence over “l ang”)

type

Restricts results to a specific JCR node type, both primary node type or mixin type. This will also find subtypes of that node type. Note that repository search indexes need to cover the node types for efficient execution.

Supports facet extraction. Will provide buckets for each unique type in the results.

Properties

type

node type or mixin name to search for, for example cq:Page

recommendation-more-help