Skip to content
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

Jump to bottom

Java/Node: Update docs for xadd and xtrim #1246

Merged
merged 9 commits into from
Apr 10, 2024
Merged

Java/Node: Update docs for xadd and xtrim #1246

merged 9 commits into from
Apr 10, 2024

Conversation

acarbonetto
Copy link
Contributor

Issue #, if available:

Description of changes:

Update the XADD and XTRIM documentation, and add more context to the commands.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@acarbonetto acarbonetto requested a review from a team as a code owner April 8, 2024 20:58
@acarbonetto acarbonetto force-pushed the java/integ_acarbo_fix_xadd_docs branch from 50881a5 to 87a326b Compare April 8, 2024 21:34
@acarbonetto acarbonetto changed the title Java/integ acarbo fix xadd docs Java/Node: Update docs for xadd and xtrim Apr 8, 2024
@acarbonetto acarbonetto added node Node.js wrapper java issues and fixes related to the java client labels Apr 8, 2024
@Yury-Fridlyand Yury-Fridlyand added the docs Documentation label Apr 8, 2024
Yury-Fridlyand
Yury-Fridlyand reviewed Apr 8, 2024
View reviewed changes
Copy link
Collaborator

@Yury-Fridlyand Yury-Fridlyand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please this issue with javadocs for XADD too
image

node/src/BaseClient.ts Outdated Show resolved Hide resolved
acarbonetto and others added 9 commits April 10, 2024 12:44
@acarbonetto
Java: Add XADD command (Stream commands) (#155)
fc8bc2a 
* Add Stream XADD command to Java

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@SanHalacogluImproving @acarbonetto
Java: Add Zpopmax command. (Sorted Set Commands) (valkey-io#1164)
ded032b 
* Java: Add Zpopmax command. (Sorted Set Commands) (#149)

* Minor documentation update.

* Minor test update.

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Minor documentation update.

* Rebase + Spotless

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
Co-authored-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto
Spotless
82683bd 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto
Clean up merge
0a07fc3 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto
Move xadd command
d398781 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto
Spotless
094afd0 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@Yury-Fridlyand @acarbonetto
PR comments.
d4fd1bd 
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
@acarbonetto
Update xtrim documentation
766d46a 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto
Spotless
74cf089 
Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
@acarbonetto acarbonetto force-pushed the java/integ_acarbo_fix_xadd_docs branch from 70c0a31 to 74cf089 Compare April 10, 2024 20:13
@acarbonetto acarbonetto merged commit 0a430cf into valkey-io:main Apr 10, 2024
18 checks passed
Sa1Gur pushed a commit to Sa1Gur/glide-for-redis that referenced this pull request Apr 10, 2024
Squashed commit of the following:
c7ac523 
commit 0a430cf
Author: Andrew Carbonetto <andrew.carbonetto@improving.com>
Date:   Wed Apr 10 13:30:02 2024 -0700

    Java/Node: Update docs for `xadd` and `xtrim` (valkey-io#1246)

    * Java: Add XADD command (Stream commands) (valkey-io#155)

    * Add Stream XADD command to Java

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Java: Add Zpopmax command. (Sorted Set Commands) (valkey-io#1164)

    * Java: Add Zpopmax command. (Sorted Set Commands) (valkey-io#149)

    * Minor documentation update.

    * Minor test update.

    * Spotless

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Minor documentation update.

    * Rebase + Spotless

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
    Co-authored-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Spotless

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Clean up merge

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Move xadd command

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Spotless

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * PR comments.

    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

    * Update xtrim documentation

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Spotless

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
    Co-authored-by: SanHalacogluImproving <144171266+SanHalacogluImproving@users.noreply.github.com>
    Co-authored-by: Yury-Fridlyand <yury.fridlyand@improving.com>

commit 4ce976c
Author: SanHalacogluImproving <144171266+SanHalacogluImproving@users.noreply.github.com>
Date:   Wed Apr 10 12:36:56 2024 -0700

    Java: Add `Zmscore` command. (Sorted Set Command Group) (valkey-io#1234)

    * Java: Add Zmscore command. (Sorted Set Command Group) (valkey-io#173)

    * Minor update + remove change log.

    * Minor documentation update.

    * Minor IT update.

    * Rebase + Spotless.

    * Minor IT test update.

commit ae0a8f4
Author: Yury-Fridlyand <yury.fridlyand@improving.com>
Date:   Wed Apr 10 12:33:22 2024 -0700

    Java: Refactor transaction UT (valkey-io#1242)

    Refactor transaction UT. (valkey-io#192)

    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

commit fec74b8
Author: Andrew Carbonetto <andrew.carbonetto@improving.com>
Date:   Wed Apr 10 12:28:18 2024 -0700

    Clean up all warnings in Java client test (valkey-io#1213)

    * Clean up all warnings in Java client test

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Clean FfiTest.java of warnings

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Clean RedisClusterClientTest.java of compiler warnings

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Clean up more warnings in client tests

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Spotless

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Fix UT + update IT.

    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

    * Update suppression.

    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

    * Remove suppress warnings

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
    Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
    Co-authored-by: Yury-Fridlyand <yury.fridlyand@improving.com>

commit 527e1ec
Author: SanHalacogluImproving <144171266+SanHalacogluImproving@users.noreply.github.com>
Date:   Wed Apr 10 12:06:01 2024 -0700

    Java: Add `lindex` command. (List Command Group) (valkey-io#1219)

    * Java: Add lindex command. (List Command Group) (valkey-io#158)

    * Minor documentation update + changed param from int to long + minor IT update.

commit d766f51
Author: Andrew Carbonetto <andrew.carbonetto@improving.com>
Date:   Wed Apr 10 10:01:55 2024 -0700

    Node: Fix build section for node DEVELOPER.md (valkey-io#1250)

    * Fix build section for node DEVELOPER.md

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Fix numbers in DEVELOPER.md

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

    * Run prettier

    ---------

    Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
    Co-authored-by: Jonathan Louie <jonathanl@bitquilltech.com>

commit 939a519
Author: jonathanl-bq <72158117+jonathanl-bq@users.noreply.github.com>
Date:   Wed Apr 10 09:08:43 2024 -0700

    Java: Use LinkedHashMap instead of HashMap for Java wrapper Map values returned from Redis (valkey-io#1257)

    * Use LinkedHashMap instead of HashMap for Java wrapper Map values returned from Redis

    * Run cargo fmt

commit d21dbc9
Author: Shoham Elias <116083498+shohamazon@users.noreply.github.com>
Date:   Wed Apr 10 18:02:22 2024 +0300

    add missing examples and minor doc fix (valkey-io#1258)

commit 09bec2d
Author: ort-bot <glide-for-redis@amazon.com>
Date:   Wed Apr 10 00:19:09 2024 +0000

    Updated attribution files

commit 4e7acdc
Author: Adan Wattad <119428203+adanWattad@users.noreply.github.com>
Date:   Wed Apr 10 11:11:21 2024 +0300

    Node: added zrange and zrangeWithScores commands. (valkey-io#1115)

    ---------

    Co-authored-by: Adan <adanwat@amazon.com>
    Co-authored-by: Shoham Elias <shohame@amazon.com>
    Co-authored-by: Shoham Elias <116083498+shohamazon@users.noreply.github.com>

commit 79c49a4
Author: Gilboab <97948000+GilboaAWS@users.noreply.github.com>
Date:   Wed Apr 10 10:53:16 2024 +0300

    Python: Added RENAME command (valkey-io#1252)

    Python: Added rename command

commit 78cfa33
Author: Adan Wattad <119428203+adanWattad@users.noreply.github.com>
Date:   Tue Apr 9 14:29:45 2024 +0300

    Node: added spop and spopCount commands. (valkey-io#1117)

    Co-authored-by: Shoham Elias <shohame@amazon.com>

commit 5395fe1
Author: Shoham Elias <116083498+shohamazon@users.noreply.github.com>
Date:   Tue Apr 9 12:23:59 2024 +0300

    Python: adds ZREMRANGEBYSCORE command (valkey-io#1151)
alex-arzola-imp pushed a commit to Bit-Quill/valkey-glide that referenced this pull request Apr 12, 2024
@acarbonetto @SanHalacogluImproving
@Yury-Fridlyand @alex-arzola-imp
Java/Node: Update docs for xadd and xtrim (valkey-io#1246)
1fd9f43 
* Java: Add XADD command (Stream commands) (#155)

* Add Stream XADD command to Java

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Java: Add Zpopmax command. (Sorted Set Commands) (valkey-io#1164)

* Java: Add Zpopmax command. (Sorted Set Commands) (#149)

* Minor documentation update.

* Minor test update.

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Minor documentation update.

* Rebase + Spotless

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
Co-authored-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Clean up merge

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Move xadd command

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* PR comments.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Update xtrim documentation

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Co-authored-by: SanHalacogluImproving <144171266+SanHalacogluImproving@users.noreply.github.com>
Co-authored-by: Yury-Fridlyand <yury.fridlyand@improving.com>
cyip10 pushed a commit to Bit-Quill/valkey-glide that referenced this pull request Jun 24, 2024
@acarbonetto @SanHalacogluImproving
@Yury-Fridlyand @cyip10
Java/Node: Update docs for xadd and xtrim (valkey-io#1246)
6a58fa2 
* Java: Add XADD command (Stream commands) (#155)

* Add Stream XADD command to Java

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Java: Add Zpopmax command. (Sorted Set Commands) (valkey-io#1164)

* Java: Add Zpopmax command. (Sorted Set Commands) (#149)

* Minor documentation update.

* Minor test update.

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Minor documentation update.

* Rebase + Spotless

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
Co-authored-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Clean up merge

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Move xadd command

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* PR comments.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>

* Update xtrim documentation

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

* Spotless

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>

---------

Signed-off-by: Andrew Carbonetto <andrew.carbonetto@improving.com>
Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Co-authored-by: SanHalacogluImproving <144171266+SanHalacogluImproving@users.noreply.github.com>
Co-authored-by: Yury-Fridlyand <yury.fridlyand@improving.com>
@Yury-Fridlyand Yury-Fridlyand deleted the java/integ_acarbo_fix_xadd_docs branch July 19, 2024 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SanHalacogluImproving SanHalacogluImproving SanHalacogluImproving approved these changes

@Yury-Fridlyand Yury-Fridlyand Yury-Fridlyand approved these changes

@barshaul barshaul barshaul approved these changes

@shohamazon shohamazon Awaiting requested review from shohamazon

@ikolomi ikolomi Awaiting requested review from ikolomi

Assignees
No one assigned
Labels
docs Documentation java issues and fixes related to the java client node Node.js wrapper
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@acarbonetto @barshaul @Yury-Fridlyand @SanHalacogluImproving