Skip to content

Commit 0a6efcb

Browse files
DOC-2761 limitations section, fixes and note in geo data type page
1 parent 4057de1 commit 0a6efcb

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

content/develop/data-types/geospatial.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ weight: 80
2020
Redis geospatial indexes let you store coordinates and search for them.
2121
This data structure is useful for finding nearby points within a given radius or bounding box.
2222

23+
{{< note >}}Take care not to confuse the Geospatial data type with the
24+
[Geospatial]({{< relref "/develop/interact/search-and-query/advanced-concepts/geo" >}})
25+
features in [Redis Query Engine]({{< relref "/develop/interact/search-and-query" >}}).
26+
Although there are some similarities between these two features, the data type is intended
27+
for simpler use cases and doesn't have the range of format options and queries
28+
available in Redis Query Engine.
29+
{{< /note >}}
30+
2331
## Basic commands
2432

2533
* [`GEOADD`]({{< relref "/commands/geoadd" >}}) adds a location to a given geospatial index (note that longitude comes before latitude with this command).

content/develop/interact/search-and-query/advanced-concepts/geo.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,13 @@ See
190190
for more information about these query types and see
191191
[Geospatial indexing]({{< relref "/develop/interact/search-and-query/indexing/geoindex" >}})
192192
for examples of indexing `GEOSHAPE` fields.
193+
194+
## Limitations of geographical coordinates
195+
196+
Planet Earth is actually shaped more like an
197+
[ellipsoid](https://en.wikipedia.org/wiki/Earth_ellipsoid) than a perfect sphere.
198+
The spherical coordinate system used by Redis Query Engine is a close
199+
approximation to the shape of the Earth but not exact. For most practical
200+
uses of geospatial queries, the approximation works very well, but you
201+
shouldn't rely on it if you need very precise location data (for example, to track
202+
the GPS locations of boats in an emergency response system).

content/develop/interact/search-and-query/indexing/geoindex.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ categories:
99
- oss
1010
- kubernetes
1111
- clients
12-
description: How to index and search geospatial data
13-
linkTitle: Geo indexing
12+
description: Options for indexing geospatial data
13+
linkTitle: Geospatial
1414
title: Geospatial indexing
1515
weight: 3
1616
---
@@ -32,9 +32,8 @@ reference page for a full description of both types.
3232

3333
## `GEO`
3434

35-
The following [`redis-cli`]({{< relref "/develop/tools/cli" >}}) command
36-
creates a `GEO` index for JSON objects that contain the geospatial data
37-
in a field called `location`:
35+
The following command creates a `GEO` index for JSON objects that contain
36+
the geospatial data in a field called `location`:
3837

3938
```bash
4039
> FT.CREATE productidx ON JSON PREFIX 1 product: SCHEMA $.location AS location GEO

0 commit comments

Comments
 (0)