githubmirror/redis

src/commands/zinter.json
115 строк4 KB
Itamar Haber
Overhauls command summaries and man pages. (#11942)
29 мар 2023, 20:48
29 мар 2023, 20:480c3b8b7
{
    "ZINTER": {
        "summary": "Returns the intersect of multiple sorted sets.",
        "complexity": "O(N*K)+O(M*log(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.",
        "group": "sorted_set",
        "since": "6.2.0",
        "arity": -3,
        "function": "zinterCommand",
        "get_keys_function": "zunionInterDiffGetKeys",
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "SORTEDSET"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "keynum": {
                        "keynumidx": 0,
                        "firstkey": 1,
                        "step": 1
                    }
                }
            }
        ],
        "reply_schema": {
            "anyOf": [
                {
                    "description": "Result of intersection, containing only the member names. Returned in case `WITHSCORES` was not used.",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                {
                    "description": "Result of intersection, containing members and their scores. Returned in case `WITHSCORES` was used. In RESP2 this is returned as a flat array",
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 2,
                        "maxItems": 2,
                        "items": [
                            {
                                "description": "Member",
                                "type": "string"
                            },
                            {
                                "description": "Score",
                                "type": "number"
                            }
                        ]
                    }
                }
            ]
        },
        "arguments": [
            {
                "name": "numkeys",
                "type": "integer"
            },
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0,
                "multiple": true
            },
            {
                "token": "WEIGHTS",
                "name": "weight",
                "type": "integer",
                "optional": true,
                "multiple": true
            },
            {
                "token": "AGGREGATE",
                "name": "aggregate",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "sum",
                        "type": "pure-token",
                        "token": "SUM"
                    },
                    {
                        "name": "min",
                        "type": "pure-token",
                        "token": "MIN"
                    },
                    {
                        "name": "max",
                        "type": "pure-token",
                        "token": "MAX"
                    }
                ]
            },
            {
                "name": "withscores",
                "token": "WITHSCORES",
                "type": "pure-token",
                "optional": true
            }
        ]
    }
}