Skip to content

Update json.arrappend.md #1777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025
Merged

Update json.arrappend.md #1777

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c5ec6b
Update json.arrappend.md
LiorKogan Jun 29, 2025
cd4d237
Update json.arrappend.md (copy-edits)
dwdougherty Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions content/commands/json.arrappend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,34 @@ categories:
- clients
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
description: Append one or more json values into the array at path after the last
description: Append one or more JSON values into the array at path after the last
element in it.
group: json
hidden: false
linkTitle: JSON.ARRAPPEND
module: JSON
since: 1.0.0
stack_path: docs/data-types/json
summary: Append one or more json values into the array at path after the last element
summary: Append one or more JSON values into the array at path after the last element
in it.
syntax_fmt: JSON.ARRAPPEND key [path] value [value ...]
syntax_str: '[path] value [value ...]'
syntax_fmt: JSON.ARRAPPEND key path value [value ...]
syntax_str: 'path value [value ...]'
title: JSON.ARRAPPEND
---
Append the `json` values into the array at `path` after the last element in it
Append the JSON values into the array at `path` after the last element in it.

[Examples](#examples)

## Required arguments

<details open><summary><code>key</code></summary>

is key to modify.
is the key to modify.
</details>

<details open><summary><code>path</code></summary>

is the JSONPath to specify.
</details>

<details open><summary><code>value</code></summary>
Expand All @@ -58,16 +63,9 @@ To specify a string as an array value to append, wrap the quoted string with an
{{% /alert %}}
</details>

## Optional arguments

<details open><summary><code>path</code></summary>

is JSONPath to specify. Default is root `$`.
</details>

## Return value

`JSON.ARRAPPEND` returns an [array]({{< relref "develop/reference/protocol-spec#resp-arrays" >}}) of integer replies for each path, the array's new size, or `nil`, if the matching JSON value is not an array.
`JSON.ARRAPPEND` returns an [array]({{< relref "develop/reference/protocol-spec#resp-arrays" >}}) of integer replies for each `path` match, the array's new length, or `nil`, if the matching JSON value is not an array.
For more information about replies, see [Redis serialization protocol specification]({{< relref "/develop/reference/protocol-spec" >}}).

## Examples
Expand All @@ -82,18 +80,18 @@ redis> JSON.SET item:1 $ '{"name":"Noise-cancelling Bluetooth headphones","descr
OK
{{< / highlight >}}

Add color `blue` to the end of the `colors` array. `JSON.ARRAPPEND` returns the array's new size.
Add `blue` to the end of the `colors` array. `JSON.ARRAPPEND` returns the new length of the `colors` array.

{{< highlight bash >}}
redis> JSON.ARRAPPEND item:1 $.colors '"blue"'
1) (integer) 3
{{< / highlight >}}

Return the new length of the `colors` array.
Get the updated value of the `colors` array.

{{< highlight bash >}}
redis> JSON.GET item:1
"{\"name\":\"Noise-cancelling Bluetooth headphones\",\"description\":\"Wireless Bluetooth headphones with noise-cancelling technology\",\"connection\":{\"wireless\":true,\"type\":\"Bluetooth\"},\"price\":99.98,\"stock\":25,\"colors\":[\"black\",\"silver\",\"blue\"]}"
redis> JSON.GET item:1 $.colors
"[[\"black\",\"silver\",\"blue\"]]"
{{< / highlight >}}

</details>
Expand Down