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, timestamp) → {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 Argument Description valuesQueryobject a query built by a valuesBuilder timestampDatabaseClient.Timestamp <optional>
a Timestamp object for point-in-time operations - Since:
-
- 1.0
Returns:
an object whose result() function takes a success callback that receives the tuples.- Type
- ResultProvider