@upstash/redis 1.40.0 → 1.41.0

package/docs/commands/json/arrindex.mdx

@@ -0,0 +1,37 @@
+---
+title: JSON.ARRINDEX
+description: Search for the first occurrence of a JSON value in an array.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+<ParamField body="value" type="TValue" required>
+    The value to search for.
+</ParamField>
+
+<ParamField body="start" type="integer" default={0}>
+    The start index.
+</ParamField>
+<ParamField body="stop" type="integer" default={0}>
+    The stop index.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The index of the first occurrence of the value in the array, or -1 if not found.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const index = await redis.json.arrindex("key", "$.path.to.array", "a");
+```
+</RequestExample>

package/docs/commands/json/arrinsert.mdx

@@ -0,0 +1,34 @@
+---
+title: JSON.ARRINSERT
+description: Insert the json values into the array at path before the index (shifts to the right).
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+<ParamField body="index" type="integer" required>
+   The index where to insert the values.
+</ParamField>
+
+<ParamField body="values" type="...TValue[]" required>
+    One or more values to append to the array.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The length of the array after the insertion.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const length = await redis.json.arrinsert("key", "$.path.to.array", 2, "a", "b");
+```
+</RequestExample>

package/docs/commands/json/arrlen.mdx

@@ -0,0 +1,26 @@
+---
+title: JSON.ARRLEN
+description: Report the length of the JSON array at `path` in `key`.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The length of the array.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const length = await redis.json.arrlen("key", "$.path.to.array");
+```
+</RequestExample>

package/docs/commands/json/arrpop.mdx

@@ -0,0 +1,36 @@
+---
+title: JSON.ARRPOP
+description: Remove and return an element from the index in the array. By default the last element from an array is popped.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string">
+    The path of the array.
+</ParamField>
+
+
+
+<ParamField body="index" type="number" default={-1}>
+    The index of the element to pop.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="(TValue | null)[]" required>
+    The popped element or null if the array is empty.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const element = await redis.json.arrpop("key", "$.path.to.array");
+```
+
+```ts First
+const firstElement = await redis.json.arrpop("key", "$.path.to.array", 0);
+```
+</RequestExample>

package/docs/commands/json/arrtrim.mdx

@@ -0,0 +1,34 @@
+---
+title: JSON.ARRTRIM
+description: Trim an array so that it contains only the specified inclusive range of elements.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+<ParamField body="start" type="integer" required>
+    The start index of the range.
+</ParamField>
+<ParamField body="stop" type="integer" required>
+    The stop index of the range.
+</ParamField>
+
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The length of the array after the trimming.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const length = await redis.json.arrtrim("key", "$.path.to.array", 2, 10);
+```
+</RequestExample>

package/docs/commands/json/clear.mdx

@@ -0,0 +1,30 @@
+---
+title: JSON.CLEAR
+description: Clear container values (arrays/objects) and set numeric values to 0.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path to clear. `$` is the root.
+</ParamField>
+
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  How many values were cleared.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.clear("key");
+```
+```ts With path
+await redis.json.clear("key", "$.my.key");
+```
+</RequestExample>

package/docs/commands/json/del.mdx

@@ -0,0 +1,26 @@
+---
+title: JSON.DEL
+description: Delete a key from a JSON document.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path to delete. `$` is the root.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer" required>
+  How many paths were deleted.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.del("key", "$.path.to.value");
+```
+</RequestExample>

package/docs/commands/json/forget.mdx

@@ -0,0 +1,26 @@
+---
+title: JSON.FORGET
+description: Delete a key from a JSON document.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path to forget. `$` is the root.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer" required>
+  How many paths were deleted.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.forget("key", "$.path.to.value");
+```
+</RequestExample>

package/docs/commands/json/get.mdx

@@ -0,0 +1,53 @@
+---
+title: JSON.GET
+description: Get a single value from a JSON document.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the json entry.
+</ParamField>
+
+<ParamField body="options">
+    <Expandable>
+        <ParamField body="indent" type="string">
+            Sets the indentation string for nested levels.
+        </ParamField>
+
+        <ParamField body="newline" type="string">
+            Sets the string that's printed at the end of each line.
+        </ParamField>
+
+        <ParamField body="space" type="string">
+           Sets the string that is put between a key and a value.
+        </ParamField>
+
+    </Expandable>
+
+</ParamField>
+
+<ParamField body="paths" type="...string[]" required>
+  One or more paths to retrieve from the JSON document. `$` is the root.
+</ParamField>
+
+## Response
+
+<ResponseField type="(TValue | null)[]" required>
+  The value at the specified path or `null` if the path does not exist.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const value = await redis.json.get("key", "$.path.to.somewhere");
+```
+
+```ts With Options
+const value = await redis.json.get("key", {
+    indent: "  ",
+    newline: "\n",
+    space: " ",
+}, "$.path.to.somewhere");
+```
+
+</RequestExample>

package/docs/commands/json/merge.mdx

@@ -0,0 +1,32 @@
+---
+title: JSON.MERGE
+description: Merges the JSON value at path in key with the provided value.
+---
+
+## Arguments
+
+<ParamField body="key" type="str" required>
+    The key of the json entry.
+</ParamField>
+
+<ParamField body="path" type="str" required>
+    The path of the value to set.
+</ParamField>
+
+
+<ParamField body="value" type="string | number | Record<string, unknown> | Array<unknown>" required>
+    The value to merge with.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="string" required>
+    Returns "OK" if the merge was successful.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.merge("key", "$.path.to.value", {"new": "value"})
+```
+</RequestExample>

package/docs/commands/json/mget.mdx

@@ -0,0 +1,27 @@
+---
+title: JSON.MGET
+description: Get the same path from multiple JSON documents.
+---
+
+## Arguments
+
+<ParamField body="keys" type="...string[]" required>
+  One or more keys of JSON documents.
+</ParamField>
+
+<ParamField body="path" type="string" required>
+  The path to get from the JSON document. `$` is the root.
+</ParamField>
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The values at the specified path or `null` if the path does not exist.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const values = await redis.json.mget(["key1", "key2"],  "$.path.to.somewhere");
+```
+
+</RequestExample>

package/docs/commands/json/mset.mdx

@@ -0,0 +1,26 @@
+---
+title: JSON.MSET
+description: Sets multiple JSON values at multiple paths in multiple keys.
+---
+
+## Arguments
+
+<ParamField body="params" type="{ key: string, path: string, value: TData }[]" required>
+    A list of objects where each tuple contains a key, a path, and a value.
+    Type of value (`TData`) can be `Array<number>`, `string`, `boolean`, `Record<string, any>`, or `Array<any>`.
+</ParamField>
+
+## Response
+
+<ResponseField type="string" required>
+    Returns "OK" if the command was successful.
+</ResponseField>
+
+<RequestExample>
+```py Example
+await redis.json.mset([
+  { key: key, path: "$.path", value: value}, 
+  { key: key2, path: "$.path2", value: value2}
+])
+```
+</RequestExample>

package/docs/commands/json/numincrby.mdx

@@ -0,0 +1,33 @@
+---
+title: JSON.NUMINCRBY
+description: Increment the number value stored at `path` by number.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+
+
+
+<ParamField body="increment" type="number" required>
+    The number to increment by.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The new value after incrementing
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const newValue = await redis.json.numincrby("key", "$.path.to.value", 2);
+```
+</RequestExample>

package/docs/commands/json/nummultby.mdx

@@ -0,0 +1,33 @@
+---
+title: JSON.NUMMULTBY
+description: Multiply the number value stored at `path` by number.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+
+
+
+<ParamField body="multiply" type="number" required>
+    The number to multiply by.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The new value after multiplying
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const newValue = await redis.json.nummultby("key", "$.path.to.value", 2);
+```
+</RequestExample>

package/docs/commands/json/objkeys.mdx

@@ -0,0 +1,27 @@
+---
+title: JSON.OBJKEYS
+description: Return the keys in the object that`s referenced by path.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+
+
+## Response
+
+<ResponseField type="string[][]" required>
+  The keys of the object at the path.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const keys = await redis.json.objkeys("key", "$.path");
+```
+</RequestExample>

package/docs/commands/json/objlen.mdx

@@ -0,0 +1,27 @@
+---
+title: JSON.OBJLEN
+description: Report the number of keys in the JSON object at `path` in `key`.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the object. `$` is the root.
+</ParamField>
+
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The number of keys in the objects.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const lengths = await redis.json.objlen("key", "$.path");
+```
+</RequestExample>

package/docs/commands/json/set.mdx

@@ -0,0 +1,42 @@
+---
+title: JSON.SET
+description: Set the JSON value at path in key.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the value to set. `$` is the root.
+</ParamField>
+
+
+
+<ParamField body="value" type="TValue" required>
+    The value to set.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="OK" required>
+`OK`
+</ResponseField>
+
+<RequestExample>
+```ts Example
+Set the JSON value at path in key.
+redis.json.set(key, "$.path", value);
+```
+
+```ts NX
+const value = ...
+redis.json.set(key, "$.path", value, { nx:true });
+```
+```ts XX
+const value = ...
+redis.json.set(key, "$.path", value, { xx:true });
+```
+</RequestExample>

package/docs/commands/json/strappend.mdx

@@ -0,0 +1,32 @@
+---
+title: JSON.STRAPPEND
+description: Append the json-string values to the string at path.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the value. `$` is the root.
+</ParamField>
+
+
+
+<ParamField body="value" type="string" required>
+    The value to append to the existing string.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer[]" required>
+  The length of the array after the appending.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.strappend("key", "$.path.to.str", "abc");
+```
+</RequestExample>

package/docs/commands/json/strlen.mdx

@@ -0,0 +1,26 @@
+---
+title: JSON.STRLEN
+description: Report the length of the JSON String at path in key
+---
+
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the array. `$` is the root.
+</ParamField>
+
+
+## Response
+<ResponseField type="array" required>
+  JSON.STRLEN returns by recursive descent an array of integer replies for each path, the array's length, or nil, if the matching JSON value is not a string.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.json.strlen("key", "$.path.to.str", "a");
+```
+</RequestExample>

package/docs/commands/json/toggle.mdx

@@ -0,0 +1,28 @@
+---
+title: JSON.TOGGLE
+description: Toggle a boolean value stored at `path`.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the boolean. `$` is the root.
+</ParamField>
+
+
+
+
+## Response
+
+<ResponseField type="boolean" required>
+    The new value of the boolean.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const bool = await redis.json.toggle("key", "$.path.to.bool");
+```
+</RequestExample>

package/docs/commands/json/type.mdx

@@ -0,0 +1,28 @@
+---
+title: JSON.TYPE
+description: Report the type of JSON value at `path`.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+    The key of the json entry.
+</ParamField>
+<ParamField body="path" type="string" required>
+    The path of the value. `$` is the root.
+</ParamField>
+
+
+
+
+## Response
+
+<ResponseField type="(string | null)[]" required>
+  The type of the value at `path` or `null` if the value does not exist.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const myType = await redis.json.type("key", "$.path.to.value");
+```
+</RequestExample>