Skip to content

Commit 789f48c

Browse files
oshadmioshadmi
committed
Merge remote-tracking branch 'origin/master-newdocs' into 2.0-newdocs
2 parents c718788 + 8ffc3a6 commit 789f48c

38 files changed

+710
-1166
lines changed

‎commands.json

Lines changed: 129 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,26 @@
1414
}
1515
],
1616
"since": "1.0.0",
17-
"group": "json"
17+
"group": "module",
18+
"module": "ReJSON"
19+
},
20+
"JSON.FORGET": {
21+
"summary": "Deletes a value",
22+
"complexity": "O(N) when path is evaluated to a single value where N is the size of the deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key",
23+
"arguments": [
24+
{
25+
"name": "key",
26+
"type": "key"
27+
},
28+
{
29+
"name": "path",
30+
"type": "string",
31+
"optional": true
32+
}
33+
],
34+
"since": "1.0.0",
35+
"group": "module",
36+
"module": "ReJSON"
1837
},
1938
"JSON.GET": {
2039
"summary": "Gets the value at one or more paths in JSON serialized form",
@@ -50,7 +69,8 @@
5069
}
5170
],
5271
"since": "1.0.0",
53-
"group": "json"
72+
"group": "module",
73+
"module": "ReJSON"
5474
},
5575
"JSON.TOGGLE": {
5676
"summary": "Toggles a boolean value",
@@ -67,7 +87,8 @@
6787
}
6888
],
6989
"since": "2.0.0",
70-
"group": "json"
90+
"group": "module",
91+
"module": "ReJSON"
7192
},
7293
"JSON.CLEAR": {
7394
"summary": "Clears all values from an array or an object, sets numeric values to `0`, sets string values to empty, and sets boolean values to `false`",
@@ -84,7 +105,8 @@
84105
}
85106
],
86107
"since": "2.0.0",
87-
"group": "json"
108+
"group": "module",
109+
"module": "ReJSON"
88110
},
89111
"JSON.SET": {
90112
"summary": "Sets or updates the JSON value at a path",
@@ -104,16 +126,23 @@
104126
},
105127
{
106128
"name": "condition",
107-
"type": "enum",
108-
"enum": [
109-
"NX",
110-
"XX"
129+
"type": "oneof",
130+
"arguments": [
131+
{
132+
"name": "NX",
133+
"type": "pure-token"
134+
},
135+
{
136+
"name": "XX",
137+
"type": "pure-token"
138+
}
111139
],
112140
"optional": true
113141
}
114142
],
115143
"since": "1.0.0",
116-
"group": "json"
144+
"group": "module",
145+
"module": "ReJSON"
117146
},
118147
"JSON.MGET": {
119148
"summary": "Returns the values at a path from one or more keys",
@@ -130,7 +159,8 @@
130159
}
131160
],
132161
"since": "1.0.0",
133-
"group": "json"
162+
"group": "module",
163+
"module": "ReJSON"
134164
},
135165
"JSON.NUMINCRBY": {
136166
"summary": "Increments the numeric value at path by a value",
@@ -150,7 +180,29 @@
150180
}
151181
],
152182
"since": "1.0.0",
153-
"group": "json"
183+
"group": "module",
184+
"module": "ReJSON"
185+
},
186+
"JSON.NUMMULTBY": {
187+
"summary": "Multiplies the numeric value at path by a value",
188+
"complexity": "O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key",
189+
"arguments": [
190+
{
191+
"name": "key",
192+
"type": "key"
193+
},
194+
{
195+
"name": "path",
196+
"type": "string"
197+
},
198+
{
199+
"name": "value",
200+
"type": "double"
201+
}
202+
],
203+
"since": "1.0.0",
204+
"group": "module",
205+
"module": "ReJSON"
154206
},
155207
"JSON.STRAPPEND": {
156208
"summary": "Appends a string to a JSON string value at path",
@@ -171,7 +223,8 @@
171223
}
172224
],
173225
"since": "1.0.0",
174-
"group": "json"
226+
"group": "module",
227+
"module": "ReJSON"
175228
},
176229
"JSON.STRLEN": {
177230
"summary": "Returns the length of the JSON String at path in key",
@@ -188,10 +241,11 @@
188241
}
189242
],
190243
"since": "1.0.0",
191-
"group": "json"
244+
"group": "module",
245+
"module": "ReJSON"
192246
},
193247
"JSON.ARRAPPEND": {
194-
"summary": "Appends JSON value(s) to the JSON array at path",
248+
"summary": "Append one or more json values into the array at path after the last element in it.",
195249
"complexity": "O(1) when path is evaluated to a single value, O(N) when path is evaluated to multiple values, where N is the size of the key",
196250
"arguments": [
197251
{
@@ -210,7 +264,8 @@
210264
}
211265
],
212266
"since": "1.0.0",
213-
"group": "json"
267+
"group": "module",
268+
"module": "ReJSON"
214269
},
215270
"JSON.ARRINDEX": {
216271
"summary": "Returns the index of the first occurrence of a JSON scalar value in the array at path",
@@ -231,7 +286,7 @@
231286
{
232287
"type": "block",
233288
"optional": true,
234-
"block": [
289+
"arguments": [
235290
{
236291
"name": "start",
237292
"type": "integer"
@@ -245,7 +300,8 @@
245300
}
246301
],
247302
"since": "1.0.0",
248-
"group": "json"
303+
"group": "module",
304+
"module": "ReJSON"
249305
},
250306
"JSON.ARRINSERT": {
251307
"summary": "Inserts the JSON scalar(s) value at the specified index in the array at path",
@@ -270,7 +326,8 @@
270326
}
271327
],
272328
"since": "1.0.0",
273-
"group": "json"
329+
"group": "module",
330+
"module": "ReJSON"
274331
},
275332
"JSON.ARRLEN": {
276333
"summary": "Returns the length of the array at path",
@@ -283,11 +340,12 @@
283340
{
284341
"name": "path",
285342
"type": "string",
286-
"multiple": true
343+
"optional": true
287344
}
288345
],
289346
"since": "1.0.0",
290-
"group": "json"
347+
"group": "module",
348+
"module": "ReJSON"
291349
},
292350
"JSON.ARRPOP": {
293351
"summary": "Removes and returns the element at the specified index in the array at path",
@@ -300,7 +358,7 @@
300358
{
301359
"type": "block",
302360
"optional": true,
303-
"block": [
361+
"arguments": [
304362
{
305363
"name": "path",
306364
"type": "string"
@@ -314,7 +372,8 @@
314372
}
315373
],
316374
"since": "1.0.0",
317-
"group": "json"
375+
"group": "module",
376+
"module": "ReJSON"
318377
},
319378
"JSON.ARRTRIM": {
320379
"summary": "Trims the array at path to contain only the specified inclusive range of indices from start to stop",
@@ -338,7 +397,8 @@
338397
}
339398
],
340399
"since": "1.0.0",
341-
"group": "json"
400+
"group": "module",
401+
"module": "ReJSON"
342402
},
343403
"JSON.OBJKEYS": {
344404
"summary": "Returns the JSON keys of the object at path",
@@ -355,7 +415,8 @@
355415
}
356416
],
357417
"since": "1.0.0",
358-
"group": "json"
418+
"group": "module",
419+
"module": "ReJSON"
359420
},
360421
"JSON.OBJLEN": {
361422
"summary": "Returns the number of keys of the object at path",
@@ -372,7 +433,8 @@
372433
}
373434
],
374435
"since": "1.0.0",
375-
"group": "json"
436+
"group": "module",
437+
"module": "ReJSON"
376438
},
377439
"JSON.TYPE": {
378440
"summary": "Returns the type of the JSON value at path",
@@ -389,7 +451,8 @@
389451
}
390452
],
391453
"since": "1.0.0",
392-
"group": "json"
454+
"group": "module",
455+
"module": "ReJSON"
393456
},
394457
"JSON.RESP": {
395458
"summary": "Returns the JSON value at path in Redis Serialization Protocol (RESP)",
@@ -406,6 +469,45 @@
406469
}
407470
],
408471
"since": "1.0.0",
409-
"group": "json"
472+
"group": "module",
473+
"module": "ReJSON"
474+
},
475+
"JSON.DEBUG": {
476+
"summary": "Debugging container command",
477+
"complexity": "N/A",
478+
"since": "1.0.0",
479+
"group": "module",
480+
"module": "ReJSON"
481+
},
482+
"JSON.DEBUG HELP": {
483+
"summary": "Shows helpful information",
484+
"complexity": "N/A",
485+
"since": "1.0.0",
486+
"group": "module",
487+
"module": "ReJSON"
488+
},
489+
"JSON.DEBUG MEMORY": {
490+
"summary": "Reports the size in bytes of a key",
491+
"complexity": "O(N) when path is evaluated to a single value, where N is the size of the value, O(N) when path is evaluated to multiple values, where N is the size of the key",
492+
"arguments": [
493+
{
494+
"type": "block",
495+
"optional": true,
496+
"arguments": [
497+
{
498+
"name": "key",
499+
"type": "key"
500+
},
501+
{
502+
"name": "path",
503+
"type": "string",
504+
"optional": true
505+
}
506+
]
507+
}
508+
],
509+
"since": "1.0.0",
510+
"group": "module",
511+
"module": "ReJSON"
410512
}
411513
}

‎docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)