Skip to content

Prevent limit pushdown before action building instead of in action executing #4377

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
penghuo merged 2 commits into from
Sep 26, 2025
Merged

Prevent limit pushdown before action building instead of in action executing #4377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12bc91e
The limit pushdown check logic should be in action building instead o…
LantaoJin Sep 25, 2025
103f7ef
Add an explain IT
LantaoJin Sep 25, 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
11 changes: 11 additions & 0 deletions integ-test/src/test/java/org/opensearch/sql/calcite/remote/CalciteExplainIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,17 @@ public void testMvjoinExplain() throws IOException {
assertJsonEqualsIgnoreId(expected, result);
}

@Test
public void testPreventLimitPushdown() throws IOException {
enabledOnlyWhenPushdownIsEnabled();
setMaxResultWindow("opensearch-sql_test_index_account", 1);
String query = "source=opensearch-sql_test_index_account | head 1 from 1";
var result = explainQueryToString(query);
String expected = loadExpectedPlan("explain_prevent_limit_push.yaml");
assertYamlEqualsJsonIgnoreId(expected, result);
resetMaxResultWindow("opensearch-sql_test_index_account");
}

@Test
public void testPushdownLimitIntoAggregation() throws IOException {
enabledOnlyWhenPushdownIsEnabled();
Expand Down
10 changes: 10 additions & 0 deletions integ-test/src/test/resources/expectedOutput/calcite/explain_prevent_limit_push.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
calcite:
logical: |
LogicalSystemLimit(fetch=[10000], type=[QUERY_SIZE_LIMIT])
LogicalProject(account_number=[$0], firstname=[$1], address=[$2], balance=[$3], gender=[$4], city=[$5], employer=[$6], state=[$7], age=[$8], email=[$9], lastname=[$10])
LogicalSort(offset=[1], fetch=[1])
CalciteLogicalIndexScan(table=[[OpenSearch, opensearch-sql_test_index_account]])
physical: |
EnumerableLimit(fetch=[10000])
EnumerableLimit(offset=[1], fetch=[1])
CalciteEnumerableIndexScan(table=[[OpenSearch, opensearch-sql_test_index_account]], PushDownContext=[[PROJECT->[account_number, firstname, address, balance, gender, city, employer, state, age, email, lastname]], OpenSearchRequestBuilder(sourceBuilder={"from":0,"timeout":"1m","_source":{"includes":["account_number","firstname","address","balance","gender","city","employer","state","age","email","lastname"],"excludes":[]}}, requestedTotalSize=2147483647, pageSize=null, startFrom=0)])
13 changes: 13 additions & 0 deletions integ-test/src/yamlRestTest/resources/rest-api-spec/test/issues/3102.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ setup:
features:
- headers
- allowed_warnings
- do:
query.settings:
body:
transient:
plugins.calcite.enabled: true
- do:
indices.create:
index: test
Expand All @@ -21,6 +26,14 @@ setup:
- '{"index": {}}'
- '{"id": 3}'

---
teardown:
- do:
query.settings:
body:
transient:
plugins.calcite.enabled : false

---
"Prevent push down limit if the offset reach max_result_window":
- do:
Expand Down
2 changes: 2 additions & 0 deletions ...ch/src/main/java/org/opensearch/sql/opensearch/storage/scan/AbstractCalciteIndexScan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ public static class PushDownContext extends ArrayDeque<PushDownAction> {
@Getter private AggPushDownAction aggPushDownAction;
@Getter private boolean isLimitPushed = false;
@Getter private boolean isProjectPushed = false;
@Getter private int startFrom = 0;

@Override
public PushDownContext clone() {
Expand All @@ -184,6 +185,7 @@ public boolean add(PushDownAction pushDownAction) {
}
if (pushDownAction.type == PushDownType.LIMIT) {
isLimitPushed = true;
startFrom += ((LimitDigest) pushDownAction.digest).offset();
}
if (pushDownAction.type == PushDownType.PROJECT) {
isProjectPushed = true;
Expand Down
8 changes: 8 additions & 0 deletions ...rch/src/main/java/org/opensearch/sql/opensearch/storage/scan/CalciteLogicalIndexScan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import org.opensearch.sql.opensearch.planner.physical.EnumerableIndexScanRule;
import org.opensearch.sql.opensearch.planner.physical.OpenSearchIndexRules;
import org.opensearch.sql.opensearch.request.AggregateAnalyzer;
import org.opensearch.sql.opensearch.request.OpenSearchRequestBuilder;
import org.opensearch.sql.opensearch.request.PredicateAnalyzer;
import org.opensearch.sql.opensearch.request.PredicateAnalyzer.QueryExpression;
import org.opensearch.sql.opensearch.response.agg.OpenSearchAggregationResponseParser;
Expand Down Expand Up @@ -323,6 +324,13 @@ public AbstractRelNode pushDownLimit(LogicalSort sort, Integer limit, Integer of
return offset > 0 ? sort.copy(sort.getTraitSet(), List.of(newScan)) : newScan;
} else {
CalciteLogicalIndexScan newScan = this.copyWithNewSchema(getRowType());
int newStartFrom = newScan.pushDownContext.getStartFrom() + offset;
if (newStartFrom >= newScan.osIndex.getMaxResultWindow()) {
throw new OpenSearchRequestBuilder.PushDownUnSupportedException(
String.format(
"Requested offset %d should be less than the max result window %d",
newStartFrom, newScan.osIndex.getMaxResultWindow()));
}
newScan.pushDownContext.add(
PushDownAction.of(
PushDownType.LIMIT,
Expand Down
Loading