summaryrefslogtreecommitdiffstats
path: root/src/commands/lmpop.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/lmpop.json')
-rw-r--r--src/commands/lmpop.json100
1 files changed, 100 insertions, 0 deletions
diff --git a/src/commands/lmpop.json b/src/commands/lmpop.json
new file mode 100644
index 0000000..7cc3476
--- /dev/null
+++ b/src/commands/lmpop.json
@@ -0,0 +1,100 @@
+{
+ "LMPOP": {
+ "summary": "Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.",
+ "complexity": "O(N+M) where N is the number of provided keys and M is the number of elements returned.",
+ "group": "list",
+ "since": "7.0.0",
+ "arity": -4,
+ "function": "lmpopCommand",
+ "get_keys_function": "lmpopGetKeys",
+ "command_flags": [
+ "WRITE"
+ ],
+ "acl_categories": [
+ "LIST"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RW",
+ "ACCESS",
+ "DELETE"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "keynum": {
+ "keynumidx": 0,
+ "firstkey": 1,
+ "step": 1
+ }
+ }
+ }
+ ],
+ "reply_schema": {
+ "anyOf": [
+ {
+ "description": "If no element could be popped.",
+ "type": "null"
+ },
+ {
+ "description": "List key from which elements were popped.",
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": [
+ {
+ "description": "Name of the key from which elements were popped.",
+ "type": "string"
+ },
+ {
+ "description": "Array of popped elements.",
+ "type": "array",
+ "minItems": 1,
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ ]
+ },
+ "arguments": [
+ {
+ "name": "numkeys",
+ "type": "integer"
+ },
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0,
+ "multiple": true
+ },
+ {
+ "name": "where",
+ "type": "oneof",
+ "arguments": [
+ {
+ "name": "left",
+ "type": "pure-token",
+ "token": "LEFT"
+ },
+ {
+ "name": "right",
+ "type": "pure-token",
+ "token": "RIGHT"
+ }
+ ]
+ },
+ {
+ "token": "COUNT",
+ "name": "count",
+ "type": "integer",
+ "optional": true
+ }
+ ]
+ }
+}