From 72dc42c04413f94f47c265a198772e5551f38ec4 Mon Sep 17 00:00:00 2001 From: Julie Tibshirani Date: Mon, 20 Jul 2020 16:29:32 -0700 Subject: [PATCH] Add 'point' to the top-level field type docs. (#59731) Before it was missing from the list. This PR also renames the 'geo data types' section to 'spatial data types' and consolidates the geo and cartesian types into that section. --- docs/reference/mapping/types.asciidoc | 8 +++++--- docs/reference/mapping/types/geo-shape.asciidoc | 2 +- docs/reference/mapping/types/point.asciidoc | 12 ++++++------ docs/reference/mapping/types/shape.asciidoc | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/reference/mapping/types.asciidoc b/docs/reference/mapping/types.asciidoc index bf4c262b81c38..5d899797b5929 100644 --- a/docs/reference/mapping/types.asciidoc +++ b/docs/reference/mapping/types.asciidoc @@ -22,10 +22,12 @@ string:: <>, <> and <>:: `nested` for arrays of JSON objects [float] -=== Geo data types +=== Spatial data types <>:: `geo_point` for lat/lon points <>:: `geo_shape` for complex shapes like polygons +<>:: `point` for arbitrary cartesian points. +<>:: `shape` for arbitrary cartesian geometries. [float] === Specialised data types @@ -56,8 +58,6 @@ string:: <>, <> and <>:: Allows an entire JSON object to be indexed as a single field. -<>:: `shape` for arbitrary cartesian geometries. - <>:: `histogram` for pre-aggregated numerical values for percentiles aggregations. <>:: Specialization of `keyword` for the case when all documents have the same value. @@ -119,6 +119,8 @@ include::types/object.asciidoc[] include::types/percolator.asciidoc[] +include::types/point.asciidoc[] + include::types/range.asciidoc[] include::types/rank-feature.asciidoc[] diff --git a/docs/reference/mapping/types/geo-shape.asciidoc b/docs/reference/mapping/types/geo-shape.asciidoc index 46320bba254c8..cfbe6b8294fd3 100644 --- a/docs/reference/mapping/types/geo-shape.asciidoc +++ b/docs/reference/mapping/types/geo-shape.asciidoc @@ -190,7 +190,7 @@ are provided: |Strategy |Supported Shapes |Supported Queries |Multiple Shapes |`recursive` |<> |`INTERSECTS`, `DISJOINT`, `WITHIN`, `CONTAINS` |Yes -|`term` |<> |`INTERSECTS` |Yes +|`term` |<> |`INTERSECTS` |Yes |======================================================================= diff --git a/docs/reference/mapping/types/point.asciidoc b/docs/reference/mapping/types/point.asciidoc index d26d2e83126d1..3e2b8b900c9b3 100644 --- a/docs/reference/mapping/types/point.asciidoc +++ b/docs/reference/mapping/types/point.asciidoc @@ -60,16 +60,16 @@ PUT my_index/_doc/5 <1> Point expressed as an object, with `x` and `y` keys. <2> Point expressed as a string with the format: `"x,y"`. -<4> Point expressed as an array with the format: [ `x`, `y`] -<5> Point expressed as a http://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text] +<3> Point expressed as an array with the format: [ `x`, `y`] +<4> Point expressed as a http://docs.opengeospatial.org/is/12-063r5/12-063r5.html[Well-Known Text] POINT with the format: `"POINT(x y)"` The coordinates provided to the indexer are single precision floating point values so the field guarantees the same accuracy provided by the java virtual machine (typically `1E-38`). -[[geo-point-params]] -==== Parameters for `geo_point` fields +[[point-params]] +==== Parameters for `point` fields The following parameters are accepted by `point` fields: @@ -92,8 +92,8 @@ The following parameters are accepted by `point` fields: Accepts an point value which is substituted for any explicit `null` values. Defaults to `null`, which means the field is treated as missing. -==== Sorting and Retrieving index Shapes +==== Sorting and retrieving points -It is currently not possible to sort shapes or retrieve their fields +It is currently not possible to sort points or retrieve their fields directly. The `point` value is only retrievable through the `_source` field. diff --git a/docs/reference/mapping/types/shape.asciidoc b/docs/reference/mapping/types/shape.asciidoc index 049e10228dbb1..c8d10dcd4c20b 100644 --- a/docs/reference/mapping/types/shape.asciidoc +++ b/docs/reference/mapping/types/shape.asciidoc @@ -129,7 +129,7 @@ within coordinate arrays. This differs from many Geospatial APIs (e.g., `geo_sha typically use the colloquial latitude, longitude (Y, X) ordering. ============================================= -[[point]] +[[point-shape]] [float] ===== http://geojson.org/geojson-spec.html#id2[Point]