diff --git a/Documentation/ImplementorManual/HttpIndexGeo.md b/Documentation/ImplementorManual/HttpIndexGeo.md new file mode 100644 index 0000000000..8867a29b11 --- /dev/null +++ b/Documentation/ImplementorManual/HttpIndexGeo.md @@ -0,0 +1,15 @@ +Accessing Geo Indexes via Http {#IndexGeoHttp} +============================================== + +@EMBEDTOC{IndexGeoHttpTOC} + +@anchor IndexGeoHttpEnsureGeo +@copydetails JSF_POST_api_index_geo + +@CLEARPAGE +@anchor IndexGeoHttpNear +@copydetails JSA_PUT_api_simple_near + +@CLEARPAGE +@anchor IndexGeoHttpWithin +@copydetails JSA_PUT_api_simple_within diff --git a/Documentation/ImplementorManual/HttpIndexGeoTOC.md b/Documentation/ImplementorManual/HttpIndexGeoTOC.md new file mode 100644 index 0000000000..9163cf136b --- /dev/null +++ b/Documentation/ImplementorManual/HttpIndexGeoTOC.md @@ -0,0 +1,7 @@ +TOC {#IndexGeoHttpTOC} +====================== + +- @ref IndexGeoHttp + - @ref IndexGeoHttpEnsureGeo "POST /_api/index" + - @ref IndexGeoHttpNear "PUT /_api/simple/near" + - @ref IndexGeoHttpWithin "PUT /_api/simple/within" diff --git a/Documentation/UserManual/IndexGeo.md b/Documentation/UserManual/IndexGeo.md new file mode 100644 index 0000000000..993cf28c9d --- /dev/null +++ b/Documentation/UserManual/IndexGeo.md @@ -0,0 +1,43 @@ +Geo Indexes {#IndexGeo} +======================= + +@EMBEDTOC{IndexGeoTOC} + +Geo Indexes {#IndexGeoIntro} +============================ + +This is an introduction to ArangoDB's geo indexes. + +ArangoDB uses Hilbert curves to implement geo-spatial indexes. See this blog +for details. + +A geo-spatial index assumes that the latitude is between -90 and 90 degree and +the longitude is between -180 and 180 degree. A geo index will ignore all +documents which do not fulfill these requirements. + +A geo-spatial constraint makes the same assumptions, but documents not +fulfilling these requirements are rejected. + +Accessing Geo Indexes from the Shell {#IndexGeoShell} +===================================================== + +@anchor IndexGeoShellEnsureGeoIndex +@copydetails JS_EnsureGeoIndexVocbaseCol + +@CLEARPAGE +@anchor IndexGeoShellEnsureGeoConstraint +@copydetails JS_EnsureGeoConstraintVocbaseCol + +@CLEARPAGE +@anchor IndexGeoShellGeo +@copydetails JSF_ArangoCollection_prototype_geo + +@CLEARPAGE +@anchor IndexGeoShellNear +@copydetails JSF_ArangoCollection_prototype_near + +@CLEARPAGE +@anchor IndexGeoShellWithin +@copydetails JSF_ArangoCollection_prototype_within + diff --git a/Documentation/UserManual/IndexGeoTOC.md b/Documentation/UserManual/IndexGeoTOC.md new file mode 100644 index 0000000000..b4d020c65e --- /dev/null +++ b/Documentation/UserManual/IndexGeoTOC.md @@ -0,0 +1,11 @@ +TOC {#IndexGeoTOC} +================== + +- @ref IndexGeo + - @ref IndexGeoIntro + - @ref IndexGeoShell + - @ref IndexGeoShellEnsureGeoIndex "collection.ensureGeoIndex" + - @ref IndexGeoShellEnsureGeoConstraint "collection.ensureGeoConstraint" + - @ref IndexGeoShellGeo "collection.geo" + - @ref IndexGeoShellNear "collection.near" + - @ref IndexGeoShellWithin "collection.within" diff --git a/arangod/Documentation/index-geo.dox b/arangod/Documentation/index-geo.dox deleted file mode 100644 index 9091385641..0000000000 --- a/arangod/Documentation/index-geo.dox +++ /dev/null @@ -1,128 +0,0 @@ -//////////////////////////////////////////////////////////////////////////////// -/// @brief indexes -/// -/// @file -/// -/// DISCLAIMER -/// -/// Copyright 2012 triagens GmbH, Cologne, Germany -/// -/// Licensed under the Apache License, Version 2.0 (the "License"); -/// you may not use this file except in compliance with the License. -/// You may obtain a copy of the License at -/// -/// http://www.apache.org/licenses/LICENSE-2.0 -/// -/// Unless required by applicable law or agreed to in writing, software -/// distributed under the License is distributed on an "AS IS" BASIS, -/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -/// See the License for the specific language governing permissions and -/// limitations under the License. -/// -/// Copyright holder is triAGENS GmbH, Cologne, Germany -/// -/// @author Dr. Frank Celler -/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexGeoTOC -/// -/// -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexGeo Geo Indexes -/// -/// This is an introduction to ArangoDB's geo indexes. -/// -/// @EMBEDTOC{IndexGeoTOC} -/// -/// @section IndexGeoIntro Geo Indexes -////////////////////////////////////// -/// -/// ArangoDB uses Hilbert curves to implement geo-spatial indexes. See this -/// blog -/// for details. -/// -/// A geo-spatial index assumes that the latitude is between -90 and -/// 90 degree and the longitude is between -180 and 180 degree. A geo -/// index will ignore all documents which do not fulfill these -/// requirements. -/// -/// A geo-spatial constraint makes the same assumptions, but documents -/// not fulfilling these requirements are rejected. -/// -/// @section IndexGeoShell Accessing Geo Indexes from the Shell -/////////////////////////////////////////////////////////////// -/// -/// @anchor IndexGeoShellEnsureGeoIndex -/// @copydetails JS_EnsureGeoIndexVocbaseCol -///
-/// -/// @anchor IndexGeoShellEnsureGeoConstraint -/// @copydetails JS_EnsureGeoConstraintVocbaseCol -///
-/// -/// @anchor IndexGeoShellGeo -/// @copydetails JSF_ArangoCollection_prototype_geo -///
-/// -/// @anchor IndexGeoShellNear -/// @copydetails JSF_ArangoCollection_prototype_near -///
-/// -/// @anchor IndexGeoShellWithin -/// @copydetails JSF_ArangoCollection_prototype_within -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexGeoHttpTOC -/// -/// -//////////////////////////////////////////////////////////////////////////////// - -//////////////////////////////////////////////////////////////////////////////// -/// @page IndexGeoHttp Accessing Geo Indexes via Http -/// -/// @EMBEDTOC{IndexGeoHttpTOC} -/// -/// @anchor IndexGeoHttpEnsureGeo -/// @copydetails JSF_POST_api_index_geo -/// -/// @anchor IndexGeoHttpNear -/// @copydetails JSA_PUT_api_simple_near -/// -/// @anchor IndexGeoHttpWithin -/// @copydetails JSA_PUT_api_simple_within -//////////////////////////////////////////////////////////////////////////////// - -// Local Variables: -// mode: c++ -// mode: outline-minor -// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)" -// End: