Update readme for java client #112

Yury-Fridlyand · 2024-02-22T21:25:22Z

No description provided.

acarbonetto · 2024-02-22T21:29:43Z

java/README.md

-2. `examples`: An examples app to test the client against a Redis localhost
-3. `benchmark`: A dedicated benchmarking tool designed to evaluate and compare the performance of GLIDE for Redis and other Java clients.
-4. `integTest`: An integration test sub-project for API and E2E testing
+1. `src`: A rust part of the Java client and corresponding tests.


Suggested change

1. `src`: A rust part of the Java client and corresponding tests.

1. `src`: Rust dynamic library FFI to integrate with [GLIDE core library](../glide-core/README.md).

Not sure this is needed.
This 'part' goes hand-in-hand with the client. We should consider moving it into the client directory, actually.

acarbonetto · 2024-02-22T21:30:27Z

java/README.md

@@ -29,27 +30,49 @@ Software Dependencies:
 - protoc (protobuf compiler)
 - Rust

+Please also consider installing the following packages to build [GLIDE core rust library](../glide-core/README.md):


should we just reference the glide-core library here as a dependency?
GLIDE core library

We can, but the readme of core is empty. TBD to copy this block to that readme.

acarbonetto · 2024-02-22T21:35:12Z

java/README.md

 #### Prerequisites

+**Protoc installation**
+
+Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases/tag/v25.1) and make it accessible in your $PATH by moving it or creating a symlink.


Suggested change

Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases/tag/v25.1) and make it accessible in your $PATH by moving it or creating a symlink.

Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases) and make it accessible in your $PATH by moving it or creating a symlink.

Note: we only support latest. And really, we want to only support https://github.com/protocolbuffers/protobuf/releases/tag/v26.0-rc2 and later because of protocolbuffers/protobuf#12639

I put here the same version we use in CI

GumpacG · 2024-05-07T19:00:43Z

Can you also add to the DEVELOPER.md how to run integration tests on different redis versions?

* `LOLWUT` (#237) --------- Signed-off-by: Yury-Fridlyand <[email protected]>

* Add `SDIFF` command. (#225) Signed-off-by: Yury-Fridlyand <[email protected]>

… argument (valkey-io#1283)

…w creating new clients from tests

* Update javadocs. Signed-off-by: Yury-Fridlyand <[email protected]> * Revert some changes. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]>

* Add `BZPOPMAX` command. (#188) * Add `BZPOPMAX` command. Signed-off-by: Yury-Fridlyand <[email protected]> * Typo fix. Signed-off-by: Yury-Fridlyand <[email protected]> * Typo fix. Signed-off-by: Yury-Fridlyand <[email protected]> * Typo fix. Signed-off-by: Yury-Fridlyand <[email protected]> * IT timeout fix for redis 6. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * Revert unrelated changes. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]> * Typo fix. Signed-off-by: Yury-Fridlyand <[email protected]> * Revert unrelated changes. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]>

* Implement OBJECT IDLETIME command * Address PR comment * Fix build and SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> * Fix nit comment and run spotless --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]>

* Python: Add `PFADD` command. (#229) * Add `PFADD` command. Signed-off-by: Yury-Fridlyand <[email protected]> * BLACK I HATE YOU Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * Update CHANGELOG.md Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> * Apply suggestions from code review Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Shoham Elias <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: Shoham Elias <[email protected]>

* Node: Add `PFADD` command. (#232) * Add `PFADD` command. Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * Update CHANGELOG.md Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> * Apply suggestions from code review Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Shoham Elias <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]>

* Add OBJECT FREQ command * Appease the Spotless deities * Fix example * Fix example again * Fix test name in SharedCommandTests * Address PR comments * Apply Spotless * Fix missed merge conflicts * Split command tests up * Fix build issue

* Java: Add `XTRIM` command for streams (#215) * Java: Add XTRIM command Signed-off-by: Andrew Carbonetto <[email protected]> * Update imports; add exception test Signed-off-by: Andrew Carbonetto <[email protected]> * Add IT test for non-extent key Signed-off-by: Andrew Carbonetto <[email protected]> * Update documentation examples Signed-off-by: Andrew Carbonetto <[email protected]> * XTRIM: make exact optional Signed-off-by: Andrew Carbonetto <[email protected]> * Consolidate stream options into one class Signed-off-by: Andrew Carbonetto <[email protected]> * Remove StreamAddOptions and StreamTrimOptions Signed-off-by: Andrew Carbonetto <[email protected]> * Update docs for StreamOptions Signed-off-by: Andrew Carbonetto <[email protected]> * Pull StreamOption tests into separate file Signed-off-by: Andrew Carbonetto <[email protected]> * Remove extra tests Signed-off-by: Andrew Carbonetto <[email protected]> * SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> * Update tests Signed-off-by: Andrew Carbonetto <[email protected]> * Move some tests around Signed-off-by: Andrew Carbonetto <[email protected]> * Delete test file Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> * Clean up example comment Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]>

…#1347) redis-rs: Pull changes from submodule

Update examples in docs. (#248) Signed-off-by: Yury-Fridlyand <[email protected]>

* Java: Add command `Touch`. (Generic Command Group) (#249) * PR comments.

* Add `HKEYS` command. (#245) Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: Shoham Elias <[email protected]>

* Add `RENAMENX` command. (#247) Signed-off-by: Yury-Fridlyand <[email protected]> * PR comments. Signed-off-by: Yury-Fridlyand <[email protected]> * Update IT. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]>

* Java: Add `Zrevrank` command. (#241) * Minor documentation updates. * Minor documentation updates. --------- Co-authored-by: Yury-Fridlyand <[email protected]>

Add WATCH returns null standalone IT test Signed-off-by: Andrew Carbonetto <[email protected]>

As discussed, the first step before introducing GlideString is to revert commit valkey-io#1526 This commit does that

* Python: Add command SRandMember Co-authored-by: TJ Zhang <[email protected]>

…th in standalone and cluster modes. Pubsub configuration is provided in client creation params.

Separated unwatch to have different docs for standalone (#372) * Separated unwatch to have different docs for standalone * Added line break

* Java: Add `FLUSHDB` command. (#366) Signed-off-by: Yury-Fridlyand <[email protected]>

* RCT test * implement random val * work on SCT * implement randomkey no examples * current progress * implement randomKey * ran spotlessApply * addressed interface comment * progress on pause * address redis issue * add todo for redis rs issue * current progress address commentS * run into cluster error * ran into cluster error * address comments * address test comments * resolve merge conflicts * address cluster comment * Disable failing test until redis-rs fix in Signed-off-by: Andrew Carbonetto <[email protected]> * SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Chloe Yip <[email protected]> Co-authored-by: Chloe Yip <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]>

* wip * Python: add BITPOS command * Fix example * Add test for invalid bit argument

…alkey-io#1599) * Java: Add commands `XGROUP CREATECONSUMER` and `XGROUP DELCONSUMER` (#360) * Add XGROUP CreateConsumer, DelConsumer Signed-off-by: Andrew Carbonetto <[email protected]> * Update Xgroup createconsumer docs Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> * Fix doc Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]>

* Python: Add Command FlushAll (#364) * Python: Add Command FlushAll * TOK return type * changelog * checkstyle * address comments * adding cluster/standalone functions * transaction doc * routing doc update * addressing comments --------- Co-authored-by: TJ Zhang <[email protected]>

…o#1607)

…-io#1605)

Java: Add `SUNION` command (#378) * Added sunion command * Removed cross slot note in transactions * Added a test case * Addressed PR comments

* Add Python cmd GetEX * Python: Add command GetEx * addressing comments & updating changelog * changelog & request type --------- Co-authored-by: TJ Zhang <[email protected]>

Fix routing for `FLUSHALL` and `FLUSHDB`. (#379) Signed-off-by: Yury-Fridlyand <[email protected]>

* Python: add BITFIELD and BITFIELD_RO commands * Update test minimum version for bitfield_ro * PR suggestions

* Python: add ZREVRANK command * Relocate zrevrank to be adjacent to zrank --------- Co-authored-by: Andrew Carbonetto <[email protected]>

* Java: Add the `XREADGROUP` command (#376) * Add XGROUP CreateConsumer, DelConsumer Signed-off-by: Andrew Carbonetto <[email protected]> * Add XREADGROUP command Signed-off-by: Andrew Carbonetto <[email protected]> * Udpate IT tests Signed-off-by: Andrew Carbonetto <[email protected]> * Fix IT tests Signed-off-by: Andrew Carbonetto <[email protected]> * SPOTLESS & merge conflict fix Signed-off-by: Andrew Carbonetto <[email protected]> * Update for review comments Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> * Remove old test from IT suite Signed-off-by: Andrew Carbonetto <[email protected]> * Update xreadgroup docs Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]>

* Restore the overload `byte[]` overload API with a twist: use `GlideString` instead - Implemented `set(..)` binary version with options - Implemented `getdel` binary version * Rust lint warnings * Added `hgetall` binary version Added `mget` binary version * fixed wrong comment use assertEquals * For performance reasons, convert `byte[]` -> `GlideString` in Java realm (avoid the JNI overhead) * Rust linter fixes

Signed-off-by: Andrew Carbonetto <[email protected]>

* Python: add XDEL command * Fix formatting

* implement getex options * current progress * continue progress on tests * implement getex * Address comments * address more comments * fix tests * address final comments * address remaining comments * resolve merge conflicts * ran spotless * add new tests * fix tests * Add initial test for GetExOptions Signed-off-by: Andrew Carbonetto <[email protected]> * fix tests * fix tests * ran spotless --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Chloe Yip <[email protected]> Co-authored-by: Chloe Yip <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]>

* Java: Add XACK stream command (#380) Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Guian Gumpac <[email protected]> Co-authored-by: Yi-Pin Chen <[email protected]>

* Java: Add DUMP and RESTORE commands (#371) * Cherry-pick Java: Add DUMP and RESTORE commands * Fixed codestyle issues * Addressed review comments * Added more test to SharedCommandtests * Change ByteArrayArgumentMatcher to use Arrays.equals() comparison instead * Addressed review comments - added custom setter methods for long values - changed seconds to idletime - minor comments updated * Updated few minor comments * Removed Optional in RestoreOptions and added setter methods for replace and absttl * Replaced byte[] with GlideString and fixed codestyle issues * Updated comment in RestoreOptions.java * Addressed review comments * Addressed more review comments * Added the casting in handleBytesOrNullResponse to return byte[] * Removed unsed tempKey in SharedCommandTests Removed .getBytes() in RestoreOptions --------- Co-authored-by: Yi-Pin Chen <[email protected]>

* Python: add XRANGE command * PR suggestions * Fix formatting

acarbonetto reviewed Feb 22, 2024

View reviewed changes

aaron-congo approved these changes Feb 22, 2024

View reviewed changes

This was referenced Feb 23, 2024

Update readmes for all clients - move common things to one place. #113

Closed

Implement Redis client configuration logic #104

Merged

Yury-Fridlyand added documentation Improvements or additions to documentation java labels Apr 17, 2024

Yury-Fridlyand and others added 23 commits June 24, 2024 15:39

Java: LOLWUT (valkey-io#1326)

950be1c

* `LOLWUT` (#237) --------- Signed-off-by: Yury-Fridlyand <[email protected]>

Java: Add SDIFF command. (valkey-io#1312)

86bc53f

* Add `SDIFF` command. (#225) Signed-off-by: Yury-Fridlyand <[email protected]>

remove temporary fix as it not nedded anymore

ebe65e5

Fixed blocking command to be timed out based on the specified command…

a8b78c2

… argument (valkey-io#1283)

Test utilities: moved client creation to a seperated function to allo…

d1f03fa

…w creating new clients from tests

[BLOCKED] Update javadocs for BRPOP and BLPOP (#198)

a7f333a

* Update javadocs. Signed-off-by: Yury-Fridlyand <[email protected]> * Revert some changes. Signed-off-by: Yury-Fridlyand <[email protected]> --------- Signed-off-by: Yury-Fridlyand <[email protected]>

Python: adds GEODIST command (valkey-io#1260)

e5f3b81

Python: adds GEOPOS command (valkey-io#1301)

dba37d1

Python: Upgrade black version

bb6cecb

Python: Resolving package conflicts

4e244cd

Java: Add OBJECT FREQ command (valkey-io#1327)

6a03b30

* Add OBJECT FREQ command * Appease the Spotless deities * Fix example * Fix example again * Fix test name in SharedCommandTests * Address PR comments * Apply Spotless * Fix missed merge conflicts * Split command tests up * Fix build issue

Submodules: Pull changes from amazon-contributing/redis-rs (valkey-io…

3f4b941

…#1347) redis-rs: Pull changes from submodule

Node: Update examples in docs. (valkey-io#1360)

d2a6de7

Update examples in docs. (#248) Signed-off-by: Yury-Fridlyand <[email protected]>

Java: Add command Touch. (Generic Command Group) (valkey-io#1354)

e45a84c

* Java: Add command `Touch`. (Generic Command Group) (#249) * PR comments.

Java: Add HKEYS command. (valkey-io#1340)

14fe51e

* Add `HKEYS` command. (#245) Signed-off-by: Yury-Fridlyand <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: Shoham Elias <[email protected]>

Java: Add Zrevrank command. (valkey-io#1337)

baf283a

* Java: Add `Zrevrank` command. (#241) * Minor documentation updates. * Minor documentation updates. --------- Co-authored-by: Yury-Fridlyand <[email protected]>

Add WATCH returns null standalone test (valkey-io#1336)

4acadeb

Add WATCH returns null standalone IT test Signed-off-by: Andrew Carbonetto <[email protected]>

eifrah-aws and others added 27 commits June 24, 2024 15:40

Java: reverted byte[] overloading (valkey-io#1598)

99e7256

As discussed, the first step before introducing GlideString is to revert commit valkey-io#1526 This commit does that

Python: Add command SRandMember (valkey-io#1578)

cd63be3

* Python: Add command SRandMember Co-authored-by: TJ Zhang <[email protected]>

Python: add BITOP command (valkey-io#1596)

e88766d

Pubsub implementation in glide-core and with Python wrapper. Works bo…

8cd7c11

…th in standalone and cluster modes. Pubsub configuration is provided in client creation params.

Separated unwatch to have different docs for standalone (valkey-io#1597)

6f14c63

Separated unwatch to have different docs for standalone (#372) * Separated unwatch to have different docs for standalone * Added line break

Java: Add FLUSHDB command. (valkey-io#1593)

804f7bd

* Java: Add `FLUSHDB` command. (#366) Signed-off-by: Yury-Fridlyand <[email protected]>

Python: add BITPOS command (valkey-io#1604)

066afe0

* wip * Python: add BITPOS command * Fix example * Add test for invalid bit argument

Python: refactor publish command to return OK in standalone (valkey-i…

064ee87

…o#1607)

Python: add missing classes to __all__ section in __init__.py (valkey…

508cc75

…-io#1605)

Java: Add SUNION command (valkey-io#1610)

521381c

Java: Add `SUNION` command (#378) * Added sunion command * Removed cross slot note in transactions * Added a test case * Addressed PR comments

Python: Add command GetEX (valkey-io#1612)

7bea2c5

* Add Python cmd GetEX * Python: Add command GetEx * addressing comments & updating changelog * changelog & request type --------- Co-authored-by: TJ Zhang <[email protected]>

Java: Fix routing for FLUSHALL and FLUSHDB. (valkey-io#1608)

554c779

Fix routing for `FLUSHALL` and `FLUSHDB`. (#379) Signed-off-by: Yury-Fridlyand <[email protected]>

Python: add BITFIELD and BITFIELD_RO commands (valkey-io#1615)

6c6eeeb

* Python: add BITFIELD and BITFIELD_RO commands * Update test minimum version for bitfield_ro * PR suggestions

Python: add ZREVRANK command (valkey-io#1614)

4793a18

* Python: add ZREVRANK command * Relocate zrevrank to be adjacent to zrank --------- Co-authored-by: Andrew Carbonetto <[email protected]>

Add callback and peek pubsub api modes

0f992c0

Fix stream add tests (valkey-io#1618)

8d9d2ab

Signed-off-by: Andrew Carbonetto <[email protected]>

Python: add XDEL command (valkey-io#1619)

2b1cc79

* Python: add XDEL command * Fix formatting

Java: Add XACK stream command (valkey-io#1620)

1683663

* Java: Add XACK stream command (#380) Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Guian Gumpac <[email protected]> Co-authored-by: Yi-Pin Chen <[email protected]>

Python: add XRANGE command (valkey-io#1624)

dc64b00

* Python: add XRANGE command * PR suggestions * Fix formatting

add cluster

66b7486

cyip10 mentioned this pull request Jun 25, 2024

Java: README.md #388

Closed

Yury-Fridlyand closed this Aug 15, 2024

Yury-Fridlyand deleted the java/dev_yuryf_readme branch August 15, 2024 00:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme for java client #112

Update readme for java client #112

Yury-Fridlyand commented Feb 22, 2024

acarbonetto Feb 22, 2024

acarbonetto Feb 22, 2024

Yury-Fridlyand Feb 22, 2024

Yury-Fridlyand Feb 23, 2024

acarbonetto Feb 22, 2024

Yury-Fridlyand Feb 22, 2024

GumpacG commented May 7, 2024

	1. `src`: A rust part of the Java client and corresponding tests.
	1. `src`: Rust dynamic library FFI to integrate with [GLIDE core library](../glide-core/README.md).

	Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases/tag/v25.1) and make it accessible in your $PATH by moving it or creating a symlink.
	Download a binary matching your system from the [official release page](https://github.com/protocolbuffers/protobuf/releases) and make it accessible in your $PATH by moving it or creating a symlink.

Update readme for java client #112

Update readme for java client #112

Conversation

Yury-Fridlyand commented Feb 22, 2024

acarbonetto Feb 22, 2024

Choose a reason for hiding this comment

acarbonetto Feb 22, 2024

Choose a reason for hiding this comment

Yury-Fridlyand Feb 22, 2024

Choose a reason for hiding this comment

Yury-Fridlyand Feb 23, 2024

Choose a reason for hiding this comment

acarbonetto Feb 22, 2024

Choose a reason for hiding this comment

Yury-Fridlyand Feb 22, 2024

Choose a reason for hiding this comment

GumpacG commented May 7, 2024