XQuery cts:element-attribute-value-query

MarkLogic 10 Product Documentation
cts.elementAttributeValueQuery

cts.elementAttributeValueQuery(
   element-name as xs.QName[],
   attribute-name as xs.QName[],
   text as String[],
   [options as String[]],
   [weight as Number?]
) as cts.elementAttributeValueQuery

Summary

Returns a query matching elements by name with attributes by name with text content equal a given phrase.

Parameters
element-name One or more element QNames to match. When multiple QNames are specified, the query matches if any QName matches.
attribute-name One or more attribute QNames to match. When multiple QNames are specified, the query matches if any QName matches.
text One or more attribute values to match. When multiple strings are specified, the query matches if any string matches.
options Options to this query. The default is ().

Options include:

"case-sensitive"
A case-sensitive query.
"case-insensitive"
A case-insensitive query.
"diacritic-sensitive"
A diacritic-sensitive query.
"diacritic-insensitive"
A diacritic-insensitive query.
"punctuation-sensitive"
A punctuation-sensitive query.
"punctuation-insensitive"
A punctuation-insensitive query.
"whitespace-sensitive"
A whitespace-sensitive query.
"whitespace-insensitive"
A whitespace-insensitive query.
"stemmed"
A stemmed query.
"unstemmed"
An unstemmed query.
"wildcarded"
A wildcarded query.
"unwildcarded"
An unwildcarded query.
"exact"
An exact match query. Shorthand for "case-sensitive", "diacritic-sensitive", "punctuation-sensitive", "whitespace-sensitive", "unstemmed", and "unwildcarded".
"lang=iso639code"
Specifies the language of the query. The iso639code code portion is case-insensitive, and uses the languages specified by ISO 639. The default is specified in the database configuration.
"min-occurs=number"
Specifies the minimum number of occurrences required. If fewer that this number of words occur, the fragment does not match. The default is 1.
"max-occurs=number"
Specifies the maximum number of occurrences required. If more than this number of words occur, the fragment does not match. The default is unbounded.
"synonym"
Specifies that all of the terms in the $text parameter are considered synonyms for scoring purposes. The result is that occurrences of more than one of the synonyms are scored as if there are more occurrences of the same term (as opposed to having a separate term that contributes to score).
*
"lexicon-expansion-limit=number"
Specifies the limit for lexicon expansion. This puts a restriction on the number of lexicon expansions that can be performed. If the limit is exceeded, the server may raise an error depending on whether the "limit-check" option is set. The default value for this option will be 4096.
"limit-check"
Specifies that an error will be raised if the lexicon expansion exceeds the specified limit.
"no-limit-check"
Specifies that error will not be raised if the lexicon expansion exceeds the specified limit. The server will try to resolve the wildcard.
weight A weight for this query. Higher weights move search results up in the relevance order. The default is 1.0. The weight should be between 64 and -16. Weights greater than 64 will have the same effect as a weight of 64. Weights less than the absolute value of 0.0625 (between -0.0625 and 0.0625) are rounded to 0, which means that they do not contribute to the score.

Usage Notes

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

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

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

If neither "whitespace-sensitive" nor "whitespace-insensitive" is present, the query is "whitespace-insensitive".

If neither "wildcarded" nor "unwildcarded" is present, the database configuration and $text determine wildcarding. If the database has any wildcard indexes enabled ("three character searches", "two character searches", "one character searches", or "trailing wildcard searches") and if $text contains either of the wildcard characters '?' or '*', it specifies "wildcarded". Otherwise it specifies "unwildcarded".

If neither "stemmed" nor "unstemmed" is present, the database configuration determines stemming. If the database has "stemmed searches" enabled, it specifies "stemmed". Otherwise it specifies "unstemmed". If the query is a wildcarded query and also a phrase query (contains two or more terms), the wildcard terms in the query are unstemmed.

When you use the "exact" option, you should also enable "fast case sensitive searches" and "fast diacritic sensitive searches" in your database configuration.

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.

When multiple element and/or attribute QNames are specified, then all possible element/attribute QName combinations are used to select the matching values.

Example

  cts.search(
    cts.elementAttributeValueQuery(
      xs.QName("function"),
      xs.QName("type"),
      "MarkLogic Corporation"));

  => .. relevance-ordered sequence of documents
  having 'function' elements that have
  an attribute 'type' whose value equals 'MarkLogic
  Corporation'.

Example

  cts.search(
    cts.andQuery([
      cts.elementAttributeValueQuery(
        xs.QName("function"),
        xs.QName("type"),
        "MarkLogic Corporation",
        null, 0.5),
      cts.elementWordQuery(
        xs.QName("title"),
        "faster")]));

  => .. relevance-ordered sequence documents having both:
   (a) 'function' elements with attribute 'type' whose
       value equals the string 'MarkLogic Corporation',
       ignoring embedded punctuation,
   AND
   (b) 'title' elements whose text content contains the
       word 'faster', with the results from (a) given
       weight 0.5, and the results from (b) given default
       weight 1.0.
Powered by MarkLogic Server | Terms of Use | Privacy Policy