summaryrefslogtreecommitdiffstats
path: root/src/commands/geodist.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/geodist.json')
-rw-r--r--src/commands/geodist.json91
1 files changed, 91 insertions, 0 deletions
diff --git a/src/commands/geodist.json b/src/commands/geodist.json
new file mode 100644
index 0000000..145ca71
--- /dev/null
+++ b/src/commands/geodist.json
@@ -0,0 +1,91 @@
+{
+ "GEODIST": {
+ "summary": "Returns the distance between two members of a geospatial index.",
+ "complexity": "O(1)",
+ "group": "geo",
+ "since": "3.2.0",
+ "arity": -4,
+ "function": "geodistCommand",
+ "command_flags": [
+ "READONLY"
+ ],
+ "acl_categories": [
+ "GEO"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RO",
+ "ACCESS"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": 0,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0
+ },
+ {
+ "name": "member1",
+ "type": "string"
+ },
+ {
+ "name": "member2",
+ "type": "string"
+ },
+ {
+ "name": "unit",
+ "type": "oneof",
+ "optional": true,
+ "arguments": [
+ {
+ "name": "m",
+ "type": "pure-token",
+ "token": "m"
+ },
+ {
+ "name": "km",
+ "type": "pure-token",
+ "token": "km"
+ },
+ {
+ "name": "ft",
+ "type": "pure-token",
+ "token": "ft"
+ },
+ {
+ "name": "mi",
+ "type": "pure-token",
+ "token": "mi"
+ }
+ ]
+ }
+ ],
+ "reply_schema": {
+ "oneOf": [
+ {
+ "description": "one or both of elements are missing",
+ "type": "null"
+ },
+ {
+ "description": "distance as a double (represented as a string) in the specified units",
+ "type": "string",
+ "pattern": "^[0-9]*(.[0-9]*)?$"
+ }
+ ]
+ }
+ }
+}