Namespace: values

values

Provides functions to project tuples (aka rows) of values out of documents. The values for the tuples come from JSON properties, XML elements or attributes, fields, or paths in the documents that have range or geospatial indexes. Values can also come from the collection or uri index. Each co-occurrence of the specified indexes in a document produces a tuple. For instance, if one JSON property occurs twice in a document but another occurs only once, the result will include two tuples: that is, one co-occurrence for each value of the first property with the value of the second property.

Methods


read(valuesQuery) → {ResultProvider}

Executes a values query built by a valuesBuilder to read tuples from the specified indexes for the documents qualified by the query.
Parameters:
Name Type Description
valuesQuery object a query built by a valuesBuilder
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the tuples.
Type
ResultProvider
Copyright 2014-2017 MarkLogic Corporation Documentation generated by JSDoc 3.4.3 on 2017-07-14T11:04:01-07:00 using the DocStrap template.