Support appendcol command with Calcite (opensearch-project#3729)

LantaoJin · web-flow · commit f2365b48150a · 2025-06-05T07:06:24.000+08:00
diff --git a/core/src/main/java/org/opensearch/sql/analysis/Analyzer.java b/core/src/main/java/org/opensearch/sql/analysis/Analyzer.java
@@ -47,6 +47,7 @@
 import org.opensearch.sql.ast.expression.UnresolvedExpression;
 import org.opensearch.sql.ast.tree.AD;
 import org.opensearch.sql.ast.tree.Aggregation;
+import org.opensearch.sql.ast.tree.AppendCol;
 import org.opensearch.sql.ast.tree.CloseCursor;
 import org.opensearch.sql.ast.tree.Dedupe;
 import org.opensearch.sql.ast.tree.Eval;
@@ -702,6 +703,12 @@ public LogicalPlan visitLookup(Lookup node, AnalysisContext context) {
         "Lookup is supported only when " + CALCITE_ENGINE_ENABLED.getKeyValue() + "=true");
   }
 
+  @Override
+  public LogicalPlan visitAppendCol(AppendCol node, AnalysisContext context) {
+    throw new UnsupportedOperationException(
+        "AppendCol is supported only when " + CALCITE_ENGINE_ENABLED.getKeyValue() + "=true");
+  }
+
   private LogicalSort buildSort(
       LogicalPlan child, AnalysisContext context, List<Field> sortFields) {
     ExpressionReferenceOptimizer optimizer =
diff --git a/core/src/main/java/org/opensearch/sql/ast/AbstractNodeVisitor.java b/core/src/main/java/org/opensearch/sql/ast/AbstractNodeVisitor.java
@@ -45,6 +45,7 @@
 import org.opensearch.sql.ast.statement.Statement;
 import org.opensearch.sql.ast.tree.AD;
 import org.opensearch.sql.ast.tree.Aggregation;
+import org.opensearch.sql.ast.tree.AppendCol;
 import org.opensearch.sql.ast.tree.CloseCursor;
 import org.opensearch.sql.ast.tree.Dedupe;
 import org.opensearch.sql.ast.tree.Eval;
@@ -371,4 +372,8 @@ public T visitScalarSubquery(ScalarSubquery node, C context) {
   public T visitExistsSubquery(ExistsSubquery node, C context) {
     return visitChildren(node, context);
   }
+
+  public T visitAppendCol(AppendCol node, C context) {
+    return visitChildren(node, context);
+  }
 }
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/AD.java b/core/src/main/java/org/opensearch/sql/ast/tree/AD.java
@@ -41,6 +41,6 @@ public <T, C> T accept(AbstractNodeVisitor<T, C> nodeVisitor, C context) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Aggregation.java b/core/src/main/java/org/opensearch/sql/ast/tree/Aggregation.java
@@ -63,7 +63,7 @@ public Aggregation attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/AppendCol.java b/core/src/main/java/org/opensearch/sql/ast/tree/AppendCol.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.sql.ast.tree;
+
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+import org.opensearch.sql.ast.AbstractNodeVisitor;
+import org.opensearch.sql.ast.Node;
+
+/**
+ * Logical plan node of AppendCol, the interface for building appending column actions in queries.
+ */
+@Getter
+@Setter
+@ToString
+@EqualsAndHashCode(callSuper = false)
+@RequiredArgsConstructor
+public class AppendCol extends UnresolvedPlan {
+
+  private final boolean override;
+
+  private final UnresolvedPlan subSearch;
+
+  private UnresolvedPlan child;
+
+  @Override
+  public UnresolvedPlan attach(UnresolvedPlan child) {
+    this.child = child;
+    return this;
+  }
+
+  @Override
+  public List<? extends Node> getChild() {
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
+  }
+
+  @Override
+  public <T, C> T accept(AbstractNodeVisitor<T, C> visitor, C context) {
+    return visitor.visitAppendCol(this, context);
+  }
+}
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/CloseCursor.java b/core/src/main/java/org/opensearch/sql/ast/tree/CloseCursor.java
@@ -5,6 +5,7 @@
 
 package org.opensearch.sql.ast.tree;
 
+import com.google.common.collect.ImmutableList;
 import java.util.List;
 import org.opensearch.sql.ast.AbstractNodeVisitor;
 import org.opensearch.sql.ast.Node;
@@ -28,6 +29,6 @@ public UnresolvedPlan attach(UnresolvedPlan child) {
 
   @Override
   public List<? extends Node> getChild() {
-    return List.of(cursor);
+    return this.cursor == null ? ImmutableList.of() : ImmutableList.of(this.cursor);
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Dedupe.java b/core/src/main/java/org/opensearch/sql/ast/tree/Dedupe.java
@@ -37,7 +37,7 @@ public Dedupe attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Eval.java b/core/src/main/java/org/opensearch/sql/ast/tree/Eval.java
@@ -33,7 +33,7 @@ public Eval attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/FillNull.java b/core/src/main/java/org/opensearch/sql/ast/tree/FillNull.java
@@ -5,6 +5,7 @@
 
 package org.opensearch.sql.ast.tree;
 
+import com.google.common.collect.ImmutableList;
 import java.util.List;
 import java.util.Optional;
 import lombok.EqualsAndHashCode;
@@ -59,7 +60,7 @@ public FillNull attach(UnresolvedPlan child) {
 
   @Override
   public List<? extends Node> getChild() {
-    return child == null ? List.of() : List.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Filter.java b/core/src/main/java/org/opensearch/sql/ast/tree/Filter.java
@@ -33,7 +33,7 @@ public Filter attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Head.java b/core/src/main/java/org/opensearch/sql/ast/tree/Head.java
@@ -36,7 +36,7 @@ public Head attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Join.java b/core/src/main/java/org/opensearch/sql/ast/tree/Join.java
@@ -38,7 +38,7 @@ public UnresolvedPlan attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(left);
+    return this.left == null ? ImmutableList.of() : ImmutableList.of(this.left);
   }
 
   public List<UnresolvedPlan> getChildren() {
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Kmeans.java b/core/src/main/java/org/opensearch/sql/ast/tree/Kmeans.java
@@ -41,6 +41,6 @@ public <T, C> T accept(AbstractNodeVisitor<T, C> nodeVisitor, C context) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Limit.java b/core/src/main/java/org/opensearch/sql/ast/tree/Limit.java
@@ -30,7 +30,7 @@ public Limit attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Lookup.java b/core/src/main/java/org/opensearch/sql/ast/tree/Lookup.java
@@ -47,7 +47,7 @@ public UnresolvedPlan attach(UnresolvedPlan child) {
 
   @Override
   public List<? extends Node> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/ML.java b/core/src/main/java/org/opensearch/sql/ast/tree/ML.java
@@ -61,7 +61,7 @@ public <T, C> T accept(AbstractNodeVisitor<T, C> nodeVisitor, C context) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   private String getAction() {
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Paginate.java b/core/src/main/java/org/opensearch/sql/ast/tree/Paginate.java
@@ -5,6 +5,7 @@
 
 package org.opensearch.sql.ast.tree;
 
+import com.google.common.collect.ImmutableList;
 import java.util.List;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -28,7 +29,7 @@ public Paginate(int pageSize, UnresolvedPlan child) {
 
   @Override
   public List<? extends Node> getChild() {
-    return List.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Parse.java b/core/src/main/java/org/opensearch/sql/ast/tree/Parse.java
@@ -50,7 +50,7 @@ public Parse attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Patterns.java b/core/src/main/java/org/opensearch/sql/ast/tree/Patterns.java
@@ -39,7 +39,7 @@ public Patterns attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Project.java b/core/src/main/java/org/opensearch/sql/ast/tree/Project.java
@@ -56,7 +56,7 @@ public Project attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/RareTopN.java b/core/src/main/java/org/opensearch/sql/ast/tree/RareTopN.java
@@ -5,7 +5,7 @@
 
 package org.opensearch.sql.ast.tree;
 
-import java.util.Collections;
+import com.google.common.collect.ImmutableList;
 import java.util.List;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
@@ -42,7 +42,7 @@ public RareTopN attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return Collections.singletonList(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/RelationSubquery.java b/core/src/main/java/org/opensearch/sql/ast/tree/RelationSubquery.java
@@ -29,7 +29,7 @@ public String getAliasAsTableName() {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(query);
+    return this.query == null ? ImmutableList.of() : ImmutableList.of(this.query);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Rename.java b/core/src/main/java/org/opensearch/sql/ast/tree/Rename.java
@@ -60,7 +60,7 @@ public Rename attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Sort.java b/core/src/main/java/org/opensearch/sql/ast/tree/Sort.java
@@ -39,7 +39,7 @@ public Sort attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/SubqueryAlias.java b/core/src/main/java/org/opensearch/sql/ast/tree/SubqueryAlias.java
@@ -30,7 +30,7 @@ public SubqueryAlias(String alias, UnresolvedPlan child) {
   }
 
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Trendline.java b/core/src/main/java/org/opensearch/sql/ast/tree/Trendline.java
@@ -35,7 +35,7 @@ public Trendline attach(UnresolvedPlan child) {
 
   @Override
   public List<? extends Node> getChild() {
-    return ImmutableList.of(child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/ast/tree/Window.java b/core/src/main/java/org/opensearch/sql/ast/tree/Window.java
@@ -21,7 +21,7 @@
 public class Window extends UnresolvedPlan {
 
   private final List<UnresolvedExpression> windowFunctionList;
-  private UnresolvedPlan child;
+  @ToString.Exclude private UnresolvedPlan child;
 
   @Override
   public Window attach(UnresolvedPlan child) {
@@ -31,7 +31,7 @@ public Window attach(UnresolvedPlan child) {
 
   @Override
   public List<UnresolvedPlan> getChild() {
-    return ImmutableList.of(this.child);
+    return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);
   }
 
   @Override
diff --git a/core/src/main/java/org/opensearch/sql/calcite/CalciteRelNodeVisitor.java b/core/src/main/java/org/opensearch/sql/calcite/CalciteRelNodeVisitor.java
diff --git a/core/src/main/java/org/opensearch/sql/calcite/utils/PlanUtils.java b/core/src/main/java/org/opensearch/sql/calcite/utils/PlanUtils.java
diff --git a/docs/user/ppl/cmd/appendcol.rst b/docs/user/ppl/cmd/appendcol.rst
diff --git a/integ-test/src/test/java/org/opensearch/sql/calcite/standalone/CalcitePPLAppendcolIT.java b/integ-test/src/test/java/org/opensearch/sql/calcite/standalone/CalcitePPLAppendcolIT.java
diff --git a/integ-test/src/test/java/org/opensearch/sql/calcite/standalone/CalcitePPLAppendcolPushdownIT.java b/integ-test/src/test/java/org/opensearch/sql/calcite/standalone/CalcitePPLAppendcolPushdownIT.java
diff --git a/integ-test/src/test/java/org/opensearch/sql/ppl/NewAddedCommandsIT.java b/integ-test/src/test/java/org/opensearch/sql/ppl/NewAddedCommandsIT.java
diff --git a/ppl/src/main/antlr/OpenSearchPPLLexer.g4 b/ppl/src/main/antlr/OpenSearchPPLLexer.g4
diff --git a/ppl/src/main/antlr/OpenSearchPPLParser.g4 b/ppl/src/main/antlr/OpenSearchPPLParser.g4
diff --git a/ppl/src/main/java/org/opensearch/sql/ppl/parser/AstBuilder.java b/ppl/src/main/java/org/opensearch/sql/ppl/parser/AstBuilder.java
diff --git a/ppl/src/main/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizer.java b/ppl/src/main/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizer.java
diff --git a/ppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLAppendcolTest.java b/ppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLAppendcolTest.java
diff --git a/ppl/src/test/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizerTest.java b/ppl/src/test/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizerTest.java

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ public <T, C> T accept(AbstractNodeVisitor<T, C> nodeVisitor, C context) {`
`41`	`41`
`42`	`42`	`@Override`
`43`	`43`	`public List<UnresolvedPlan> getChild() {`
`44`		`- return ImmutableList.of(this.child);`
	`44`	`+ return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);`
`45`	`45`	`}`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public Aggregation attach(UnresolvedPlan child) {`
`63`	`63`
`64`	`64`	`@Override`
`65`	`65`	`public List<UnresolvedPlan> getChild() {`
`66`		`- return ImmutableList.of(this.child);`
	`66`	`+ return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`package org.opensearch.sql.ast.tree;`
`7`	`7`
	`8`	`+import com.google.common.collect.ImmutableList;`
`8`	`9`	`import java.util.List;`
`9`	`10`	`import org.opensearch.sql.ast.AbstractNodeVisitor;`
`10`	`11`	`import org.opensearch.sql.ast.Node;`
`@@ -28,6 +29,6 @@ public UnresolvedPlan attach(UnresolvedPlan child) {`
`28`	`29`
`29`	`30`	`@Override`
`30`	`31`	`public List<? extends Node> getChild() {`
`31`		`- return List.of(cursor);`
	`32`	`+ return this.cursor == null ? ImmutableList.of() : ImmutableList.of(this.cursor);`
`32`	`33`	`}`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public Dedupe attach(UnresolvedPlan child) {`
`37`	`37`
`38`	`38`	`@Override`
`39`	`39`	`public List<UnresolvedPlan> getChild() {`
`40`		`- return ImmutableList.of(this.child);`
	`40`	`+ return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public Eval attach(UnresolvedPlan child) {`
`33`	`33`
`34`	`34`	`@Override`
`35`	`35`	`public List<UnresolvedPlan> getChild() {`
`36`		`- return ImmutableList.of(this.child);`
	`36`	`+ return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public Filter attach(UnresolvedPlan child) {`
`33`	`33`
`34`	`34`	`@Override`
`35`	`35`	`public List<UnresolvedPlan> getChild() {`
`36`		`- return ImmutableList.of(child);`
	`36`	`+ return this.child == null ? ImmutableList.of() : ImmutableList.of(this.child);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`@Override`