Java: FT.EXPLAIN and FT.EXPLAINCLI #2515

cyip10 · 2024-10-24T22:04:32Z

Issue link

This Pull Request is linked to issue (URL): #2428

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one issue.
Commit message has a detailed description of what changed and why.
Tests are added or updated.
CHANGELOG.md and documentation files are updated.
Destination branch is correct - main or release
Commits will be squashed upon merging.

Signed-off-by: Chloe <chloe.yip@improving.com>

Signed-off-by: Chloe Yip <chloe.yip@improving.com>

Signed-off-by: Chloe <chloe.yip@improving.com>

java/client/src/main/java/glide/api/commands/servermodules/FT.java

Signed-off-by: Chloe <chloe.yip@improving.com>

java/client/src/main/java/glide/api/commands/servermodules/FT.java

java/integTest/src/test/java/glide/modules/VectorSearchTests.java

Signed-off-by: Chloe <chloe.yip@improving.com>

java/client/src/main/java/glide/api/commands/servermodules/FT.java

Signed-off-by: Chloe <chloe.yip@improving.com>

java/client/src/main/java/glide/api/commands/servermodules/FT.java

jamesx-improving · 2024-10-28T20:55:05Z

java/client/src/main/java/glide/api/commands/servermodules/FT.java

+     */
+    public static CompletableFuture<String> explain(
+            @NonNull BaseClient client, @NonNull String indexName, @NonNull String query) {
+        var args = concatenateArrays(new GlideString[] {gs("FT.EXPLAIN"), gs(indexName), gs(query)});


Suggested change

var args = concatenateArrays(new GlideString[] {gs("FT.EXPLAIN"), gs(indexName), gs(query)});

GlideString[] args = new GlideString[] {gs("FT.EXPLAIN"), gs(indexName), gs(query)};

concatenateArrays() is not needed, as we are creating only one array. Also try not to use var.
Please check all other occurences as well.

jamesx-improving · 2024-10-28T21:11:36Z

java/integTest/src/test/java/glide/modules/VectorSearchTests.java

+        // search query that returns all data.
+        resultGS = FT.explaincli(client, gs(indexName), gs("*")).get();
+        for (GlideString r : resultGS) {
+            resultListGS2.add(r.toString().trim()); // trim to remove any excess white space


why not using stream again here with resultListGS2?

jamesx-improving · 2024-10-28T21:13:23Z

java/integTest/src/test/java/glide/modules/VectorSearchTests.java

+    }
+
+    @SneakyThrows
+    public void createIndexHelper(String indexName) {


If this is a helper/utility method, then maybe it doesn't need to be public.

java/client/src/main/java/glide/api/commands/servermodules/FT.java

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

Yury-Fridlyand

LGTM, last nits

java/client/src/main/java/glide/api/commands/servermodules/FT.java

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

cyip10 added 3 commits October 24, 2024 16:53

update docs

0453681

Signed-off-by: Chloe <chloe.yip@improving.com>

first test draft

e6a9226

Signed-off-by: Chloe Yip <chloe.yip@improving.com>

implement explain and explaincli

620896d

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 added the java issues and fixes related to the java client label Oct 24, 2024

cyip10 requested a review from a team as a code owner October 24, 2024 22:04

cyip10 had a problem deploying to AWS_ACTIONS October 24, 2024 22:04 — with GitHub Actions Error

add changelog

704f21f

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 24, 2024 22:06 — with GitHub Actions Error

prateek-kumar-improving reviewed Oct 24, 2024

View reviewed changes

java/client/src/main/java/glide/api/commands/servermodules/FT.java Outdated Show resolved Hide resolved

prateek-kumar-improving reviewed Oct 24, 2024

View reviewed changes

java/client/src/main/java/glide/api/commands/servermodules/FT.java Outdated Show resolved Hide resolved

updated docs

3b2700d

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 17:55 — with GitHub Actions Error

ran spotless

fa0d612

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 18:00 — with GitHub Actions Error

Merge branch 'release-1.2' into java/cyip10_vss_explain_explaincli

fc7f89d

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 18:35 — with GitHub Actions Error

fix data type error

6e1670e

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 18:54 — with GitHub Actions Error

acarbonetto reviewed Oct 25, 2024

View reviewed changes

addressed comments

ca403c1

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 22:19 — with GitHub Actions Error

Merge branch 'release-1.2' into java/cyip10_vss_explain_explaincli

0d22f9f

cyip10 had a problem deploying to AWS_ACTIONS October 25, 2024 22:19 — with GitHub Actions Error

spotless and changed to add streams

05865a2

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 28, 2024 16:45 — with GitHub Actions Error

Merge branch 'release-1.2' into java/cyip10_vss_explain_explaincli

a4f255a

cyip10 had a problem deploying to AWS_ACTIONS October 28, 2024 16:47 — with GitHub Actions Error

Yury-Fridlyand reviewed Oct 28, 2024

View reviewed changes

Yury-Fridlyand mentioned this pull request Oct 28, 2024

Java: VSS commands support #2428

Closed

13 tasks

address new comments

35901d6

Signed-off-by: Chloe <chloe.yip@improving.com>

cyip10 had a problem deploying to AWS_ACTIONS October 28, 2024 18:50 — with GitHub Actions Error

jamesx-improving reviewed Oct 28, 2024

View reviewed changes

Yury-Fridlyand reviewed Oct 28, 2024

View reviewed changes

java/client/src/main/java/glide/api/commands/servermodules/FT.java Outdated Show resolved Hide resolved

java/client/src/main/java/glide/api/commands/servermodules/FT.java Outdated Show resolved Hide resolved

Clean up for review commetns

71b311a

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

acarbonetto temporarily deployed to AWS_ACTIONS October 28, 2024 22:23 — with GitHub Actions Inactive

acarbonetto approved these changes Oct 28, 2024

View reviewed changes

prateek-kumar-improving approved these changes Oct 28, 2024

View reviewed changes

Fix example for explain

b7165f7

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

acarbonetto temporarily deployed to AWS_ACTIONS October 28, 2024 22:39 — with GitHub Actions Inactive

Yury-Fridlyand approved these changes Oct 28, 2024

View reviewed changes

java/client/src/main/java/glide/api/commands/servermodules/FT.java Show resolved Hide resolved

java/client/src/main/java/glide/api/commands/servermodules/FT.java Outdated Show resolved Hide resolved

Fix example for explain

049a3f6

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

acarbonetto temporarily deployed to AWS_ACTIONS October 28, 2024 22:47 — with GitHub Actions Inactive

yipin-chen approved these changes Oct 28, 2024

View reviewed changes

Yury-Fridlyand merged commit ddca067 into release-1.2 Oct 28, 2024
14 checks passed

Yury-Fridlyand deleted the java/cyip10_vss_explain_explaincli branch October 28, 2024 23:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java: FT.EXPLAIN and FT.EXPLAINCLI #2515

Java: FT.EXPLAIN and FT.EXPLAINCLI #2515

cyip10 commented Oct 24, 2024 •

edited by acarbonetto

Loading

jamesx-improving Oct 28, 2024

jamesx-improving Oct 28, 2024

jamesx-improving Oct 28, 2024

Yury-Fridlyand left a comment

	var args = concatenateArrays(new GlideString[] {gs("FT.EXPLAIN"), gs(indexName), gs(query)});
	GlideString[] args = new GlideString[] {gs("FT.EXPLAIN"), gs(indexName), gs(query)};

Java: FT.EXPLAIN and FT.EXPLAINCLI #2515

Java: FT.EXPLAIN and FT.EXPLAINCLI #2515

Conversation

cyip10 commented Oct 24, 2024 • edited by acarbonetto Loading

Issue link

Checklist

jamesx-improving Oct 28, 2024

Choose a reason for hiding this comment

jamesx-improving Oct 28, 2024

Choose a reason for hiding this comment

jamesx-improving Oct 28, 2024

Choose a reason for hiding this comment

Yury-Fridlyand left a comment

Choose a reason for hiding this comment

cyip10 commented Oct 24, 2024 •

edited by acarbonetto

Loading