redis/src/commands/zinterstore.json
Itamar Haber 0c3b8b7e90
Overhauls command summaries and man pages. (#11942)
This is an attempt to normalize/formalize command summaries.

Main actions performed:

* Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands.
* Starts with "An internal command...", "A container command...", etc... when applicable.
* Always uses periods.
* Refrains from referring to other commands. If this is needed, backquotes should be used for command names.
* Tries to be very clear about the data type when applicable.
* Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed."
* Prefers being terse over verbose.
* Tries to be consistent.
2023-03-29 20:48:59 +03:00

108 lines
3.1 KiB
JSON

{
"ZINTERSTORE": {
"summary": "Stores the intersect of multiple sorted sets in a key.",
"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": "2.0.0",
"arity": -4,
"function": "zinterstoreCommand",
"get_keys_function": "zunionInterDiffStoreGetKeys",
"command_flags": [
"WRITE",
"DENYOOM"
],
"acl_categories": [
"SORTEDSET"
],
"key_specs": [
{
"flags": [
"OW",
"UPDATE"
],
"begin_search": {
"index": {
"pos": 1
}
},
"find_keys": {
"range": {
"lastkey": 0,
"step": 1,
"limit": 0
}
}
},
{
"flags": [
"RO",
"ACCESS"
],
"begin_search": {
"index": {
"pos": 2
}
},
"find_keys": {
"keynum": {
"keynumidx": 0,
"firstkey": 1,
"step": 1
}
}
}
],
"reply_schema": {
"description": "Number of elements in the resulting sorted set.",
"type": "integer",
"minimum": 0
},
"arguments": [
{
"name": "destination",
"type": "key",
"key_spec_index": 0
},
{
"name": "numkeys",
"type": "integer"
},
{
"name": "key",
"type": "key",
"key_spec_index": 1,
"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"
}
]
}
]
}
}