summaryrefslogtreecommitdiffstats
path: root/src/commands/spublish.json
blob: 16c948cc6f43a835e9112093857ff8c68afb6f5d (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
{
    "SPUBLISH": {
        "summary": "Post a message to a shard channel",
        "complexity": "O(N) where N is the number of clients subscribed to the receiving shard channel.",
        "group": "pubsub",
        "since": "7.0.0",
        "arity": 3,
        "function": "spublishCommand",
        "command_flags": [
            "PUBSUB",
            "LOADING",
            "STALE",
            "FAST",
            "MAY_REPLICATE"
        ],
        "arguments": [
            {
                "name": "shardchannel",
                "type": "string"
            },
            {
                "name": "message",
                "type": "string"
            }
        ],
        "key_specs": [
            {
                "flags": [
                    "NOT_KEY"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "description": "the number of clients that received the message. Note that in a Redis Cluster, only clients that are connected to the same node as the publishing client are included in the count",
            "type": "integer",
            "minimum": 0
        }
    }
}