In a few previous PR's we restructured the ES|QL docs to make it possible to generate them dynamically. This PR just moves a few files around to make the query languages docs easier to work with, and a little more organized like the ES|QL docs. A bit part of this was setting up redirects to the new locations, so other repo's could correctly link to the elasticsearch docs.
3.5 KiB
navigation_title | mapped_pages | |
---|---|---|
Point |
|
Point field type [point]
The point
data type facilitates the indexing of and searching arbitrary x, y
pairs that fall in a 2-dimensional planar coordinate system.
You can query documents using this type using shape Query.
As with geo_shape and geo_point, point
can be specified in GeoJSON and Well-Known Text formats. However, there are a number of additional formats that are supported for convenience and historical reasons. In total there are five ways that a cartesian point may be specified, as demonstrated below:
PUT my-index-000001
{
"mappings": {
"properties": {
"location": {
"type": "point"
}
}
}
}
PUT my-index-000001/_doc/1
{
"text": "Point as an object using GeoJSON format",
"location": { <1>
"type": "Point",
"coordinates": [-71.34, 41.12]
}
}
PUT my-index-000001/_doc/2
{
"text": "Point as a WKT POINT primitive",
"location" : "POINT (-71.34 41.12)" <2>
}
PUT my-index-000001/_doc/3
{
"text": "Point as an object with 'x' and 'y' keys",
"location": { <3>
"x": -71.34,
"y": 41.12
}
}
PUT my-index-000001/_doc/4
{
"text": "Point as an array",
"location": [ -71.34, 41.12 ] <4>
}
PUT my-index-000001/_doc/5
{
"text": "Point as a string",
"location": "-71.34,41.12" <5>
}
- Point expressed as an object, in GeoJSON format, with
type
andcoordinates
keys. - Point expressed as a Well-Known Text POINT with the format:
"POINT(x y)"
- Point expressed as an object, with
x
andy
keys. - Point expressed as an array with the format: [
x
,y
] - Point expressed as a string with the format:
"x,y"
.
::::{note}
Unlike the case with the geo-point field type, the order of the coordinates x
and y
is the same for all formats above.
::::
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
).
Parameters for point
fields [point-params]
The following parameters are accepted by point
fields:
ignore_malformed
- If
true
, malformed points are ignored. Iffalse
(default), malformed points throw an exception and reject the whole document. ignore_z_value
- If
true
(default) three dimension points will be accepted (stored in source) but only x and y values will be indexed; the third dimension is ignored. Iffalse
, points containing any more than x and y (two dimensions) values throw an exception and reject the whole document. null_value
- Accepts an point value which is substituted for any explicit
null
values. Defaults tonull
, which means the field is treated as missing.
Sorting and retrieving points [_sorting_and_retrieving_points]
It is currently not possible to sort points or retrieve their fields directly. The point
value is only retrievable through the _source
field.