Python: adds JSON.ARRAPPEND command by shohamazon · Pull Request #2382 · valkey-io/valkey-glide

shohamazon · 2024-10-02T11:56:37Z

No description provided.

shohamazon · 2024-10-02T11:58:48Z

+    Examples:
+        >>> from glide import json as valkeyJson
+        >>> import json
+        >>> await redisJson.set(client, "doc", "$", '{"a": 1, "b": ["one", "two"]}')


Suggested change

>>> await redisJson.set(client, "doc", "$", '{"a": 1, "b": ["one", "two"]}')

>>> await valkeyJson.set(client, "doc", "$", '{"a": 1, "b": ["one", "two"]}')

need to fix all this doc

shohamazon · 2024-10-07T13:00:27Z

+            For legacy path (`path` doesn't start with `$`):
+                Returns the length of the new array after appending `values` to the array at `path`.
+                If multiple paths match, the length of the last updated array is returned.
+                If the JSON value at `path` is not a array of if `path` doesn't exist, an error is raised.


Suggested change

If the JSON value at `path` is not a array of if `path` doesn't exist, an error is raised.

If the JSON value at `path` is not a array or if `path` doesn't exist, an error is raised.

yipin-chen · 2024-10-17T13:41:34Z

+) -> TJsonResponse[int]:
+    """Appends one or more `values` to the JSON array at the specified `path` within the JSON document stored at `key`.
+
+    See https://valkey.io/commands/json.append/ for more details.


This link is not found. Do we use https://redis.io/docs/latest/commands/json.arrappend/ instead?

forgot to remove it, you can ignore

yipin-chen · 2024-10-17T16:19:46Z

Please update CHANGELOG too.

jamesx-improving · 2024-10-18T16:16:54Z

+    client: TGlideClient,
+    key: TEncodable,
+    values: List[TEncodable],
+    path: Optional[TEncodable] = None,


path is not optional for JSON.ARRAPPEND. Ref: https://docs.aws.amazon.com/memorydb/latest/devguide/json-arrappend.html

True, but it is optional is redis , wasn't sure what I'm supposed to do 🙁

I think we should ignore redis impl for the module

shohamazon · 2024-10-19T16:22:00Z

Please update CHANGELOG too.

Adding at the end of every pr

Signed-off-by: Shoham Elias <shohame@amazon.com>

ikolomi

On condition that not having path as Optional is not a bug

ikolomi · 2024-10-29T07:44:40Z

+async def arrappend(
+    client: TGlideClient,
+    key: TEncodable,
+    path: TEncodable,


why isnt the path an optional per docs?

optional in redis, not aws, the decision was to stick with aws implementation

Can you explain that?
If I'm using json with a regular Valkey-server with json, not cloud provided server, is it optional?

it is, not sure what to do

As I see it, optional. It doesn't block AWS users, they just need to have it documented to know that for them, it's a must.
We would rather not block other user types. Tomorrow we might have some user open an issue on it.
If there's a real conflict between implementations, we can discuss with what to stick or create two APIs for the different cases.
But we would rather support all cases when those are possible together with no real issue.
Misuse is always possible, like users with a lower version using the API available in a higher version. We don't block all users from using the API, since we have some version preferences.
We can consider more sophisticated ways if you think it's not perfect, but it requires some thinking.

In particular, the usage of this command without path is quite a narrow case: it indicates that the entire JSON is just an array at its root. I would say this is, to some degree, the justification of AWS JSON module making path mandatory.

Signed-off-by: Shoham Elias <116083498+shohamazon@users.noreply.github.com>

Signed-off-by: Shoham Elias <shohame@amazon.com>

--------- Signed-off-by: Shoham Elias <shohame@amazon.com> Signed-off-by: Shoham Elias <116083498+shohamazon@users.noreply.github.com>

shohamazon requested a review from a team as a code owner October 2, 2024 11:56

shohamazon temporarily deployed to AWS_ACTIONS October 2, 2024 11:56 — with GitHub Actions Inactive

shohamazon commented Oct 2, 2024

View reviewed changes

Comment thread python/python/glide/async_commands/server_modules/json.py Outdated

shohamazon commented Oct 2, 2024

View reviewed changes

shohamazon added the python 🐍 Python wrapper label Oct 2, 2024

shohamazon commented Oct 7, 2024

View reviewed changes

shohamazon commented Oct 9, 2024

View reviewed changes

Comment thread python/python/glide/async_commands/server_modules/json.py

shohamazon changed the base branch from main to release-1.2 October 10, 2024 13:13

shohamazon mentioned this pull request Oct 10, 2024

Json module for Python #645

Closed

22 tasks

yipin-chen reviewed Oct 17, 2024

View reviewed changes

shohamazon requested a review from yipin-chen October 17, 2024 16:14

jamesx-improving reviewed Oct 18, 2024

View reviewed changes

shohamazon added 2 commits October 28, 2024 06:25

Python: adds JSON.ARRAPPEND command

ed8a451

Signed-off-by: Shoham Elias <shohame@amazon.com>

pr comments

44f7d7f

Signed-off-by: Shoham Elias <shohame@amazon.com>

shohamazon force-pushed the python/json.append branch from 0ca5d32 to 44f7d7f Compare October 28, 2024 06:56

shohamazon temporarily deployed to AWS_ACTIONS October 28, 2024 06:56 — with GitHub Actions Inactive

shohamazon commented Oct 28, 2024

View reviewed changes

Comment thread python/python/glide/async_commands/server_modules/json.py Outdated

shohamazon commented Oct 28, 2024

View reviewed changes

Comment thread python/python/glide/async_commands/server_modules/json.py Outdated

shohamazon requested review from Yury-Fridlyand, acarbonetto and jamesx-improving October 28, 2024 14:23

shohamazon commented Oct 29, 2024

View reviewed changes

Comment thread python/python/glide/async_commands/server_modules/json.py Outdated

ikolomi approved these changes Oct 29, 2024

View reviewed changes

Apply suggestions from code review

e694c5e

Signed-off-by: Shoham Elias <116083498+shohamazon@users.noreply.github.com>

shohamazon had a problem deploying to AWS_ACTIONS October 29, 2024 08:31 — with GitHub Actions Error

path is not optional

15c04bc

Signed-off-by: Shoham Elias <shohame@amazon.com>

shohamazon had a problem deploying to AWS_ACTIONS October 29, 2024 09:04 — with GitHub Actions Error

add note

8fd6351

Signed-off-by: Shoham Elias <shohame@amazon.com>

shohamazon temporarily deployed to AWS_ACTIONS October 29, 2024 09:38 — with GitHub Actions Inactive

shohamazon merged commit 1e0476c into release-1.2 Oct 29, 2024

shohamazon deleted the python/json.append branch October 29, 2024 10:23

affonsov pushed a commit that referenced this pull request Aug 21, 2026

Python: adds JSON.ARRAPPEND command (#2382)

939959a

--------- Signed-off-by: Shoham Elias <shohame@amazon.com> Signed-off-by: Shoham Elias <116083498+shohamazon@users.noreply.github.com>

	>>> await redisJson.set(client, "doc", "$", '{"a": 1, "b": ["one", "two"]}')
	>>> await valkeyJson.set(client, "doc", "$", '{"a": 1, "b": ["one", "two"]}')

	If the JSON value at `path` is not a array of if `path` doesn't exist, an error is raised.
	If the JSON value at `path` is not a array or if `path` doesn't exist, an error is raised.

Uh oh!

Conversation

shohamazon commented Oct 2, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yipin-chen commented Oct 17, 2024

Uh oh!

jamesx-improving Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shohamazon commented Oct 19, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ikolomi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shohamazon Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jamesx-improving Oct 18, 2024 •

edited

Loading

shohamazon Oct 29, 2024 •

edited

Loading