CLIENT-4226 Support selecting secondary index by name hint by agrgr · Pull Request #64 · aerospike/expression-dsl-java

agrgr · 2026-02-20T14:40:15Z

Support selecting secondary index by name using a hint
The fields namespace, bin, indexType, and binValuesRatio are made mandatory
Support selecting secondary index by bin name using a hint hint

Copilot

Pull request overview

Adds support for explicitly selecting a secondary index by name (via IndexContext) when parsing DSL expressions, and extends test coverage to validate the new hint behavior and its fallbacks.

Changes:

Introduce IndexContext.of(namespace, indexes, indexToUse) to allow callers to request a specific index by name.
Add parsed-expression tests covering explicit index selection, fallback behavior (missing/null/empty hint), and interaction with OR expressions.
Add a test asserting that a top-level OR never produces an SI filter even if an explicit index is provided.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
`src/main/java/com/aerospike/dsl/IndexContext.java`	Adds a new `of(...)` overload that narrows the index set to the requested index name when present.
`src/test/java/com/aerospike/dsl/parsedExpression/LogicalParsedExpressionTests.java`	Adds test cases validating explicit index selection and fallback semantics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/main/java/com/aerospike/dsl/IndexContext.java

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/main/java/com/aerospike/dsl/Index.java

src/main/java/com/aerospike/dsl/IndexContext.java

Copilot · 2026-02-24T21:55:09Z

docs/api-reference.md

 *   **`static IndexContext of(String namespace, Collection<Index> indexes)`**: Creates a context.
-    *   `namespace`: The namespace the query will be run against.
+    *   `namespace`: The namespace the query will be run against. Must not be null or blank.
    *   `indexes`: A collection of `Index` objects representing the available secondary indexes for that namespace.


The new 3-parameter IndexContext.of method with indexToUse parameter should be documented here. This is a public API addition that allows users to specify an index hint, which is a key feature mentioned in the PR title CLIENT-4226.

Copilot · 2026-02-24T21:55:10Z

docs/guides/06-using-secondary-indexes.md

-// Create index context
-IndexContext indexContext = IndexContext.of("namespace", List.of(cityIndex));
+// Create index context (namespace must not be null or blank)
+IndexContext indexContext = IndexContext.of("test", List.of(cityIndex));


Consider adding a section to this guide explaining how to use the new index hint feature with the 3-parameter IndexContext.of method. This would help users understand when and how to explicitly specify which secondary index to use, which is the main feature of this PR (CLIENT-4226).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-25T13:06:50Z

src/main/java/com/aerospike/dsl/IndexContext.java

+    public static IndexContext of(String namespace, Collection<Index> indexes, String indexToUse) {
+        validateNamespace(namespace);
+        List<Index> matchingIndexes = indexes.stream()
+                .filter(idx -> indexMatches(idx, namespace, indexToUse))
+                .toList();
+        return new IndexContext(namespace, matchingIndexes.isEmpty() ? indexes : matchingIndexes);


IndexContext.of(namespace, indexes, indexToUse) calls indexes.stream() without guarding against indexes == null, which will throw a NPE (while the 2-arg of overload currently tolerates null and the parser treats it as empty). Either reject null indexes explicitly (with a clear IllegalArgumentException) or treat null as an empty collection here to keep overload behavior consistent.

Copilot · 2026-02-25T13:06:50Z

src/main/java/com/aerospike/dsl/IndexContext.java

+    public static IndexContext withBinHint(String namespace, Collection<Index> indexes, String binToUse) {
+        validateNamespace(namespace);
+        if (binToUse == null || binToUse.isBlank()) {
+            return new IndexContext(namespace, indexes);
+        }
+        List<Index> matchingIndexes = indexes.stream()
+                .filter(idx -> binMatches(idx, namespace, binToUse))
+                .toList();
+        return new IndexContext(namespace, matchingIndexes.size() == 1 ? matchingIndexes : indexes);


IndexContext.withBinHint(...) calls indexes.stream() without guarding against indexes == null, which will throw a NPE. Consider either validating indexes is non-null (and failing fast with IllegalArgumentException) or treating null as an empty collection, consistent with how the parser treats a null index collection.

Copilot · 2026-02-25T13:06:50Z

src/main/java/com/aerospike/dsl/IndexContext.java

+    private static boolean indexMatches(Index idx, String namespace, String indexToUse) {
+        if (idx == null || indexToUse == null) {
+            return false;
+        }
+
+        String indexName = idx.getName();
+        if (indexName == null || !indexName.equals(indexToUse)) {
+            return false;
+        }
+
+        return namespace.equals(idx.getNamespace());
+    }


indexMatches treats only null as “no hint”. The docs/Javadoc for IndexContext.of(..., indexToUse) state that an empty hint should trigger automatic selection, but passing "" can still match an index whose name is also "" (since Index.name isn’t validated). Consider ignoring blank/empty hints (indexToUse == null || indexToUse.isBlank()) so behavior matches the documented contract.

… tests

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Support secondary index name hint

1770f4d

agrgr requested a review from Copilot February 20, 2026 14:40

agrgr added the enhancement New feature or request label Feb 20, 2026

Copilot started reviewing on behalf of agrgr February 20, 2026 14:40 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

src/main/java/com/aerospike/dsl/IndexContext.java Outdated Show resolved Hide resolved

agrgr and others added 3 commits February 20, 2026 15:48

Update src/main/java/com/aerospike/dsl/IndexContext.java

dd09ab1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add tests

3edb2de

Make namespace, bin, indexType, and binValuesRatio mandatory fields

34da072

agrgr requested a review from Copilot February 24, 2026 21:50

Copilot started reviewing on behalf of agrgr February 24, 2026 21:50 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

agrgr and others added 4 commits February 24, 2026 22:57

Update src/main/java/com/aerospike/dsl/IndexContext.java

8c827d8

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update src/main/java/com/aerospike/dsl/Index.java

fef2324

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Make binValuesRatio fully mandatory

1e80db2

Support bin name hint

0ff1f3e

agrgr requested a review from Copilot February 25, 2026 13:01

Copilot started reviewing on behalf of agrgr February 25, 2026 13:02 View session

agrgr changed the title ~~CLIENT-4226 Support selecting secondary index name via a hint~~ CLIENT-4226 Support selecting secondary index by name via a hint Feb 25, 2026

Copilot AI reviewed Feb 25, 2026

View reviewed changes

Guard against empty index name hints and null indexes collection, add…

e9e25e4

… tests

agrgr requested a review from Copilot February 25, 2026 13:22

Copilot started reviewing on behalf of agrgr February 25, 2026 13:23 View session

Copilot AI reviewed Feb 25, 2026

View reviewed changes

agrgr marked this pull request as ready for review February 25, 2026 13:28

agrgr requested a review from tim-aero February 25, 2026 13:29

agrgr changed the title ~~CLIENT-4226 Support selecting secondary index by name via a hint~~ CLIENT-4226 Support selecting secondary index by name hint Feb 25, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLIENT-4226 Support selecting secondary index by name hint#64

CLIENT-4226 Support selecting secondary index by name hint#64
agrgr wants to merge 9 commits intomainfrom
CLIENT-4226-support-secondary-index-hint

agrgr commented Feb 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 25, 2026

Uh oh!

Copilot AI Feb 25, 2026

Uh oh!

Copilot AI Feb 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

agrgr commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

agrgr commented Feb 20, 2026 •

edited

Loading