This is an automated email from the ASF dual-hosted git repository.
starocean999 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/master by this push:
new 1392084da8d [Enhancement] (nereids)implement helpCommand in nereids
(#44819)
1392084da8d is described below
commit 1392084da8d75a42dbaf4d7fb051a5d6ba361257
Author: Sridhar R Manikarnike <[email protected]>
AuthorDate: Tue Dec 24 13:06:27 2024 +0530
[Enhancement] (nereids)implement helpCommand in nereids (#44819)
Issue Number: close #42824
---
.../antlr4/org/apache/doris/nereids/DorisParser.g4 | 8 +-
.../doris/nereids/parser/LogicalPlanBuilder.java | 8 ++
.../apache/doris/nereids/trees/plans/PlanType.java | 1 +
.../nereids/trees/plans/commands/HelpCommand.java | 132 +++++++++++++++++++++
.../trees/plans/visitor/CommandVisitor.java | 5 +
.../nereids_p0/show/test_help_command.groovy | 34 ++++++
6 files changed, 186 insertions(+), 2 deletions(-)
diff --git a/fe/fe-core/src/main/antlr4/org/apache/doris/nereids/DorisParser.g4
b/fe/fe-core/src/main/antlr4/org/apache/doris/nereids/DorisParser.g4
index 37e1c68cefb..eba16aa6127 100644
--- a/fe/fe-core/src/main/antlr4/org/apache/doris/nereids/DorisParser.g4
+++ b/fe/fe-core/src/main/antlr4/org/apache/doris/nereids/DorisParser.g4
@@ -63,6 +63,7 @@ statementBase
| supportedRecoverStatement #supportedRecoverStatementAlias
| supportedAdminStatement #supportedAdminStatementAlias
| supportedUseStatement #supportedUseStatementAlias
+ | supportedOtherStatement #supportedOtherStatementAlias
| unsupportedStatement #unsupported
;
@@ -290,9 +291,12 @@ supportedLoadStatement
| createRoutineLoad
#createRoutineLoadAlias
;
-unsupportedOtherStatement
+supportedOtherStatement
: HELP mark=identifierOrText
#help
- | INSTALL PLUGIN FROM source=identifierOrText properties=propertyClause?
#installPlugin
+ ;
+
+unsupportedOtherStatement
+ : INSTALL PLUGIN FROM source=identifierOrText properties=propertyClause?
#installPlugin
| UNINSTALL PLUGIN name=identifierOrText
#uninstallPlugin
| LOCK TABLES (lockTable (COMMA lockTable)*)?
#lockTables
| UNLOCK TABLES
#unlockTables
diff --git
a/fe/fe-core/src/main/java/org/apache/doris/nereids/parser/LogicalPlanBuilder.java
b/fe/fe-core/src/main/java/org/apache/doris/nereids/parser/LogicalPlanBuilder.java
index d98d0660f5c..54717302493 100644
---
a/fe/fe-core/src/main/java/org/apache/doris/nereids/parser/LogicalPlanBuilder.java
+++
b/fe/fe-core/src/main/java/org/apache/doris/nereids/parser/LogicalPlanBuilder.java
@@ -144,6 +144,7 @@ import
org.apache.doris.nereids.DorisParser.FromClauseContext;
import org.apache.doris.nereids.DorisParser.GroupingElementContext;
import org.apache.doris.nereids.DorisParser.GroupingSetContext;
import org.apache.doris.nereids.DorisParser.HavingClauseContext;
+import org.apache.doris.nereids.DorisParser.HelpContext;
import org.apache.doris.nereids.DorisParser.HintAssignmentContext;
import org.apache.doris.nereids.DorisParser.HintStatementContext;
import org.apache.doris.nereids.DorisParser.IdentifierContext;
@@ -551,6 +552,7 @@ import
org.apache.doris.nereids.trees.plans.commands.DropWorkloadPolicyCommand;
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.commands.ExportCommand;
+import org.apache.doris.nereids.trees.plans.commands.HelpCommand;
import org.apache.doris.nereids.trees.plans.commands.LoadCommand;
import org.apache.doris.nereids.trees.plans.commands.PauseJobCommand;
import org.apache.doris.nereids.trees.plans.commands.PauseMTMVCommand;
@@ -5087,6 +5089,12 @@ public class LogicalPlanBuilder extends
DorisParserBaseVisitor<Object> {
return new ShowProcessListCommand(ctx.FULL() != null);
}
+ @Override
+ public LogicalPlan visitHelp(HelpContext ctx) {
+ String mark = ctx.mark.getText();
+ return new HelpCommand(mark);
+ }
+
@Override
public LogicalPlan visitSync(SyncContext ctx) {
return new SyncCommand();
diff --git
a/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/PlanType.java
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/PlanType.java
index 2860ec10092..06d2287de53 100644
---
a/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/PlanType.java
+++
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/PlanType.java
@@ -268,5 +268,6 @@ public enum PlanType {
SHOW_TABLE_CREATION_COMMAND,
SHOW_QUERY_PROFILE_COMMAND,
SWITCH_COMMAND,
+ HELP_COMMAND,
USE_COMMAND
}
diff --git
a/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/HelpCommand.java
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/HelpCommand.java
new file mode 100644
index 00000000000..49acc914eae
--- /dev/null
+++
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/HelpCommand.java
@@ -0,0 +1,132 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.apache.doris.nereids.trees.plans.commands;
+
+import org.apache.doris.catalog.Column;
+import org.apache.doris.catalog.ScalarType;
+import org.apache.doris.common.AnalysisException;
+import org.apache.doris.nereids.trees.plans.PlanType;
+import org.apache.doris.nereids.trees.plans.visitor.PlanVisitor;
+import org.apache.doris.qe.ConnectContext;
+import org.apache.doris.qe.ShowResultSet;
+import org.apache.doris.qe.ShowResultSetMetaData;
+import org.apache.doris.qe.StmtExecutor;
+import org.apache.doris.qe.help.HelpModule;
+import org.apache.doris.qe.help.HelpTopic;
+
+import com.google.common.base.Strings;
+import com.google.common.collect.Lists;
+
+import java.util.List;
+
+/**
+ * Represents the command for HELP.
+ */
+public class HelpCommand extends ShowCommand {
+ private static final List<List<String>> EMPTY_SET = Lists.newArrayList();
+
+ private static final ShowResultSetMetaData TOPIC_META_DATA =
+ ShowResultSetMetaData.builder()
+ .addColumn(new Column("name",
ScalarType.createVarchar(64)))
+ .addColumn(new Column("description",
ScalarType.createVarchar(1000)))
+ .addColumn(new Column("example",
ScalarType.createVarchar(1000)))
+ .build();
+ private static final ShowResultSetMetaData CATEGORY_META_DATA =
+ ShowResultSetMetaData.builder()
+ .addColumn(new Column("source_category_name",
ScalarType.createVarchar(64)))
+ .addColumn(new Column("name",
ScalarType.createVarchar(64)))
+ .addColumn(new Column("is_it_category",
ScalarType.createVarchar(1)))
+ .build();
+ private static final ShowResultSetMetaData KEYWORD_META_DATA =
+ ShowResultSetMetaData.builder()
+ .addColumn(new Column("name",
ScalarType.createVarchar(64)))
+ .addColumn(new Column("is_it_category",
ScalarType.createVarchar(1)))
+ .build();
+
+ private final String mark;
+
+ public HelpCommand(String mark) {
+ super(PlanType.HELP_COMMAND);
+ this.mark = mark;
+ }
+
+ @Override
+ public ShowResultSet doRun(ConnectContext ctx, StmtExecutor executor)
throws Exception {
+ if (Strings.isNullOrEmpty(mark)) {
+ throw new AnalysisException("Help empty info.");
+ }
+ HelpModule module = HelpModule.getInstance();
+ ShowResultSet resultSet;
+
+ // Get topic
+ HelpTopic topic = module.getTopic(mark);
+ // Get by Keyword
+ if (topic == null) {
+ List<String> topics = module.listTopicByKeyword(mark);
+ if (topics.size() == 0) {
+ // assign to avoid code style problem
+ topic = null;
+ } else if (topics.size() == 1) {
+ topic = module.getTopic(topics.get(0));
+ } else {
+ // Send topic list and category list
+ List<List<String>> rows = Lists.newArrayList();
+ for (String str : topics) {
+ rows.add(Lists.newArrayList(str, "N"));
+ }
+ List<String> categories = module.listCategoryByName(mark);
+ for (String str : categories) {
+ rows.add(Lists.newArrayList(str, "Y"));
+ }
+ return new ShowResultSet(KEYWORD_META_DATA, rows);
+ }
+ }
+ if (topic != null) {
+ resultSet = new ShowResultSet(TOPIC_META_DATA,
Lists.<List<String>>newArrayList(
+ Lists.newArrayList(topic.getName(),
topic.getDescription(), topic.getExample())));
+ } else {
+ List<String> categories = module.listCategoryByName(mark);
+ if (categories.isEmpty()) {
+ // If no category match for this name, return
+ resultSet = new ShowResultSet(KEYWORD_META_DATA, EMPTY_SET);
+ } else if (categories.size() > 1) {
+ // Send category list
+ resultSet = new ShowResultSet(CATEGORY_META_DATA,
+ Lists.<List<String>>newArrayList(categories));
+ } else {
+ // Send topic list and sub-category list
+ List<List<String>> rows = Lists.newArrayList();
+ List<String> topics =
module.listTopicByCategory(categories.get(0));
+ for (String str : topics) {
+ rows.add(Lists.newArrayList(str, "N"));
+ }
+ List<String> subCategories =
module.listCategoryByCategory(categories.get(0));
+ for (String str : subCategories) {
+ rows.add(Lists.newArrayList(str, "Y"));
+ }
+ resultSet = new ShowResultSet(KEYWORD_META_DATA, rows);
+ }
+ }
+ return resultSet;
+ }
+
+ @Override
+ public <R, C> R accept(PlanVisitor<R, C> visitor, C context) {
+ return visitor.visitHelpCommand(this, context);
+ }
+}
diff --git
a/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/visitor/CommandVisitor.java
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/visitor/CommandVisitor.java
index 122e513a08c..72dad4abf1d 100644
---
a/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/visitor/CommandVisitor.java
+++
b/fe/fe-core/src/main/java/org/apache/doris/nereids/trees/plans/visitor/CommandVisitor.java
@@ -72,6 +72,7 @@ import
org.apache.doris.nereids.trees.plans.commands.DropWorkloadGroupCommand;
import org.apache.doris.nereids.trees.plans.commands.DropWorkloadPolicyCommand;
import org.apache.doris.nereids.trees.plans.commands.ExplainCommand;
import org.apache.doris.nereids.trees.plans.commands.ExportCommand;
+import org.apache.doris.nereids.trees.plans.commands.HelpCommand;
import org.apache.doris.nereids.trees.plans.commands.LoadCommand;
import org.apache.doris.nereids.trees.plans.commands.PauseJobCommand;
import org.apache.doris.nereids.trees.plans.commands.PauseMTMVCommand;
@@ -337,6 +338,10 @@ public interface CommandVisitor<R, C> {
return visitCommand(showCreateProcedureCommand, context);
}
+ default R visitHelpCommand(HelpCommand helpCommand, C context) {
+ return visitCommand(helpCommand, context);
+ }
+
default R visitCreateViewCommand(CreateViewCommand createViewCommand, C
context) {
return visitCommand(createViewCommand, context);
}
diff --git a/regression-test/suites/nereids_p0/show/test_help_command.groovy
b/regression-test/suites/nereids_p0/show/test_help_command.groovy
new file mode 100644
index 00000000000..21452ce3e46
--- /dev/null
+++ b/regression-test/suites/nereids_p0/show/test_help_command.groovy
@@ -0,0 +1,34 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+suite("test_help_command", "query,help") {
+ try {
+ // Test the HELP command for a known topic
+ checkNereidsExecute("HELP 'CREATE TABLE';")
+
+ // Test the HELP command for an unknown topic
+ checkNereidsExecute("HELP 'UNKNOWN_TOPIC';")
+
+ // Test the HELP command for a keyword with multiple matches
+ checkNereidsExecute("HELP 'ALTER';")
+ } catch (Exception e) {
+ // Log any exceptions that occur during testing
+ log.error("Failed to execute HELP command", e)
+ throw e
+ }
+}
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
