Merge pull request #240 from actiontech/main

sync main into main-ee
actiontech · Jun 14, 2022 · db66f58 · db66f58
2 parents 22563b6 + a671a80
commit db66f58
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 7 deletions.
diff --git a/sqle/api/app.go b/sqle/api/app.go
@@ -171,6 +171,8 @@ func StartApi(net *gracenet.Net, exitChan chan struct{}, config config.SqleConfi
 	v1Router.GET("/instances/:instance_name/rules", v1.GetInstanceRules)
 	v1Router.GET("/instances/:instance_name/workflow_template", v1.GetInstanceWorkflowTemplate)
 	v1Router.GET("/instances/:instance_name/schemas/:schema_name/tables", v1.ListTableBySchema)
+	v1Router.GET("/instances/:instance_name/schemas/:schema_name/tables/:table_name/metadata", v1.GetTableMetadata)
+
 	// rule template
 	v1Router.GET("/rule_templates", v1.GetRuleTemplates)
 	v1Router.GET("/rule_template_tips", v1.GetRuleTemplateTips)
@@ -233,6 +235,7 @@ func StartApi(net *gracenet.Net, exitChan chan struct{}, config config.SqleConfi
 	v1Router.POST("/sql_query/prepare/:instance_name/", v1.PrepareSQLQuery)
 	v1Router.GET("/sql_query/history/:instance_name/", v1.GetSQLQueryHistory)
 	v1Router.GET("/sql_query/results/:query_id/", v1.GetSQLResult)
+	v1Router.GET("/sql_query/explain/:instance_name/", v1.GetSQLExplain)
 
 	// UI
 	e.File("/", "ui/index.html")

diff --git a/sqle/api/controller/v1/instance.go b/sqle/api/controller/v1/instance.go
@@ -1081,6 +1081,7 @@ type TableIndexes struct {
 
 type TableMeta struct {
 	Name           string       `json:"name"`
+	Schema         string       `json:"schema"`
 	Columns        TableColumns `json:"columns"`
 	Indexes        TableIndexes `json:"indexes"`
 	CreateTableSQL string       `json:"create_table_sql"`
@@ -1103,5 +1104,5 @@ type GetTableMetadataResV1 struct {
 // @Success 200 {object} v1.GetTableMetadataResV1
 // @router /v1/instances/{instance_name}/schemas/{schema_name}/tables/{table_name}/metadata [get]
 func GetTableMetadata(c echo.Context) error {
-	return nil
+	return getTableMetadata(c)
 }
diff --git a/sqle/api/controller/v1/instance_ce.go b/sqle/api/controller/v1/instance_ce.go
@@ -14,6 +14,7 @@ import (
 )
 
 var errCommunityEditionDoesNotSupportListTables = errors.New(errors.EnterpriseEditionFeatures, e.New("community edition does not support list tables"))
+var errCommunityEditionDoesNotSupportGetTablesMetadata = errors.New(errors.EnterpriseEditionFeatures, e.New("community edition does not support get table metadata"))
 
 func getInstanceTips(c echo.Context) error {
 	req := new(InstanceTipReqV1)
@@ -54,3 +55,7 @@ func getInstanceTips(c echo.Context) error {
 func listTableBySchema(c echo.Context) error {
 	return controller.JSONBaseErrorReq(c, errCommunityEditionDoesNotSupportListTables)
 }
+
+func getTableMetadata(c echo.Context) error {
+	return controller.JSONBaseErrorReq(c, errCommunityEditionDoesNotSupportGetTablesMetadata)
+}
diff --git a/sqle/api/controller/v1/sql_query.go b/sqle/api/controller/v1/sql_query.go
@@ -131,5 +131,5 @@ type GetSQLExplainResV1 struct {
 // @Success 200 {object} v1.GetSQLExplainResV1
 // @router /v1/sql_query/explain/{instance_name}/ [get]
 func GetSQLExplain(c echo.Context) error {
-	return nil
+	return getSQLExplain(c)
 }
diff --git a/sqle/api/controller/v1/sql_query_ce.go b/sqle/api/controller/v1/sql_query_ce.go
@@ -24,3 +24,7 @@ func getSQLResult(c echo.Context) error {
 func getSQLQueryHistory(c echo.Context) error {
 	return controller.JSONBaseErrorReq(c, errCommunityEditionDoesNotSupportSqlQuery)
 }
+
+func getSQLExplain(c echo.Context) error {
+	return controller.JSONBaseErrorReq(c, errCommunityEditionDoesNotSupportSqlQuery)
+}
diff --git a/sqle/api/controller/v2/audit_plan.go b/sqle/api/controller/v2/audit_plan.go
@@ -152,6 +152,7 @@ func GetAuditPlanReportSQLs(c echo.Context) error {
 		auditPlanReportSQLsResV2[i] = AuditPlanReportSQLResV2{
 			SQL:         auditPlanReportSQL.SQL,
 			AuditResult: auditPlanReportSQL.AuditResult,
+			Number:      auditPlanReportSQL.Number,
 		}
 	}
 	return c.JSON(http.StatusOK, &GetAuditPlanReportSQLsResV2{

diff --git a/sqle/docs/docs.go b/sqle/docs/docs.go
@@ -7185,6 +7185,9 @@ var doc = `{
                 },
                 "name": {
                     "type": "string"
+                },
+                "schema": {
+                    "type": "string"
                 }
             }
         },

diff --git a/sqle/docs/swagger.json b/sqle/docs/swagger.json
@@ -7169,6 +7169,9 @@
                 },
                 "name": {
                     "type": "string"
+                },
+                "schema": {
+                    "type": "string"
                 }
             }
         },

diff --git a/sqle/docs/swagger.yaml b/sqle/docs/swagger.yaml
@@ -1799,6 +1799,8 @@ definitions:
         type: object
       name:
         type: string
+      schema:
+        type: string
     type: object
   v1.TableMetaItemHeadResV1:
     properties:

diff --git a/sqle/driver/driver_analysis.go b/sqle/driver/driver_analysis.go
@@ -66,6 +66,8 @@ type IndexesInfo struct {
 }
 
 type TableMetaItem struct {
+	Name           string
+	Schema         string
 	ColumnsInfo    ColumnsInfo
 	IndexesInfo    IndexesInfo
 	CreateTableSQL string

diff --git a/sqle/model/audit_plan_list_test.go b/sqle/model/audit_plan_list_test.go
@@ -149,10 +149,10 @@ func TestStorage_GetAuditPlanReportSQLsByReq(t *testing.T) {
 	assert.NoError(t, err)
 	defer mockDB.Close()
 	InitMockStorage(mockDB)
-	mock.ExpectPrepare(fmt.Sprintf(`SELECT report_sqls.sql, report_sqls.audit_result %v LIMIT ? OFFSET ?`, tableAndRowOfSQL)).
+	mock.ExpectPrepare(fmt.Sprintf(`SELECT report_sqls.sql, report_sqls.audit_result, report_sqls.number %v LIMIT ? OFFSET ?`, tableAndRowOfSQL)).
 		ExpectQuery().WithArgs(1, 100, 10).WillReturnRows(sqlmock.NewRows([]string{
-		"sql", "audit_result",
-	}).AddRow("select * from t1 where id = 1", "FAKE AUDIT RESULT"))
+		"sql", "audit_result", "number",
+	}).AddRow("select * from t1 where id = 1", "FAKE AUDIT RESULT", "1"))
 
 	mock.ExpectPrepare(fmt.Sprintf(`SELECT COUNT(*) %v`, tableAndRowOfSQL)).
 		ExpectQuery().WithArgs(1).WillReturnRows(sqlmock.NewRows([]string{"COUNT(*)"}).AddRow("2"))

diff --git a/sqle/model/audit_plan_report.go b/sqle/model/audit_plan_report.go
@@ -19,6 +19,7 @@ type AuditPlanReportSQLV2 struct {
 	Model
 	AuditPlanReportID uint   `json:"audit_plan_report_id" gorm:"index"`
 	SQL               string `json:"sql" gorm:"type:text;not null"`
+	Number            uint   `json:"number"`
 	AuditResult       string `json:"audit_result" gorm:"type:text"`
 
 	AuditPlanReport *AuditPlanReportV2 `gorm:"foreignkey:AuditPlanReportID"`

diff --git a/sqle/model/audit_plan_report_list.go b/sqle/model/audit_plan_report_list.go
@@ -58,10 +58,11 @@ func (s *Storage) GetAuditPlanReportsByReq(data map[string]interface{}) (
 type AuditPlanReportSQLListDetail struct {
 	SQL         string `json:"sql"`
 	AuditResult string `json:"audit_result"`
+	Number      uint   `json:"number"`
 }
 
 var auditPlanReportSQLQueryTpl = `
-SELECT report_sqls.sql, report_sqls.audit_result
+SELECT report_sqls.sql, report_sqls.audit_result, report_sqls.number
 
 {{- template "body" . -}} 
 

diff --git a/sqle/server/auditplan/task.go b/sqle/server/auditplan/task.go
@@ -109,9 +109,10 @@ func (at *baseTask) audit(task *model.Task) (*model.AuditPlanReportV2, error) {
 		Score:       task.Score,
 		AuditLevel:  task.AuditLevel,
 	}
-	for _, executeSQL := range task.ExecuteSQLs {
+	for i, executeSQL := range task.ExecuteSQLs {
 		auditPlanReport.AuditPlanReportSQLs = append(auditPlanReport.AuditPlanReportSQLs, &model.AuditPlanReportSQLV2{
 			SQL:         executeSQL.Content,
+			Number:      uint(i + 1),
 			AuditResult: executeSQL.AuditResult,
 		})
 	}