MarkLogic Server 11.0 Product Documentation
cts.valueMatch

cts.valueMatch(
   range-indexes as cts.reference[],
   pattern as xs.anyAtomicType,
   [options as String[]],
   [query as cts.query?],
   [quality-weight as Number?],
   [forest-ids as (Number|String)[]]
) as Sequence

Summary

Returns values from the specified value lexicon(s) that match the specified wildcard pattern. Value lexicons are implemented using range indexes; consequently this function requires a range index for each index reference specified in the function. If there is not a range index configured for each of the specified references, then an exception is thrown.

Parameters
range-indexes	A sequence of references to range indexes.
pattern	A pattern to match. The parameter type must match the lexicon type. String parameters may include wildcard characters.
options	Options. The default is (). Options include: "case-sensitive" A case-sensitive match. "case-insensitive" A case-insensitive match. "diacritic-sensitive" A diacritic-sensitive match. "diacritic-insensitive" A diacritic-insensitive match. "ascending" Values should be returned in ascending order. "descending" Values should be returned in descending order. "any" Values from any fragment should be included. "document" Values from document fragments should be included. "properties" Values from properties fragments should be included. "locks" Values from locks fragments should be included. "frequency-order" Values should be returned ordered by frequency. "item-order" Values should be returned ordered by item. "fragment-frequency" Frequency should be the number of fragments with an included value. This option is used with `cts:frequency`. "item-frequency" Frequency should be the number of occurrences of an included value. This option is used with `cts:frequency`. "timezone=TZ" Return timezone sensitive values (dateTime, time, date, gYearMonth, gYear, gMonth, and gDay) adjusted to the timezone specified by TZ. Example timezones: Z, -08:00, +01:00. "limit=N" Return no more than N values. You should not use this option with the "skip" option. Use "truncate" instead. "skip=N" Skip over fragments selected by the `cts:query` to treat the Nth fragment as the first fragment. Values from skipped fragments are not included. This option affects the number of fragments selected by the `cts:query` to calculate frequencies. Only applies when a `$query` parameter is specified. "sample=N" Return only values from the first N fragments after skip selected by the `cts:query`. This option does not affect the number of fragments selected by the `cts:query` to calculate frequencies. Only applies when a `$query` parameter is specified. "truncate=N" Include only values from the first N fragments after skip selected by the `cts:query`. This option also affects the number of fragments selected by the `cts:query` to calculate frequencies. Only applies when a `$query` parameter is specified. "score-logtfidf" Compute scores using the logtfidf method. Only applies when a `$query` parameter is specified. "score-logtf" Compute scores using the logtf method. Only applies when a `$query` parameter is specified. "score-simple" Compute scores using the simple method. Only applies when a `$query` parameter is specified. "score-random" Compute scores using the random method. Only applies when a `$query` parameter is specified. "score-zero" Compute all scores as zero. Only applies when a `$query` parameter is specified. "checked" Word positions should be checked when resolving the query. "unchecked" Word positions should not be checked when resolving the query. "too-many-positions-error" If too much memory is needed to perform positions calculations to check whether a document matches a query, return an XDMP-TOOMANYPOSITIONS error, instead of accepting the document as a match. "eager" Perform most of the work concurrently before returning the first item from the indexes, and only some of the work sequentially while iterating through the rest of the items. This usually takes the shortest time for a complete item-order result or for any frequency-order result. "lazy" Perform only some the work concurrently before returning the first item from the indexes, and most of the work sequentially while iterating through the rest of the items. This usually takes the shortest time for a small item-order partial result. "concurrent" Perform the work concurrently in another thread. This is a hint to the query optimizer to help parallelize the lexicon work, allowing the calling query to continue performing other work while the lexicon processing occurs. This is especially useful in cases where multiple lexicon calls occur in the same query (for example, resolving many facets in a single query). "map" Return results as a JavaScript Object instead of as a Sequence.
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

This function returns a Sequence of Value objects, not native JavaScript values. In contexts where loose equality is sufficient (e.g. '==' operator), this distinction is transparent. However, in contexts where strict or "same value" equality applies (e.g. '===' operator, Array.prototype.includes, Array.prototype.indexOf), comparison between an item in the Sequence and an equivalent native value will fail. For details, see Value Object in the JavaScript Reference Guide.

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 "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 range index with that collation does not exist, an error is thrown.

If "sample=N" is not specified in the options parameter, then 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 values 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.

If neither "case-sensitive" nor "case-insensitive" is present, $pattern is used to determine case sensitivity. If $pattern contains no uppercase, it specifies "case-insensitive". If $pattern contains uppercase, it specifies "case-sensitive".

If neither "diacritic-sensitive" nor "diacritic-insensitive" is present, $pattern is used to determine diacritic sensitivity. If $pattern contains no diacritics, it specifies "diacritic-insensitive". If $pattern contains diacritics, it specifies "diacritic-sensitive".

Example

//  Assuming that there are path namespaces defined with the following prefixes:
//  my: http://aaa.com
//  his: http://bbb.com
//
//  Further assuming that a string path index is defined using the
//  above namespaces, in the codepoint collation, with the following path:
//  '/my:a[@his:b="B1"]/my:c'.

// load documents
declareUpdate();

xdmp.documentInsert("/abc1.xml", fn.head(xdmp.unquote(
   '<my:a his:b="B1" xmlns:my="http://aaa.com" \n\
          xmlns:his="http://bbb.com"><my:c>C1</my:c></my:a>')));
xdmp.documentInsert("/abc2.xml",  fn.head(xdmp.unquote(
   '<my:a his:b="B1" xmlns:my="http://aaa.com" \n\
          xmlns:his="http://bbb.com"><my:c>C2</my:c></my:a>')));
xdmp.documentInsert("/abc3.xml",  fn.head(xdmp.unquote(
   '<my:a his:b="B1" xmlns:my="http://aaa.com" \n\
          xmlns:his="http://bbb.com"><my:c>C3</my:c></my:a>')));

******

// The following requires the prefix "my" and "his" to be bound
// to the "http://aaa.com" and "http://bbb.com" namespaces
// in the Group configuration (for example,
// Groups => group_name => Namespaces in the Admin Interface).

cts.valueMatch(cts.pathReference('/my:a[@his:b="B1"]/my:c'), "?3");
  =>
    C3

MarkLogic Server 11.0 Product Documentationcts.valueMatch

Summary

Usage Notes

Example

MarkLogic Server 11.0 Product Documentation
cts.valueMatch