MarkLogic 12 EA 2 Product Documentation

cts.jsonPropertyRangeQuery

cts.jsonPropertyRangeQuery(
   property-name as String[],
   operator as String,
   value as any[],
   [options as String[]],
   [weight as Number?]
) as cts.jsonPropertyRangeQuery

Summary

Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value. Searches with the cts:json-property-range-query constructor require a property range index on the specified names; if there is no range index configured, then an exception is thrown.

Usage Notes

If you want to constrain on a range of values, you can combine multiple cts:json-property-range-query constructors together with cts:and-query or any of the other composable cts:query constructors.

If neither "cached" nor "uncached" is present, it specifies "cached".

The "cached-incremental" option can improve performance if you repeatedly perform range queries on date or dateTime values over a short range that does not vary widely over short period of time. To benefit, the operator should remain the same "direction" (<,<=, or >,>=) across calls, the bounding date or dateTime changes slightly across calls, and the query runs very frequently (multiple times per minute). Note that using this options creates significantly more cached queries than the "cached" option.

The "cached-incremental" option has the following restrictions and interactions: The "min-occurs" and "max-occurs" options will be ignored if you use "cached-incremental" in unfiltered search. You can only use "score-function=zero" with "cached-incremental". The "cached-incremental" option behaves like "cached" if you are not querying date or dateTime values.

Negative "min-occurs" or "max-occurs" values will be treated as 0 and non-integral values will be rounded down. An error will be raised if the "min-occurs" value is greater than the "max-occurs" value.

"score-function=linear" means that values that are further away from the bounds will score higher. "score-function=reciprocal" means that values that are closer to the bounds will score higher. The functions are scaled appropriately for different types, so that in general the default slope factor will provide useful results. Using a slope factor greater than 1 gives distinct scores over a smaller range of values, and produces generally higher scores. Using a slope factor less than 1 gives distinct scores over a wider range of values, and produces generally lower scores.

For queries against a dateTime index, when $value is an xs:dayTimeDuration or xs:yearMonthDuration, the query is executed as an age query. $value is subtracted from fn:current-dateTime() to create an xs:dateTime used in the query. If there is more than one item in $value, they must all be the same type.

Example

// Suppose there are three documents in the database inserted
// as follows:

declareUpdate();
xdmp.documentInsert("/1.json",
{
  "entry" : {
    "date" : "2007-01-01",
    "info" : "Some information."
  }
});

xdmp.documentInsert("/2.json",
{
  "entry" : {
    "date" : "2006-06-23",
    "info" : "Some other information."
  }
});

xdmp.documentInsert("/3.json",
{
  "entry" : {
    "date" : "1971-12-23",
    "info" : "Some different information."
  }
});

******

//   requires a property (element) range index of
//   type xs:date on "date"

cts.search(
  cts.jsonPropertyRangeQuery("date", "<=",
      xs.date("2000-01-01")));

//  returns the third document