OpenSearch/docs/reference
Florian Schilling 464037e0c1 Geo clean Up
============
The default unit for measuring distances is *MILES* in most cases. This commit moves ES
over to the *International System of Units* and make it work on a default which relates
to *METERS* . Also the current structures of the `GeoBoundingBox Filter` changed in
order to define the *Bounding* by setting abitrary corners.

Distances
---------
Since the default unit for measuring distances has changed to a default unit
`DistanceUnit.DEFAULT` relating to *meters*, the **REST API** has changed at the
following places:

  * `ScriptDocValues.factorDistance()` returns *meters* instead of *miles*
  * `ScriptDocValues.factorDistanceWithDefault()` returns *meters* instead of *miles*
  * `ScriptDocValues.arcDistance()` returns *meters* instead of *miles*
        one might use `ScriptDocValues.arcDistanceInMiles()`
  * `ScriptDocValues.arcDistanceWithDefault()` returns *meters* instead of *miles*
  * `ScriptDocValues.distance()` returns *meters* instead of *miles*
        one might use `ScriptDocValues.distanceInMiles()`
  * `ScriptDocValues.distanceWithDefault()` returns *meters* instead of *miles*
        one might use `ScriptDocValues.distanceInMilesWithDefault()`
  * `GeoDistanceFilter` default unit changes from *kilometers* to *meters*
  * `GeoDistanceRangeFilter` default unit changes from *miles* to *meters*
  * `GeoDistanceFacet` default unit changes from *miles* to *meters*

Geo Bounding Box Filter
-----------------------
The naming of the GeoBoundingBoxFilter properties allows to set arbitrary corners
(see #4084) namely `top_right`, `top_left`, `bottom_right` and `bottom_left`. This
change also includes the fields `topRight` and `bottomLeft` Also it is be possible to
set the single values by using just `top`, `bottom`, `left` and `right` parameters.

Closes #4515, #4084
2014-01-11 21:30:29 +09:00
..
analysis Wrong link to Token Filter 2013-12-03 10:39:13 +01:00
cat [DOCS] Linked cat-pending to cluster-pending 2013-12-02 15:29:47 +01:00
cluster Expose min/max open file descriptors in Cluster Stats API 2014-01-10 12:15:56 +01:00
docs Cleanup comments and class names s/ElasticSearch/Elasticsearch 2014-01-07 11:21:51 +01:00
images add docs on new service.bat facility 2013-09-23 18:24:31 +03:00
index-modules randomize flush interval so multiple shards won't flush at the sam time 2014-01-07 19:58:28 +01:00
indices remove bloom from clear cache API, add id_cache 2014-01-09 21:08:45 +01:00
mapping Deprecate document _boost 2014-01-09 16:04:01 +01:00
modules [DOCS] Added documentation for SameShardAllocationDecider 2014-01-09 11:24:12 +01:00
query-dsl Geo clean Up 2014-01-11 21:30:29 +09:00
search Geo clean Up 2014-01-11 21:30:29 +09:00
setup Cleanup comments and class names s/ElasticSearch/Elasticsearch 2014-01-07 11:21:51 +01:00
testing [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00
analysis.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
api-conventions.asciidoc Geo clean Up 2014-01-11 21:30:29 +09:00
cat.asciidoc Document h/headers switcheroo. 2014-01-06 16:08:48 -06:00
cluster.asciidoc [DOCS] Fix HTTP endpoints after stats API changes 2014-01-09 11:30:28 +01:00
docs.asciidoc [DOCS] Reorganised common API conventions 2013-10-13 16:46:56 +02:00
glossary.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
index-modules.asciidoc Remove 'term_index_interval' and 'term_index_divisor' 2013-12-10 16:54:08 +01:00
index.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00
indices.asciidoc Add a GetFieldMapping API 2013-10-30 16:16:36 +01:00
mapping.asciidoc Cleanup comments and class names s/ElasticSearch/Elasticsearch 2014-01-07 11:21:51 +01:00
modules.asciidoc make term statistics accessible in scripts 2014-01-02 11:17:33 +01:00
query-dsl.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
search.asciidoc Cleanup comments and class names s/ElasticSearch/Elasticsearch 2014-01-07 11:21:51 +01:00
setup.asciidoc Cleanup comments and class names s/ElasticSearch/Elasticsearch 2014-01-07 11:21:51 +01:00
testing.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00