This is the root predicate group. It supports all features of a group and allows setting global query parameters.
The name “root” is never used in a query, it’s implicit.
p.offset
- number indicating the start of the result page, i.e. how many items to skipp.limit
- number indicating the page sizep.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 resultp.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 hitThis predicate allows building nested conditions. Groups can contain nested groups. Everything in a Query Builder query is implicitly in a root group, which can have p.or
and p.not
parameters as well.
The following is an 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)
.
The following is an example for nested groups:
fulltext=Management
group.p.or=true
group.1_group.path=/content/wknd/ch/de
group.1_group.type=cq:Page
group.2_group.path=/content/dam/wknd
group.2_group.type=dam:Asset
This searches for the term Management within pages in /content/wknd/ch/de
or in assets in /content/dam/wknd
.
This is conceptually fulltext AND ( (path AND type) OR (path AND type) )
. Be aware that such OR joins need good indexes for performance reasons.
p.or
- if set to true
, only one predicate in the group must match. This defaults to false
, meaning all must matchp.not
- if set to true
, it negates the group (defaults to false
)<predicate>
- adds nested predicatesN_<predicate>
- adds multiple nested predicates of the same time, like 1_property, 2_property, ...
This predicate allows sorting the results. 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
.
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 sortsort
- 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
This predicate 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.
This predicate supports facet extraction and provides buckets for each true
or false
value, but only for existing properties.
boolproperty
- relative path to property, for example myFeatureEnabled
or jcr:content/myFeatureEnabled
value
- value to check property for, true
or false
This predicate restricts the result to content fragments.
contentfragment
- It can be used with any value to check for content fragments.dateComparison
This predicate 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.
property1
- path to first date propertyproperty2
- path to second date propertyoperation
=
for exact match (default)!=
for inequality comparison>
for property1
greater than property2
>=
for property1
greater than or equal to property2
This predicate 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 POSIX time.
You can look for anything between two timestamps, anything newer or older than a given date, and also chose between inclusive and open intervals.
It supports facet extraction and provides buckets today
, this week
, this month
, last 3 months
, this year
, last year
, and earlier than last year
.
It does not support filtering.
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.This predicate excludes nodes from the result where their path matches a regular expression.
This is a filtering-only predicate and cannot leverage a search index.
It does not support facet extraction.
excludepaths
- regular expression matched against result paths, excluding matching ones from the result.This predicate searches for terms in the fulltext index.
It does not support filtering.
It does not support facet extraction.
fulltext
- the fulltext search term(s)relPath
- the relative path to search in the property or subnode. This property is optional.This predicate 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.
hasPermission
- comma-separated JCR privileges that the current user session must ALL have for the node in question; for example jcr:write
, jcr:modifyAccessControl
This predicate finds AEM 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.
It supports facet extraction and provides buckets for each unique language code.
language
- ISO language code, for example de
This predicate checks if a node is a DAM main asset and not a sub asset. This is basically every node not inside a sub assets 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.
It supports facet extraction and provides two buckets for main and sub assets.
mainasset
- boolean, true
for main assets, false
for sub assetsThis predicate finds items that are member of a specific sling resource collection.
This is a filtering-only predicate and cannot leverage a search index.
It does not support facet extraction.
memberOf
- path of Sling resource collectionThis predicate matches on JCR node names.
It supports facet extraction and provides buckets for each unique node name (filename).
nodename
- node name pattern that allows wildcards: *
= any or no char, ?
= any char, [abc]
= only chars in bracketsThis predicate 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
value and limit results to only those that have not yet expired (notexpired=true
) or that have expired already (notexpired=false
).
It does not support filtering.
It supports facet extraction in the same way as the daterange
predicate.
notexpired
- boolean, true
for not yet expired (date in the future or equal), false
for expired (date in the past) (required)property
- relative path to the DATE
property to check (required)This predicate searches within a given path.
It does not support facet extraction.
path
- This defines the path pattern.
exact
property, either the entire subtree will match (like appending //*
in xpath, but note that this does not include the base path) or only an exact path matches, which can include wildcards (*
).
true
exact
- if exact
is true
, the exact path must match, but it can contain simple wildcards (*
), that match names, but not /
; if it is false
(default) all descendants 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).
self
property in the current implementation of querybuilder and using it in queries may not produce correct search results. Changing the current implementation of self
property is also not feasible since it might break the existing applications that rely on it. Due to this, self
property has been deprecated and it is advised to avoid using it.This predicate matches on JCR properties and their values.
It supports facet extraction and provides buckets for each unique property value in the results.
property
- relative path to property, for example jcr:title
value
- value to check property for; follows the JCR property type to string conversionsN_value
- use 1_value
, 2_value
, … to check for multiple values (combined with OR
by default, with AND
if and=true
)and
- set to true
for combining multiple values (N_value
) with AND
operation
equals
for exact match (default)unequals
for inequality comparisonlike
for using the jcr:like
xpath function (optional)not
for no match (for example, not(@prop)
in xpath, value param will be ignored)exists
for existence check
true
the property must existfalse
is the same as not
and is the defaultdepth
- 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
)This predicate 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, an upper bound, or both. The operation (for example, lesser than or lesser than or equal to) can also be specified for lower and upper bound individually.
It does not support facet extraction.
property
- relative path to propertylowerBound
- lower bound to check propertylowerOperation
- >
(default) or >=
, applies to the lowerValue
upperBound
- upper bound to check propertyupperOperation
- <
(default) or <=
, applies to the lowerValue
decimal
- true
if the checked property is of type DecimalThis predicate 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
, representing the current time.
For example:
upperBound=1h
(and no lowerBound
) selects anything in the next hourlowerBound=-1d
(and no upperBound
) selects anything in the last 24 hourslowerBound=-6M
and upperBound=-3M
selects anything in the last 3 to six monthslowerBound=-1500
and upperBound=5500
selects anything between 1500 milliseconds old and 5500 milliseconds in the futurelowerBound=1d
and upperBound=2d
selects anything the day after tomorrowNote that it does not take leap years into consideration and all months are 30 days.
It does not support filtering.
It supports facet extraction in the same way as the daterange
predicate.
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 offsetlowerBound
- 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 offsetThis predicate includes all predicates of a persisted Query Builder 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 an nt:file
node that contains the query as a text file in Java properties format.
It does not support facet extraction for the predicates of the saved query.
savedquery
- path to the saved query (String
property or nt:file
node)This predicate is a similarity search using JCR XPath’s rep:similar()
.
It does not support filtering and does not support facet extraction.
similar
- absolute path to the node for which to find similar nodeslocal
- a relative path to a descendant node or .
for the current node (optional, default is .
)This predicate searches for content tagged with one or more tags, by specifying tag title paths.
It supports facet extraction and provides buckets for each unique tag, using their current tag title path.
tag
- tag title path to look for, for example 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
)property
- property (or relative path to property) to look at (default cq:tags
)This predicate searches for content tagged with one or more tags, by specifying tag IDs.
It supports facet extraction and provides buckets for each unique tag, using their current tag ID.
tagid
- tag ID to look for, for example properties:orientation/landscape
N_value
- use 1_value
, 2_value
, … to check for multiple tag IDs (combined with OR
by default, with AND
if and=true
)property
- property (or relative path to property) to look at (default cq:tags
)This predicate 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 restrict the result to only items tagged with these.
It does not support facet extraction.
tagsearch
- keyword to search for in tag titlesproperty
- property (or relative path to property) to consider (default cq:tags
)lang
- to search in a certain localized tag title only (for example, de
)all
- boolean value to search entire tag fulltext, i.e. all titles, description etc. (takes precedence over lang
)This predicate restricts results to a specific JCR node type, both primary node types or mixin types. This will also find sub types of that node type. Note that repository search indexes need to cover the node types for efficient execution.
It supports facet extraction and provides buckets for each unique type in the results.
type
- node type or mixin name to search for, for example cq:Page