MarkLogic Server 11.0 Product Documentationcts.fieldValueRanges
cts.fieldValueRanges( field-names as String[], [bounds as (String | Number | Boolean | null | Array | Object)[]], [options as String[]], [query as cts.query?], [quality-weight as Number?], [forest-ids as (Number|String)[]] ) as Sequence
Summary
Returns value ranges from the specified field value lexicon(s). Value lexicons are implemented using range indexes; consequently this function requires a field range index for each element specified in the function. If there is not a range index configured for each of the specified fields, an exception is thrown.
The values are divided into buckets. The $bounds parameter specifies the number of buckets and the size of each bucket. All included values are bucketed, even those less than the lowest bound or greater than the highest bound. An empty sequence for $bounds specifies one bucket, a single value specifies two buckets, two values specify three buckets, and so on.
If you have string values and you pass a $bounds parameter as in the following call:
cts.fieldValueRanges("myField", ["f", "m"])
The first bucket contains string values that are less than the
string f, the second bucket contains string values greater than
or equal to f but less than m, and the third bucket
contains string values that are greater than or equal to m.
For each non-empty bucket, an ObjectNode is returned.
Each ObjectNode has a minimum property and a maximum
property. If a bucket is bounded, its ObjectNode will also have a
lowerBound property if it is bounded from below, and
a upperBound property if it is bounded from above.
Empty buckets return nothing unless the "empties" option is specified.
| Parameters | |
|---|---|
| field-names | One or more element QNames. |
| bounds | A sequence of range bounds. The types must match the lexicon type. The values must be in strictly ascending order, otherwise an exception is thrown. |
| options |
Options. The default is ().
Options include:
|
| query |
Only include values in fragments selected by the cts:query,
and compute frequencies from this set of included values.
The values do not need to match the query, but they must occur in
fragments selected by the query.
The fragments are not filtered to ensure they match the query,
but instead selected in the same manner as
"unfiltered" cts.search
operations. If a string
is entered, the string is treated as a cts:word-query of the
specified string.
|
| quality-weight | A document quality weight to use when computing scores. The default is 1.0. |
| forest-ids | A sequence of IDs of forests to which the search will be constrained. An empty sequence means to search all forests in the database. The default is (). |
Usage Notes
Only one of "frequency-order" or "item-order" may be specified in the options parameter. If neither "frequency-order" nor "item-order" is specified, then the default is "item-order".
Only one of "fragment-frequency" or "item-frequency" may be specified in the options parameter. If neither "fragment-frequency" nor "item-frequency" is specified, then the default is "fragment-frequency".
Only one of "ascending" or "descending" may be specified in the options parameter. If neither "ascending" nor "descending" is specified, then the default is "ascending" if "item-order" is specified, and "descending" if "frequency-order" is specified.
Only one of "eager" or "lazy" may be specified in the options parameter. If neither "eager" nor "lazy" is specified, then the default is "eager" if "frequency-order" or "empties" is specified, otherwise "lazy".
Only one of "any", "document", "properties", or "locks" may be specified in the options parameter. If none of "any", "document", "properties", or "locks" are specified and there is a $query parameter, then the default is "document". If there is no $query parameter then the default is "any".
Only one of the "score-logtfidf", "score-logtf", "score-simple", "score-random", or "score-zero" options may be specified in the options parameter. If none of "score-logtfidf", "score-logtf", "score-simple", "score-random", or "score-zero" are specified, then the default is "score-logtfidf".
Only one of the "checked" or "unchecked" options may be specified in the options parameter. If neither "checked" nor "unchecked" are specified, then the default is "checked".
If "collation=URI" is not specified in the options parameter, then the default collation is used. If a lexicon with that collation does not exist, an error is thrown.
If "sample=N" is not specified in the options parameter,
then ranges with all included values may be returned. If a
$query parameter is not present, then "sample=N"
has no effect.
If "truncate=N" is not specified in the options parameter,
then values from all fragments selected by the $query parameter
are included. If a $query parameter is not present, then
"truncate=N" has no effect.
To incrementally fetch a subset of the values returned by this function,
use
fn.subsequence
on the output, rather than
the "skip" option. The "skip" option is based on fragments matching the
query parameter (if present), not on values. A fragment
matched by query might contain multiple values or no values.
The number of fragments skipped does not correspond to the number of
values. Also, the skip is applied to the relevance ordered query matches,
not to the ordered results list.
When using the "skip" option, use the "truncate" option rather than the "limit" option to control the number of matching fragments from which to draw values.
Example
// Run the following to load data for this example.
// Make sure you have a string field range index on
// field aname that includes name and excludes mname.
declareUpdate();
const content1 = fn.head(xdmp.unquote(
'<name><fname>John</fname><mname>Rob</mname><lname>Goldings</lname></name>'));
const content2 = fn.head(xdmp.unquote(
'<name><fname>Jim</fname><mname>Ken</mname><lname>Kurla</lname></name>'));
const content3 = fn.head(xdmp.unquote(
'<name><fname>Ooi</fname><mname>Ben</mname><lname>Fu</lname></name>'));
const content4 = fn.head(xdmp.unquote(
'<name><fname>James</fname><mname>Rick</mname><lname>Tod</lname></name>'));
const content5 = fn.head(xdmp.unquote(
'<name><fname>Anthony</fname><mname>Rob</mname><lname>Flemings</lname></name>')
);
const content6 = fn.head(xdmp.unquote(
'<name><fname>Charles</fname><mname>Ken</mname><lname>Winter</lname></name>')
);
const content7 = fn.head(xdmp.unquote(
'<name><fname>Nancy</fname><mname>Ben</mname><lname>Schmidt</lname></name>'));
const content8 = fn.head(xdmp.unquote(
'<name><fname>Robert</fname><mname>Rick</mname><lname>Hanson</lname></name>')
);
xdmp.documentInsert("/aname1.xml", content1);
xdmp.documentInsert("/aname2.xml", content2);
xdmp.documentInsert("/aname3.xml", content3);
xdmp.documentInsert("/aname4.xml", content4);
xdmp.documentInsert("/aname5.xml", content5);
xdmp.documentInsert("/aname6.xml", content6);
xdmp.documentInsert("/aname7.xml", content7);
xdmp.documentInsert("/aname8.xml", content8);
******
// The following is based on the above setup
cts.fieldValueRanges("aname", ["A","J","O"]);
=>
{"minimum":"Anthony Flemings", "maximum":"Charles Winter",
"lowerBound":"A", "upperBound":"J"}
{"minimum":"James Tod", "maximum":"Nancy Schmidt",
"lowerBound":"J", "upperBound":"O"}
{"minimum":"Ooi Fu", "maximum":"Robert Hanson",
"lowerBound":"O"}
// And you can call cts.frequency on each result item.