aboutsummaryrefslogtreecommitdiff
path: root/examples/redis-unstable/src/commands/scan.json
diff options
context:
space:
mode:
Diffstat (limited to 'examples/redis-unstable/src/commands/scan.json')
-rw-r--r--examples/redis-unstable/src/commands/scan.json72
1 files changed, 72 insertions, 0 deletions
diff --git a/examples/redis-unstable/src/commands/scan.json b/examples/redis-unstable/src/commands/scan.json
new file mode 100644
index 0000000..a7df78a
--- /dev/null
+++ b/examples/redis-unstable/src/commands/scan.json
@@ -0,0 +1,72 @@
1{
2 "SCAN": {
3 "summary": "Iterates over the key names in the database.",
4 "complexity": "O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.",
5 "group": "generic",
6 "since": "2.8.0",
7 "arity": -2,
8 "function": "scanCommand",
9 "history": [
10 [
11 "6.0.0",
12 "Added the `TYPE` subcommand."
13 ]
14 ],
15 "command_flags": [
16 "READONLY",
17 "TOUCHES_ARBITRARY_KEYS"
18 ],
19 "acl_categories": [
20 "KEYSPACE"
21 ],
22 "command_tips": [
23 "NONDETERMINISTIC_OUTPUT",
24 "REQUEST_POLICY:SPECIAL",
25 "RESPONSE_POLICY:SPECIAL"
26 ],
27 "arguments": [
28 {
29 "name": "cursor",
30 "type": "integer"
31 },
32 {
33 "token": "MATCH",
34 "name": "pattern",
35 "type": "pattern",
36 "optional": true
37 },
38 {
39 "token": "COUNT",
40 "name": "count",
41 "type": "integer",
42 "optional": true
43 },
44 {
45 "token": "TYPE",
46 "name": "type",
47 "type": "string",
48 "optional": true,
49 "since": "6.0.0"
50 }
51 ],
52 "reply_schema": {
53 "description": "cursor and scan response in array form",
54 "type": "array",
55 "minItems": 2,
56 "maxItems": 2,
57 "items": [
58 {
59 "description": "cursor",
60 "type": "string"
61 },
62 {
63 "description": "list of keys",
64 "type": "array",
65 "items": {
66 "type": "string"
67 }
68 }
69 ]
70 }
71 }
72}