Skip to content

Simplify returnLocalAll handling in ES|QL #135353

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

Merged
merged 6 commits into from
Sep 29, 2025
Merged

Simplify returnLocalAll handling in ES|QL #135353

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79b0629
Simplify returnLocalAll handling in ES|QL
idegtiarenko Sep 24, 2025
4783ac2
Merge branch 'main' into siplify_returnLocalAll_handling
idegtiarenko Sep 24, 2025
e1aa586
Merge branch 'main' into siplify_returnLocalAll_handling
idegtiarenko Sep 25, 2025
07410b5
upd
idegtiarenko Sep 26, 2025
1d9c20e
Merge branch 'main' into siplify_returnLocalAll_handling
idegtiarenko Sep 26, 2025
f9bcc0f
Merge branch 'main' into siplify_returnLocalAll_handling
idegtiarenko Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 2 additions & 33 deletions server/src/main/java/org/elasticsearch/indices/IndicesExpressionGrouper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,8 @@

import org.elasticsearch.action.OriginalIndices;
import org.elasticsearch.action.support.IndicesOptions;
import org.elasticsearch.common.Strings;

import java.util.Map;
import java.util.Set;

/**
* Interface for grouping index expressions, along with IndicesOptions by cluster alias.
Expand All @@ -30,36 +28,7 @@
public interface IndicesExpressionGrouper {

/**
* @param remoteClusterNames Set of configured remote cluster names.
* @param indicesOptions IndicesOptions to clarify how the index expression should be parsed/applied
* @param indexExpressionCsv Multiple index expressions as CSV string (with no spaces), e.g., "logs1,logs2,cluster-a:logs1".
* A single index expression is also supported.
* @return Map where the key is the cluster alias (for "local" cluster, it is RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY)
* and the value for that cluster from the index expression is an OriginalIndices object.
* See {@link org.elasticsearch.transport.RemoteClusterService#groupIndices} for details
*/
default Map<String, OriginalIndices> groupIndices(
Set<String> remoteClusterNames,
IndicesOptions indicesOptions,
String indexExpressionCsv
) {
return groupIndices(remoteClusterNames, indicesOptions, Strings.splitStringByCommaToArray(indexExpressionCsv));
}

/**
* Same behavior as the other groupIndices, except the incoming multiple index expressions must already be
* parsed into a String array.
* @param remoteClusterNames Set of configured remote cluster names.
* @param indicesOptions IndicesOptions to clarify how the index expressions should be parsed/applied
* @param indexExpressions Multiple index expressions as string[].
* @return Map where the key is the cluster alias (for "local" cluster, it is RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY)
* and the value for that cluster from the index expression is an OriginalIndices object.
*/
Map<String, OriginalIndices> groupIndices(Set<String> remoteClusterNames, IndicesOptions indicesOptions, String[] indexExpressions);

/**
* Returns a set of currently configured remote clusters.
*/
default Set<String> getConfiguredClusters() {
return Set.of();
}
Map<String, OriginalIndices> groupIndices(IndicesOptions indicesOptions, String[] indexExpressions, boolean returnLocalAll);
}
6 changes: 1 addition & 5 deletions server/src/main/java/org/elasticsearch/transport/RemoteClusterService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ public Map<String, OriginalIndices> groupIndices(Set<String> remoteClusterNames,
return groupIndices(remoteClusterNames, indicesOptions, indices, true);
}

@Override
public Map<String, OriginalIndices> groupIndices(IndicesOptions indicesOptions, String[] indices, boolean returnLocalAll) {
return groupIndices(getRegisteredRemoteClusterNames(), indicesOptions, indices, returnLocalAll);
}
Expand All @@ -176,11 +177,6 @@ public Map<String, OriginalIndices> groupIndices(IndicesOptions indicesOptions,
return groupIndices(getRegisteredRemoteClusterNames(), indicesOptions, indices, true);
}

@Override
public Set<String> getConfiguredClusters() {
return getRegisteredRemoteClusterNames();
}

/**
* Returns the registered remote cluster names.
*/
Expand Down
14 changes: 4 additions & 10 deletions x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/session/EsqlCCSUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import org.elasticsearch.transport.ConnectTransportException;
import org.elasticsearch.transport.NoSuchRemoteClusterException;
import org.elasticsearch.transport.RemoteClusterAware;
import org.elasticsearch.transport.RemoteClusterService;
import org.elasticsearch.transport.RemoteTransportException;
import org.elasticsearch.xpack.esql.VerificationException;
import org.elasticsearch.xpack.esql.action.EsqlExecutionInfo;
Expand Down Expand Up @@ -340,11 +339,9 @@ public static void initCrossClusterState(
}
try {
var groupedIndices = indicesGrouper.groupIndices(
// indicesGrouper.getConfiguredClusters() might return mutable set that changes as clusters connect or disconnect.
// it is copied here so that we have the same resolution when request contains multiple remote cluster patterns with *
Set.copyOf(indicesGrouper.getConfiguredClusters()),
IndicesOptions.DEFAULT,
indexPattern.indexPattern()
Strings.splitStringByCommaToArray(indexPattern.indexPattern()),
false
);

executionInfo.clusterInfoInitializing(true);
Expand All @@ -363,11 +360,8 @@ public static void initCrossClusterState(
executionInfo.clusterInfoInitializing(false);
}

// check if it is a cross-cluster query
if (groupedIndices.size() > 1 || groupedIndices.containsKey(RemoteClusterService.LOCAL_CLUSTER_GROUP_KEY) == false) {
if (EsqlLicenseChecker.isCcsAllowed(licenseState) == false) {
throw EsqlLicenseChecker.invalidLicenseForCcsException(licenseState);
}
if (executionInfo.isCrossClusterSearch() && EsqlLicenseChecker.isCcsAllowed(licenseState) == false) {
throw EsqlLicenseChecker.invalidLicenseForCcsException(licenseState);
}
} catch (NoSuchRemoteClusterException e) {
if (EsqlLicenseChecker.isCcsAllowed(licenseState)) {
Expand Down
5 changes: 2 additions & 3 deletions x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/session/EsqlSession.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -688,15 +688,14 @@ private void preAnalyzeMainIndices(
ThreadPool.Names.SYSTEM_READ
);
if (preAnalysis.indexPattern() != null) {
String indexExpressionToResolve = EsqlCCSUtils.createIndexExpressionFromAvailableClusters(executionInfo);
if (indexExpressionToResolve.isEmpty()) {
if (executionInfo.clusterAliases().isEmpty()) {
Copy link
Contributor Author

@idegtiarenko idegtiarenko Sep 24, 2025

Choose a reason for hiding this comment

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

Prior this change indexExpressionToResolve could have been empty as indicesGrouper.groupIndices was executed with returnLocalAll=true.

Now we explicitly pass this param and we would get an empty resolution instead.

// if this was a pure remote CCS request (no local indices) and all remotes are offline, return an empty IndexResolution
listener.onResponse(
result.withIndices(IndexResolution.valid(new EsIndex(preAnalysis.indexPattern().indexPattern(), Map.of(), Map.of())))
);
} else {
indexResolver.resolveAsMergedMapping(
indexExpressionToResolve,
EsqlCCSUtils.createIndexExpressionFromAvailableClusters(executionInfo),
result.fieldNames,
// Maybe if no indices are returned, retry without index mode and provide a clearer error message.
switch (preAnalysis.indexMode()) {
Expand Down
6 changes: 1 addition & 5 deletions x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/session/EsqlCCSUtilsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -799,11 +799,7 @@ private XPackLicenseStatus inactiveLicenseStatus(License.OperationMode operation

static class TestIndicesExpressionGrouper implements IndicesExpressionGrouper {
@Override
public Map<String, OriginalIndices> groupIndices(
Set<String> remoteClusterNames,
IndicesOptions indicesOptions,
String[] indexExpressions
) {
public Map<String, OriginalIndices> groupIndices(IndicesOptions indicesOptions, String[] indexExpressions, boolean returnLocalAll) {
final Map<String, OriginalIndices> originalIndicesMap = new HashMap<>();
final String localKey = RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY;

Expand Down
2 changes: 1 addition & 1 deletion ...n/esql/src/test/java/org/elasticsearch/xpack/esql/telemetry/PlanExecutorMetricsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public void testFailedMetric() {
// test a failed query: xyz field doesn't exist
request.query("from test | stats m = max(xyz)");
EsqlSession.PlanRunner runPhase = (p, r) -> fail("this shouldn't happen");
IndicesExpressionGrouper groupIndicesByCluster = (remoteClusterNames, indicesOptions, indexExpressions) -> Map.of(
IndicesExpressionGrouper groupIndicesByCluster = (indicesOptions, indexExpressions, returnLocalAll) -> Map.of(
"",
new OriginalIndices(new String[] { "test" }, IndicesOptions.DEFAULT)
);
Expand Down