0c3b8b7e90
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.
109 lines
3.4 KiB
JSON
109 lines
3.4 KiB
JSON
{
|
|
"XTRIM": {
|
|
"summary": "Deletes messages from the beginning of a stream.",
|
|
"complexity": "O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.",
|
|
"group": "stream",
|
|
"since": "5.0.0",
|
|
"arity": -4,
|
|
"function": "xtrimCommand",
|
|
"history": [
|
|
[
|
|
"6.2.0",
|
|
"Added the `MINID` trimming strategy and the `LIMIT` option."
|
|
]
|
|
],
|
|
"command_flags": [
|
|
"WRITE"
|
|
],
|
|
"acl_categories": [
|
|
"STREAM"
|
|
],
|
|
"command_tips": [
|
|
"NONDETERMINISTIC_OUTPUT"
|
|
],
|
|
"key_specs": [
|
|
{
|
|
"flags": [
|
|
"RW",
|
|
"DELETE"
|
|
],
|
|
"begin_search": {
|
|
"index": {
|
|
"pos": 1
|
|
}
|
|
},
|
|
"find_keys": {
|
|
"range": {
|
|
"lastkey": 0,
|
|
"step": 1,
|
|
"limit": 0
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"arguments": [
|
|
{
|
|
"name": "key",
|
|
"type": "key",
|
|
"key_spec_index": 0
|
|
},
|
|
{
|
|
"name": "trim",
|
|
"type": "block",
|
|
"arguments": [
|
|
{
|
|
"name": "strategy",
|
|
"type": "oneof",
|
|
"arguments": [
|
|
{
|
|
"name": "maxlen",
|
|
"type": "pure-token",
|
|
"token": "MAXLEN"
|
|
},
|
|
{
|
|
"name": "minid",
|
|
"type": "pure-token",
|
|
"token": "MINID",
|
|
"since": "6.2.0"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "operator",
|
|
"type": "oneof",
|
|
"optional": true,
|
|
"arguments": [
|
|
{
|
|
"name": "equal",
|
|
"type": "pure-token",
|
|
"token": "="
|
|
},
|
|
{
|
|
"name": "approximately",
|
|
"type": "pure-token",
|
|
"token": "~"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "threshold",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"token": "LIMIT",
|
|
"name": "count",
|
|
"type": "integer",
|
|
"optional": true,
|
|
"since": "6.2.0"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"description": "The number of entries deleted from the stream.",
|
|
"type": "integer",
|
|
"minimum": 0
|
|
}
|
|
}
|
|
}
|