(improvement)(project) support explain in semantic and show explain sql in web and fix chat start error (#103)

2025-12-11 12:07:42 +00:00 · 2023-09-19 16:38:24 +08:00
parent 13dcf0edb9
commit a94a44826b
17 changed files with 367 additions and 110 deletions
--- a/semantic/api/src/main/java/com/tencent/supersonic/semantic/api/model/response/ExplainResp.java
+++ b/semantic/api/src/main/java/com/tencent/supersonic/semantic/api/model/response/ExplainResp.java
@@ -0,0 +1,19 @@
+package com.tencent.supersonic.semantic.api.model.response;
+
+import java.io.Serializable;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@Data
+@ToString
+@Builder
+@AllArgsConstructor
+@NoArgsConstructor
+public class ExplainResp implements Serializable {
+
+    private String sql;
+
+}
--- a/semantic/api/src/main/java/com/tencent/supersonic/semantic/api/query/request/ExplainSqlReq.java
+++ b/semantic/api/src/main/java/com/tencent/supersonic/semantic/api/query/request/ExplainSqlReq.java
@@ -0,0 +1,20 @@
+package com.tencent.supersonic.semantic.api.query.request;
+
+import com.tencent.supersonic.semantic.api.model.enums.QueryTypeEnum;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@Data
+@ToString
+@Builder
+@AllArgsConstructor
+@NoArgsConstructor
+public class ExplainSqlReq<T> {
+
+    private QueryTypeEnum queryTypeEnum;
+
+    private T queryReq;
+}
--- a/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/rest/QueryController.java
+++ b/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/rest/QueryController.java
@@ -2,18 +2,22 @@ package com.tencent.supersonic.semantic.query.rest;

 import com.tencent.supersonic.auth.api.authentication.pojo.User;
 import com.tencent.supersonic.auth.api.authentication.utils.UserHolder;
+import com.tencent.supersonic.common.util.JsonUtil;
+import com.tencent.supersonic.semantic.api.model.enums.QueryTypeEnum;
+import com.tencent.supersonic.semantic.api.model.response.ExplainResp;
 import com.tencent.supersonic.semantic.api.model.response.QueryResultWithSchemaResp;
 import com.tencent.supersonic.semantic.api.model.response.SqlParserResp;
+import com.tencent.supersonic.semantic.api.query.request.ExplainSqlReq;
+import com.tencent.supersonic.semantic.api.query.request.ItemUseReq;
+import com.tencent.supersonic.semantic.api.query.request.ParseSqlReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDimValueReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDslReq;
-import com.tencent.supersonic.semantic.api.query.request.ParseSqlReq;
-import com.tencent.supersonic.semantic.api.query.request.QueryStructReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryMultiStructReq;
-import com.tencent.supersonic.semantic.api.query.request.ItemUseReq;
+import com.tencent.supersonic.semantic.api.query.request.QueryStructReq;
 import com.tencent.supersonic.semantic.api.query.response.ItemUseResp;
-import com.tencent.supersonic.semantic.query.service.SemanticQueryEngine;
-import com.tencent.supersonic.semantic.query.service.QueryService;
 import com.tencent.supersonic.semantic.query.persistence.pojo.QueryStatement;
+import com.tencent.supersonic.semantic.query.service.QueryService;
+import com.tencent.supersonic.semantic.query.service.SemanticQueryEngine;
 import java.util.List;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -89,10 +93,36 @@ public class QueryController {

    @PostMapping("/queryDimValue")
    public QueryResultWithSchemaResp queryDimValue(@RequestBody QueryDimValueReq queryDimValueReq,
-                                                   HttpServletRequest request,
-                                                   HttpServletResponse response) {
+            HttpServletRequest request,
+            HttpServletResponse response) {
        User user = UserHolder.findUser(request, response);
        return queryService.queryDimValue(queryDimValueReq, user);
    }

+    @PostMapping("/explain")
+    public <T> ExplainResp explain(@RequestBody ExplainSqlReq<T> explainSqlReq,
+            HttpServletRequest request,
+            HttpServletResponse response) throws Exception {
+
+        User user = UserHolder.findUser(request, response);
+        String queryReqJson = JsonUtil.toString(explainSqlReq.getQueryReq());
+        QueryTypeEnum queryTypeEnum = explainSqlReq.getQueryTypeEnum();
+
+        if (QueryTypeEnum.SQL.equals(queryTypeEnum)) {
+            QueryDslReq queryDslReq = JsonUtil.toObject(queryReqJson, QueryDslReq.class);
+            ExplainSqlReq<QueryDslReq> explainSqlReqNew = ExplainSqlReq.<QueryDslReq>builder()
+                    .queryReq(queryDslReq)
+                    .queryTypeEnum(queryTypeEnum).build();
+            return queryService.explain(explainSqlReqNew, user);
+        }
+        if (QueryTypeEnum.STRUCT.equals(queryTypeEnum)) {
+            QueryStructReq queryStructReq = JsonUtil.toObject(queryReqJson, QueryStructReq.class);
+            ExplainSqlReq<QueryStructReq> explainSqlReqNew = ExplainSqlReq.<QueryStructReq>builder()
+                    .queryReq(queryStructReq)
+                    .queryTypeEnum(queryTypeEnum).build();
+            return queryService.explain(explainSqlReqNew, user);
+        }
+        return null;
+    }
+
 }
--- a/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/service/QueryService.java
+++ b/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/service/QueryService.java
@@ -1,11 +1,13 @@
 package com.tencent.supersonic.semantic.query.service;

 import com.tencent.supersonic.auth.api.authentication.pojo.User;
+import com.tencent.supersonic.semantic.api.model.response.ExplainResp;
 import com.tencent.supersonic.semantic.api.model.response.QueryResultWithSchemaResp;
+import com.tencent.supersonic.semantic.api.query.request.ExplainSqlReq;
 import com.tencent.supersonic.semantic.api.query.request.ItemUseReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDimValueReq;
-import com.tencent.supersonic.semantic.api.query.request.QueryMultiStructReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDslReq;
+import com.tencent.supersonic.semantic.api.query.request.QueryMultiStructReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryStructReq;
 import com.tencent.supersonic.semantic.api.query.response.ItemUseResp;
 import java.util.List;
@@ -25,4 +27,5 @@ public interface QueryService {

    List<ItemUseResp> getStatInfo(ItemUseReq itemUseCommend);

+    <T> ExplainResp explain(ExplainSqlReq<T> explainSqlReq, User user) throws Exception;
 }
--- a/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/service/QueryServiceImpl.java
+++ b/semantic/query/src/main/java/com/tencent/supersonic/semantic/query/service/QueryServiceImpl.java
@@ -6,12 +6,15 @@ import com.tencent.supersonic.common.pojo.DateConf;
 import com.tencent.supersonic.common.pojo.enums.TaskStatusEnum;
 import com.tencent.supersonic.common.util.cache.CacheUtils;
 import com.tencent.supersonic.common.util.ContextUtils;
+import com.tencent.supersonic.semantic.api.model.enums.QueryTypeEnum;
 import com.tencent.supersonic.semantic.api.model.request.ModelSchemaFilterReq;
+import com.tencent.supersonic.semantic.api.model.response.ExplainResp;
 import com.tencent.supersonic.semantic.api.model.response.ModelSchemaResp;
 import com.tencent.supersonic.semantic.api.model.response.QueryResultWithSchemaResp;
 import com.tencent.supersonic.semantic.api.query.enums.FilterOperatorEnum;
 import com.tencent.supersonic.semantic.api.query.pojo.Cache;
 import com.tencent.supersonic.semantic.api.query.pojo.Filter;
+import com.tencent.supersonic.semantic.api.query.request.ExplainSqlReq;
 import com.tencent.supersonic.semantic.api.query.request.ItemUseReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDimValueReq;
 import com.tencent.supersonic.semantic.api.query.request.QueryDslReq;
@@ -64,6 +67,11 @@ public class QueryServiceImpl implements QueryService {

    @Override
    public Object queryBySql(QueryDslReq querySqlCmd, User user) throws Exception {
+        QueryStatement queryStatement = convertToQueryStatement(querySqlCmd, user);
+        return semanticQueryEngine.execute(queryStatement);
+    }
+
+    private QueryStatement convertToQueryStatement(QueryDslReq querySqlCmd, User user) throws Exception {
        ModelSchemaFilterReq filter = new ModelSchemaFilterReq();
        List<Long> modelIds = new ArrayList<>();
        modelIds.add(querySqlCmd.getModelId());
@@ -74,7 +82,7 @@ public class QueryServiceImpl implements QueryService {

        QueryStatement queryStatement = queryReqConverter.convert(querySqlCmd, domainSchemas);
        queryStatement.setModelId(querySqlCmd.getModelId());
-        return semanticQueryEngine.execute(queryStatement);
+        return queryStatement;
    }

    @Override
@@ -183,6 +191,32 @@ public class QueryServiceImpl implements QueryService {
        return statInfos;
    }

+    @Override
+    public <T> ExplainResp explain(ExplainSqlReq<T> explainSqlReq, User user) throws Exception {
+        QueryTypeEnum queryTypeEnum = explainSqlReq.getQueryTypeEnum();
+        T queryReq = explainSqlReq.getQueryReq();
+
+        if (QueryTypeEnum.SQL.equals(queryTypeEnum) && queryReq instanceof QueryDslReq) {
+            QueryStatement queryStatement = convertToQueryStatement((QueryDslReq) queryReq, user);
+            return getExplainResp(queryStatement);
+        }
+        if (QueryTypeEnum.STRUCT.equals(queryTypeEnum) && queryReq instanceof QueryStructReq) {
+            QueryStatement queryStatement = semanticQueryEngine.plan((QueryStructReq) queryReq);
+            return getExplainResp(queryStatement);
+        }
+
+        throw new IllegalArgumentException("Parameters are invalid, explainSqlReq: " + explainSqlReq);
+    }
+
+    private ExplainResp getExplainResp(QueryStatement queryStatement) {
+        String sql = "";
+        if (Objects.nonNull(queryStatement)) {
+            sql = queryStatement.getSql();
+        }
+        return ExplainResp.builder().sql(sql).build();
+    }
+
+
    private boolean isCache(QueryStructReq queryStructCmd) {
        if (!cacheEnable) {
            return false;