summaryrefslogtreecommitdiff
path: root/src/commands/geodist.json
blob: 97969d332c77ed1c0e5776923ed2554f9d6a6d7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
{
    "GEODIST": {
        "summary": "Returns the distance between two members of a geospatial index.",
        "complexity": "O(log(N))",
        "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]*)?$"
                }
            ]
        }
    }
}