Merge pull request #2883 from actiontech/feat_opt_sql_analysis_chart

fix: api: sql_analysis add cost property
actiontech · Jan 23, 2025 · 6de3a7a · 6de3a7a
2 parents c596082 + 0563ea8
commit 6de3a7a
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 5 deletions.
diff --git a/sqle/api/controller/v1/analysis.go b/sqle/api/controller/v1/analysis.go
@@ -2,6 +2,8 @@ package v1
 
 import (
 	"context"
+	"github.com/pkg/errors"
+	"strconv"
 
 	"github.com/actiontech/sqle/sqle/common"
 	"github.com/actiontech/sqle/sqle/driver"
@@ -11,6 +13,7 @@ import (
 )
 
 type AnalysisResult struct {
+	Cost             *float64
 	ExplainResult    *driverV2.ExplainResult
 	ExplainResultErr error
 
@@ -35,13 +38,38 @@ func GetSQLAnalysisResult(l *logrus.Entry, instance *model.Instance, schema, sql
 	defer plugin.Close(context.TODO())
 
 	res = &AnalysisResult{}
+
+	res.Cost, err = GetQueryCost(plugin, sql)
 	res.ExplainResult, res.ExplainResultErr = Explain(instance.DbType, plugin, sql)
 	res.TableMetaResult, res.TableMetaResultErr = GetTableMetas(instance.DbType, plugin, sql)
 	res.AffectRowsResult, res.AffectRowsResultErr = GetRowsAffected(instance.DbType, plugin, sql)
 
 	return res, nil
 }
 
+func GetQueryCost(plugin driver.Plugin, sql string) (cost *float64, err error) {
+	explainJSONResult, err := plugin.ExplainJSONFormat(context.TODO(), &driverV2.ExplainConf{Sql: sql})
+	if err != nil {
+		return nil, err
+	}
+	sqlNodes, err := plugin.Parse(context.TODO(), sql)
+	if err != nil {
+		return nil, err
+	}
+	if len(sqlNodes) == 0 {
+		return nil, errors.Errorf("failed to get query cost invalid sql: %v", sql)
+	}
+	// 不是SELECT语句直接忽略
+	if sqlNodes[0].Type != driverV2.SQLTypeDQL {
+		return nil, errors.Errorf("failed to get query cost because it is not DQL: %v", sql)
+	}
+	costFloat, err := strconv.ParseFloat(explainJSONResult.QueryBlock.CostInfo.QueryCost, 64)
+	if err != nil {
+		return nil, err
+	}
+	return &costFloat, nil
+}
+
 func Explain(dbType string, plugin driver.Plugin, sql string) (res *driverV2.ExplainResult, err error) {
 	if !driver.GetPluginManager().
 		IsOptionalModuleEnabled(dbType, driverV2.OptionalModuleExplain) {

diff --git a/sqle/api/controller/v1/sql_manage.go b/sqle/api/controller/v1/sql_manage.go
@@ -305,9 +305,10 @@ func GetSqlManageSqlAnalysisV1(c echo.Context) error {
 }
 
 type SqlManageAnalysisChartReq struct {
-	StartTime  *string `query:"start_time" json:"start_time"`
-	EndTime    *string `query:"end_time" json:"end_time"`
-	MetricName *string `query:"metric_name" json:"metric_name"`
+	LatestPointEnabled bool    `query:"latest_point_enabled" json:"latest_point_enabled"`
+	StartTime          *string `query:"start_time" json:"start_time"`
+	EndTime            *string `query:"end_time" json:"end_time"`
+	MetricName         *string `query:"metric_name" json:"metric_name"`
 }
 
 type SqlManageAnalysisChartResp struct {
@@ -322,6 +323,7 @@ type SqlManageAnalysisChartResp struct {
 // @Tags SqlManage
 // @Param project_name path string true "project name"
 // @Param sql_manage_id path string true "sql manage id"
+// @Param latest_point_enabled query bool true "latest_point_enabled"
 // @Param start_time query string true "start time"
 // @Param end_time query string true "end time"
 // @Param metric_name query string true "metric_name"
@@ -352,6 +354,7 @@ func convertSQLAnalysisResultToRes(ctx context.Context, res *AnalysisResult, raw
 	// explain
 	{
 		data.SQLExplain = &SQLExplain{SQL: rawSQL}
+		data.SQLExplain.Cost = *res.Cost
 		if res.ExplainResultErr != nil {
 			data.SQLExplain.Message = res.ExplainResultErr.Error()
 		} else {

diff --git a/sqle/api/controller/v1/task.go b/sqle/api/controller/v1/task.go
@@ -794,8 +794,9 @@ func CheckCurrentUserCanOpTask(c echo.Context, task *model.Task) (err error) {
 }
 
 type SQLExplain struct {
-	SQL     string `json:"sql"`
-	Message string `json:"message"`
+	SQL     string  `json:"sql"`
+	Cost    float64 `json:"cost"`
+	Message string  `json:"message"`
 	// explain result in table format
 	ClassicResult ExplainClassicResult `json:"classic_result"`
 }

diff --git a/sqle/docs/docs.go b/sqle/docs/docs.go
@@ -5553,6 +5553,13 @@ var doc = `{
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "boolean",
+                        "description": "latest_point_enabled",
+                        "name": "latest_point_enabled",
+                        "in": "query",
+                        "required": true
+                    },
                     {
                         "type": "string",
                         "description": "start time",
@@ -17319,6 +17326,9 @@ var doc = `{
                     "type": "object",
                     "$ref": "#/definitions/v1.ExplainClassicResult"
                 },
+                "cost": {
+                    "type": "number"
+                },
                 "message": {
                     "type": "string"
                 },

diff --git a/sqle/docs/swagger.json b/sqle/docs/swagger.json
@@ -5537,6 +5537,13 @@
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "boolean",
+                        "description": "latest_point_enabled",
+                        "name": "latest_point_enabled",
+                        "in": "query",
+                        "required": true
+                    },
                     {
                         "type": "string",
                         "description": "start time",
@@ -17303,6 +17310,9 @@
                     "type": "object",
                     "$ref": "#/definitions/v1.ExplainClassicResult"
                 },
+                "cost": {
+                    "type": "number"
+                },
                 "message": {
                     "type": "string"
                 },

diff --git a/sqle/docs/swagger.yaml b/sqle/docs/swagger.yaml
@@ -4016,6 +4016,8 @@ definitions:
         $ref: '#/definitions/v1.ExplainClassicResult'
         description: explain result in table format
         type: object
+      cost:
+        type: number
       message:
         type: string
       sql:
@@ -9763,6 +9765,11 @@ paths:
         name: sql_manage_id
         required: true
         type: string
+      - description: latest_point_enabled
+        in: query
+        name: latest_point_enabled
+        required: true
+        type: boolean
       - description: start time
         in: query
         name: start_time