cts:register). If a
registered query with the specified ID(s) is not found, then
a cts:search operation with an invalid
cts:registered-query throws an XDMP-UNREGISTERED
exception.
Options include:
- "filtered"
- A filtered query (the default). Filtered queries eliminate any false-positive results and properly resolve cases where there are multiple candidate matches within the same fragment, thereby guaranteeing that the results fully satisfy the original
cts:queryitem that was registered. This option is not currently available.- "unfiltered"
- An unfiltered query. Unfiltered registered queries select fragments from the indexes that are candidates to satisfy the
cts:query. Depending on the originalcts:query, the structure of the documents in the database, and the configuration of the database, unfiltered registered queries may result in false-positive results or in incorrect matches when there are multiple candidate matches within the same fragment. To avoid these problems, you should only use unfiltered queries on top-level XPath expressions (for example, document nodes, collections, directories) or on fragment roots. Using unfiltered queries on complex XPath expressions or on XPath expressions that traverse below a fragment root can result in unexpected results. This option is required in the current release.
If the options parameter does not contain "unfiltered", then an error is returned, as the "unfiltered" option is required.
Registered queries are persisted as a soft state only; they can
become unregistered through an explicit direction (using
cts:deregister),
as a result of the cache growing too large, or because of a server restart.
Consequently, either your XQuery code or your middleware layer should handle
the case when an XDMP-UNREGISTERED exception occurs (for example, you can
wrap your cts:registered-query code in a try/catch block
or your Java or .NET code can catch and handle the exception).
cts.search(
cts.registeredQuery(1234567890123456,"unfiltered"))
=> .. relevance-ordered sequence of documents
that also matches the registered query
// wrap the registered query in a try/catch
try {
cts.search(cts.registeredQuery(995175721241192518,"unfiltered"))
} catch (e) {
if (e.name == "XDMP-UNREGISTERED") {
fn.concat("Retry this query with the following registered query ID: ",
xdmp.eval('cts.register(cts.wordQuery("hello*world","wildcarded"))')) }
else { e; }
}