MarkLogic Server 11.0 Product Documentation

cts.jsonPropertyValueQuery

cts.jsonPropertyValueQuery(
   property-name as String[],
   value as (String | Number | Boolean | null | Array | Object)[],
   [options as String[]],
   [weight as Number?]
) as cts.jsonPropertyValueQuery

Summary

Returns a query matching JSON properties by name with value equal the given value. For arrays, the query matches if the value of any elements in the array matches the given value.

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.

Note that the text content for the value in a cts:json-property-value-query is treated the same as a phrase in a cts:word-query, where the phrase is the property value. Therefore, any wildcard and/or stemming rules are treated like a phrase. For example, if you have an property value of "hello friend" with wildcarding enabled for a query, a cts:json-property-value-query for "he*" will not match because the wildcard matches do not span word boundaries, but a cts:json-property-value-query for "hello *" will match. A search for "*" will match, because a "*" wildcard by itself is defined to match the value. Similarly, stemming rules are applied to each term, so a search for "hello friends" would match when stemming is enabled for the query because "friends" matches "friend". For an example, see the fourth example below.

Similarly, because a "*" wildcard by itself is defined to match the value, the following query will match any property with the name my-property, regardless of the wildcard indexes enabled in the database configuration:

cts:json-property-value-query("my-property", "*", "wildcarded")

Example

  cts.search(
    cts.jsonPropertyValueQuery(
      "function",
      "MarkLogic Corporation"));

  => .. relevance-ordered sequence of documents having 'function'
  properties whose text content equals 'MarkLogic Corporation'.

Example

  cts.search(
    cts.jsonPropertyValueQuery(
      "function",
      "MarkLogic Corporation", "case-insensitive"));

  => .. relevance-ordered sequence of documents having 'function'
  properties whose text content equals 'MarkLogic Corporation',
  or any other case-shift like 'MARKLOGIC CorpoRation'.

Example

  cts.search(
    cts.andQuery([
      cts.jsonPropertyValueQuery(
        "function",
        "MarkLogic Corporation",
        "punctuation-insensitive", 0.5),
      cts.jsonPropertyValueQuery(
        "title",
        "Word Query")]));
  => .. relevance-ordered sequence of documents which have both:

  (a) 'function' properties with text content equal to
      'MarkLogic Corporation', ignoring embedded
      punctuation,
  AND
  (b) 'title' properties with text content equal to
      'Word Query', with the results of the first sub-query
      query given weight 0.5, and the results of the second
      sub-query given the default weight 1.0.  As a result,
      the title phrase 'Word Query' counts more heavily
      towards the relevance score.

Example

// for a document foo.json with content like {"foo" : 1}
cts.contains(cts.doc("foo.json"), cts.jsonPropertyValueQuery("foo",1));

=> true