.::Undergrounds v3.3 Webshells::.

: / opt / redis-8 / src / commands /
Filename : hscan.json
back
{
    "HSCAN": {
        "summary": "Iterates over fields and values of a hash.",
        "complexity": "O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.",
        "group": "hash",
        "since": "2.8.0",
        "arity": -3,
        "function": "hscanCommand",
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "HASH"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "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": "cursor",
                "type": "integer"
            },
            {
                "token": "MATCH",
                "name": "pattern",
                "type": "pattern",
                "optional": true
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            },
            {
                "token": "NOVALUES",
                "name": "novalues",
                "type": "pure-token",
                "optional": true
            }
        ],
        "reply_schema": {
            "description": "cursor and scan response in array form",
            "type": "array",
            "minItems": 2,
            "maxItems": 2,
            "items": [
                {
                    "description": "cursor",
                    "type": "string"
                },
                {
                    "description": "list of key/value pairs from the hash where each even element is the key, and each odd element is the value, or when novalues option is on, a list of keys from the hash",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            ]
        }
    }
}