Skip to content

branch-2.1: [feature](nereids) support explain command return empty string to test planner performance (#54422) #55039

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
yiguolei merged 2 commits into from
Aug 22, 2025
Merged

branch-2.1: [feature](nereids) support explain command return empty string to test planner performance (#54422) #55039

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
11fe4bb
[feature](nereids) support explain command return empty string to tes…
924060929 Aug 7, 2025
9f9592c
fix
924060929 Aug 20, 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
4 changes: 4 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/nereids/NereidsPlanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,10 @@ public String getHintExplainString(List<Hint> hints) {

@Override
public String getExplainString(ExplainOptions explainOptions) {
ConnectContext context = cascadesContext == null ? ConnectContext.get() : cascadesContext.getConnectContext();
if (context.getSessionVariable().enableExplainNone) {
return "";
}
ExplainLevel explainLevel = getExplainLevel(explainOptions);
String plan = "";
String mvSummary = "";
Expand Down
5 changes: 5 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/planner/Planner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.apache.doris.common.UserException;
import org.apache.doris.common.profile.PlanTreeBuilder;
import org.apache.doris.common.profile.PlanTreePrinter;
import org.apache.doris.qe.ConnectContext;
import org.apache.doris.qe.ResultSet;
import org.apache.doris.thrift.TQueryOptions;

Expand Down Expand Up @@ -52,6 +53,10 @@ public abstract void plan(StatementBase queryStmt,

public String getExplainString(ExplainOptions explainOptions) {
Preconditions.checkNotNull(explainOptions);
ConnectContext connectContext = ConnectContext.get();
if (connectContext != null && connectContext.getSessionVariable().enableExplainNone) {
return "";
}
if (explainOptions.isGraph()) {
// print the plan graph
PlanTreeBuilder builder = new PlanTreeBuilder(fragments);
Expand Down
8 changes: 8 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/qe/SessionVariable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2063,6 +2063,8 @@ public void setIgnoreRuntimeFilterIds(String ignoreRuntimeFilterIds) {

public static final String IGNORE_SHAPE_NODE = "ignore_shape_nodes";

public static final String ENABLE_EXPLAIN_NONE = "enable_explain_none";

public static final String DETAIL_SHAPE_NODES = "detail_shape_nodes";

public Set<String> getIgnoreShapePlanNodes() {
Expand All @@ -2083,6 +2085,12 @@ public void setIgnoreShapePlanNodes(String ignoreShapePlanNodes) {
"the plan node type show detail in 'explain shape plan' command"})
public String detailShapePlanNodes = "";

@VariableMgr.VarAttr(name = ENABLE_EXPLAIN_NONE, needForward = true, description = {
"执行explain命令，但不打印explain结果",
"execute explain command and return nothing"
})
public boolean enableExplainNone = false;

private Set<String> detailShapePlanNodesSet = ImmutableSet.of();

public Set<String> getDetailShapePlanNodesSet() {
Expand Down
19 changes: 19 additions & 0 deletions fe/fe-core/src/test/java/org/apache/doris/nereids/trees/plans/ExplainInsertCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

package org.apache.doris.nereids.trees.plans;

import org.apache.doris.analysis.ExplainOptions;
import org.apache.doris.nereids.NereidsPlanner;
import org.apache.doris.nereids.StatementContext;
import org.apache.doris.nereids.exceptions.AnalysisException;
Expand All @@ -26,10 +27,12 @@
import org.apache.doris.nereids.properties.PhysicalProperties;
import org.apache.doris.nereids.trees.expressions.StatementScopeIdGenerator;
import org.apache.doris.nereids.trees.plans.commands.ExplainCommand;
import org.apache.doris.nereids.trees.plans.commands.ExplainCommand.ExplainLevel;
import org.apache.doris.nereids.trees.plans.logical.LogicalPlan;
import org.apache.doris.nereids.trees.plans.physical.PhysicalPlan;
import org.apache.doris.nereids.util.MemoTestUtils;
import org.apache.doris.planner.PlanFragment;
import org.apache.doris.qe.StmtExecutor;
import org.apache.doris.utframe.TestWithFeService;

import org.junit.jupiter.api.Assertions;
Expand Down Expand Up @@ -134,6 +137,22 @@ public void testWithMV() throws Exception {
Assertions.assertEquals(8, getOutputFragment(sql).getOutputExprs().size());
}

@Test
public void explainNone() throws Exception {
String sql = "explain insert into agg_have_dup_base select -4, -4, -4, 'd'";
connectContext.getSessionVariable().enableExplainNone = false;
StmtExecutor sqlStmtExecutor = getSqlStmtExecutor(sql);
String explainString = sqlStmtExecutor.planner()
.getExplainString(new ExplainOptions(ExplainLevel.VERBOSE, false));
Assertions.assertNotEquals("", explainString);

connectContext.getSessionVariable().enableExplainNone = true;
sqlStmtExecutor = getSqlStmtExecutor(sql);
explainString = sqlStmtExecutor.planner()
.getExplainString(new ExplainOptions(ExplainLevel.VERBOSE, false));
Assertions.assertEquals("", explainString);
}

private PlanFragment getOutputFragment(String sql) throws Exception {
StatementScopeIdGenerator.clear();
StatementContext statementContext = MemoTestUtils.createStatementContext(connectContext, sql);
Expand Down