XQuery cts:geospatial-json-property-pair-reference

MarkLogic 10 Product Documentation
cts.geospatialJsonPropertyPairReference

cts.geospatialJsonPropertyPairReference(
   property as String,
   lat as String,
   long as String,
   [options as String[]]
) as cts.reference

Summary

Creates a reference to a geospatial JSON property pair range index, for use as a parameter to cts.valueTuples. This function will throw an exception if the specified range index does not exist.

Parameters
property A JSON property name.
lat A JSON property name.
long A JSON property name.
options Options. The default is ().

Options include:

"type=type"
Use the lexicon with the type specified by type (point or long-lat-point)
"coordinate-system=name"
Use the given coordinate system. Possible values Allowed values: "wgs84", "wgs84/double", "etrs89", "etrs89/double", "raw", "raw/double".
"precision=value"
Use the coordinate system at the given precision. Allowed values: float and double.
"nullable"
Allow null values in tuples reported from cts.valueTuples when using this lexicon.
"unchecked"
Read the scalar type and coordinate-system info only from the input. Do not check the definition against the context database.

Usage Notes

The value of the precision option takes precedence over that implied by the governing coordinate system name, including the value of the coordinate-system option. For example, if the governing coordinate system is "wgs84/double" and the precision option is "float", then the reference uses single precision. An exception is thrown if an index with the specified precision does not exist.

See Also

Example

cts.geospatialJsonPropertyPairReference("pt", "lat", "long")

=> cts.geospatialJsonPropertyPairReference("pt", lat", "long",
     ["type=point","coordinate-system=wgs84"])
Powered by MarkLogic Server | Terms of Use | Privacy Policy