src/commands/function-stats.json - unstable - githubmirror/redis

src/commands/function-stats.json
81 строка3 KB
Itamar Haber
Overhauls command summaries and man pages. (#11942)
29 мар 2023, 20:48
29 мар 2023, 20:480c3b8b7
{
    "STATS": {
        "summary": "Returns information about a function during execution.",
        "complexity": "O(1)",
        "group": "scripting",
        "since": "7.0.0",
        "arity": 2,
        "container": "FUNCTION",
        "function": "functionStatsCommand",
        "command_flags": [
            "NOSCRIPT",
            "ALLOW_BUSY"
        ],
        "acl_categories": [
            "SCRIPTING"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT",
            "REQUEST_POLICY:ALL_SHARDS",
            "RESPONSE_POLICY:SPECIAL"
        ],
        "reply_schema": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "running_script": {
                    "description": "information about the running script.",
                    "oneOf": [
                        {
                            "description": "If there's no in-flight function",
                            "type": "null"
                        },
                        {
                            "description": "a map with the information about the running script",
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "name": {
                                    "description": "the name of the function.",
                                    "type": "string"
                                },
                                "command": {
                                    "description": "the command and arguments used for invoking the function.",
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "duration_ms": {
                                    "description": "the function's runtime duration in milliseconds.",
                                    "type": "integer"
                                }
                            }
                        }
                    ]
                },
                "engines": {
                    "description": "A map when each entry in the map represent a single engine.",
                    "type": "object",
                    "patternProperties": {
                        "^.*$": {
                            "description": "Engine map contains statistics about the engine",
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "libraries_count": {
                                    "description": "number of libraries",
                                    "type": "integer"
                                },
                                "functions_count": {
                                    "description": "number of functions",
                                    "type": "integer"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}