Added API for supporting Group By functionality

Author: arjun12102019

chat2db-server/chat2db-server-domain/chat2db-server-domain-api/src/main/java/ai/chat2db/server/domain/api/param/GroupByParam.java

@@ -0,0 +1,47 @@
+package ai.chat2db.server.domain.api.param;
+
+
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+import java.util.List;
+
+
+@Data
+public class GroupByParam {
+
+    /**
+     * console id
+     */
+    @NotNull
+    private Long consoleId;
+
+    /**
+     * Data source id
+     */
+    @NotNull
+    private Long dataSourceId;
+
+    /**
+     * databaseName
+     */
+    private String databaseName;
+
+
+    /**
+     * schema name
+     */
+    private String schemaName;
+
+
+    /**
+     * origin sql
+     */
+    private String originSql;
+
+
+    /**
+     * sort field
+     */
+    private List<String> groupByList;
+}

chat2db-server/chat2db-server-domain/chat2db-server-domain-api/src/main/java/ai/chat2db/server/domain/api/service/DlTemplateService.java

@@ -6,6 +6,7 @@
 import ai.chat2db.server.domain.api.param.UpdateSelectResultParam;
 import ai.chat2db.spi.model.ExecuteResult;
 import ai.chat2db.server.tools.base.wrapper.result.DataResult;
+import ai.chat2db.server.domain.api.param.GroupByParam;
 
 import ai.chat2db.server.tools.base.wrapper.result.ListResult;
 
@@ -58,6 +59,13 @@ public interface DlTemplateService {
      */
     DataResult<String> updateSelectResult(UpdateSelectResultParam param);
 
+    /**
+     *
+     * @param param
+     * @return
+     */
+    DataResult<String> getGroupBySql(GroupByParam param);
+
     /**
      *
      * @param param

chat2db-server/chat2db-server-domain/chat2db-server-domain-core/src/main/java/ai/chat2db/server/domain/core/impl/DlTemplateServiceImpl.java

@@ -176,7 +176,22 @@ public DataResult<String> getOrderBySql(OrderByParam param) {
         return DataResult.of(orderSql);
     }
 
-
+    
+    /**
+     * The method getGroupBySql constructs a GROUP BY SQL query string from the provided parameters.
+     *
+     * @param param - a GroupByParam object containing the original SQL query and the list of columns to group by
+     * @return DataResult<String> - a DataResult object containing the constructed GROUP BY SQL query string
+    */
+   @Override
+    public DataResult<String> getGroupBySql(GroupByParam param) {
+        // - Retrieve the SqlBuilder instance from Chat2DBContext
+        SqlBuilder sqlBuilder = Chat2DBContext.getSqlBuilder();
+        // Build the GROUP BY SQL using the provided parameters
+        String groupSql = sqlBuilder.buildGroupBySql(param.getOriginSql(), param.getGroupByList());
+        // Return the built SQL as a DataResult
+        return DataResult.of(groupSql);
+    }
     private List<Header> setColumnInfo(List<Header> headers, String tableName, String schemaName, String databaseName) {
         try {
             TableQueryParam tableQueryParam = new TableQueryParam();

chat2db-server/chat2db-server-web/chat2db-server-web-api/src/main/java/ai/chat2db/server/web/api/controller/rdb/RdbDmlController.java

@@ -8,6 +8,7 @@
 
 import ai.chat2db.server.domain.api.model.Config;
 import ai.chat2db.server.domain.api.param.DlExecuteParam;
+import ai.chat2db.server.domain.api.param.GroupByParam;
 import ai.chat2db.server.domain.api.param.OrderByParam;
 import ai.chat2db.server.domain.api.param.UpdateSelectResultParam;
 import ai.chat2db.server.domain.api.service.ConfigService;
@@ -126,6 +127,14 @@ public DataResult<String> getUpdateSelectResultSql(@RequestBody SelectResultUpda
     }
 
 
+    @RequestMapping(value = "/get_group_by_sql", method = {RequestMethod.POST, RequestMethod.PUT})
+    public DataResult<String> getGroupBySql(@RequestBody GroupByRequest request) {
+
+        GroupByParam param = rdbWebConverter.request2param(request);
+
+        return dlTemplateService.getGroupBySql(param);
+    }
+
     @RequestMapping(value = "/get_order_by_sql", method = {RequestMethod.POST, RequestMethod.PUT})
     public DataResult<String> getOrderBySql(@RequestBody OrderByRequest request) {
 

chat2db-server/chat2db-server-web/chat2db-server-web-api/src/main/java/ai/chat2db/server/web/api/controller/rdb/request/GroupByRequest.java

@@ -0,0 +1,24 @@
+package ai.chat2db.server.web.api.controller.rdb.request;
+
+import ai.chat2db.server.web.api.controller.data.source.request.DataSourceBaseRequest;
+import ai.chat2db.server.web.api.controller.data.source.request.DataSourceBaseRequestInfo;
+import ai.chat2db.spi.model.OrderBy;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class GroupByRequest extends DataSourceBaseRequest implements DataSourceBaseRequestInfo {
+
+    /**
+     * origin sql
+     */
+    private String originSql;
+
+     /**
+     * group by field
+     */
+
+    private List<String> groupByList;
+
+}

chat2db-server/chat2db-spi/src/main/java/ai/chat2db/spi/SqlBuilder.java

@@ -75,6 +75,13 @@ public interface SqlBuilder<T> {
      */
     String buildOrderBySql(String originSql, List<OrderBy> orderByList);
 
+    /**
+     * @param originSql
+     * @param groupByList
+     * @return
+     */
+    String buildGroupBySql(String originSql, List<String> groupByList);
+
 
     /**
      * generate sql based on results

chat2db-server/chat2db-spi/src/main/java/ai/chat2db/spi/jdbc/DefaultSqlBuilder.java

@@ -10,6 +10,7 @@
 import net.sf.jsqlparser.parser.CCJSqlParserUtil;
 import net.sf.jsqlparser.statement.Statement;
 import net.sf.jsqlparser.statement.select.OrderByElement;
+import net.sf.jsqlparser.statement.select.GroupByElement;
 import net.sf.jsqlparser.statement.select.PlainSelect;
 import net.sf.jsqlparser.statement.select.Select;
 import org.apache.commons.collections4.CollectionUtils;
@@ -89,6 +90,33 @@ public String buildOrderBySql(String originSql, List<OrderBy> orderByList) {
         return originSql;
     }
 
+    @Override
+	public String buildGroupBySql(String originSql, List<String> groupByList) {
+		if (CollectionUtils.isEmpty(groupByList)) {
+			return originSql;
+		}
+		try {
+			Statement statement = CCJSqlParserUtil.parse(originSql);
+			if (statement instanceof Select) {
+				Select selectStatement = (Select) statement;
+				PlainSelect plainSelect = (PlainSelect) selectStatement.getSelectBody();
+
+				// Create a new GROUP BY clause
+				// Replace the original GROUP BY clause
+				GroupByElement grouByElement = new GroupByElement();
+				grouByElement.setGroupingSets(groupByList);
+				plainSelect.setGroupByElement(grouByElement);
+				// Output the modified SQL
+				return plainSelect.toString();
+			}
+
+		} catch (Exception e) {
+		}
+
+		return originSql;
+	}
+
+
     @Override
     public String buildSqlByQuery(QueryResult queryResult) {
         List<Header> headerList = queryResult.getHeaderList();
@@ -305,4 +333,4 @@ private String getUpdateSql(String tableName, List<Header> headerList, List<Stri
         script.append(buildWhere(headerList, odlRow, metaSchema, keyColumns));
         return script.toString();
     }
-}
+}