summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/geopos.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/geopos.md')
-rw-r--r--iredis/data/commands/geopos.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/iredis/data/commands/geopos.md b/iredis/data/commands/geopos.md
new file mode 100644
index 0000000..14b941c
--- /dev/null
+++ b/iredis/data/commands/geopos.md
@@ -0,0 +1,28 @@
+Return the positions (longitude,latitude) of all the specified members of the
+geospatial index represented by the sorted set at _key_.
+
+Given a sorted set representing a geospatial index, populated using the `GEOADD`
+command, it is often useful to obtain back the coordinates of specified members.
+When the geospatial index is populated via `GEOADD` the coordinates are
+converted into a 52 bit geohash, so the coordinates returned may not be exactly
+the ones used in order to add the elements, but small errors may be introduced.
+
+The command can accept a variable number of arguments so it always returns an
+array of positions even when a single element is specified.
+
+@return
+
+@array-reply, specifically:
+
+The command returns an array where each element is a two elements array
+representing longitude and latitude (x,y) of each member name passed as argument
+to the command.
+
+Non existing elements are reported as NULL elements of the array.
+
+@examples
+
+```cli
+GEOADD Sicily 13.361389 38.115556 "Palermo" 15.087269 37.502669 "Catania"
+GEOPOS Sicily Palermo Catania NonExisting
+```