WIP: Issue ee 1059

sqle/driver/v2/driver_grpc_server.go

@@ -36,9 +36,10 @@ type Rule struct {
 
 	// Category is the category of the rule. Such as "Naming Conventions"...
 	// Rules will be displayed on the SQLE rule list page by category.
-	Category string
-	Level    RuleLevel
-	Params   params.Params
+	Category  string
+	Level     RuleLevel
+	Params    params.Params
+	Knowledge RuleKnowledge
 }
 
 type Config struct {

sqle/driver/v2/driver_interface.go

@@ -297,3 +297,7 @@ func NewKillProcessInfo(errorMessage string) *KillProcessInfo {
 		ErrMessage: errorMessage,
 	}
 }
+
+type RuleKnowledge struct {
+	Content string
+}

sqle/driver/v2/proto/driver_v2.proto

@@ -72,6 +72,11 @@ message Rule {
   string category = 4;
   repeated Param params = 5;
   string annotation = 6;
+  Knowledge knowledge = 7;
+}
+
+message Knowledge {
+  string content = 1;
 }
 
 // Metas

sqle/driver/v2/util.go

@@ -97,6 +97,7 @@ func ConvertRuleFromProtoToDriver(rule *protoV2.Rule) *Rule {
 		Annotation: rule.Annotation,
 		Level:      RuleLevel(rule.Level),
 		Params:     ps,
+		Knowledge:  RuleKnowledge{Content: rule.Knowledge.GetContent()},
 	}
 }
 

sqle/model/rule.go

@@ -316,9 +316,9 @@ func (s *Storage) GetRule(name, dbType string) (*Rule, bool, error) {
 	return &rule, true, errors.New(errors.ConnectStorageError, err)
 }
 
-func (s *Storage) GetAllRule() ([]*Rule, error) {
+func (s *Storage) GetAllRules() ([]*Rule, error) {
 	rules := []*Rule{}
-	err := s.db.Find(&rules).Error
+	err := s.db.Preload("RuleKnowledge").Find(&rules).Error
 	return rules, errors.New(errors.ConnectStorageError, err)
 }
 

sqle/model/utils.go

@@ -197,12 +197,24 @@ func (s *Storage) AutoMigrate() error {
 }
 
 func (s *Storage) CreateRulesIfNotExist(rules map[string][]*driverV2.Rule) error {
+	isRuleExistInDB := func(rulesInDB []*Rule, targetRuleName, dbType string) (*Rule, bool) {
+		for i := range rulesInDB {
+			rule := rulesInDB[i]
+			if rule.DBType != dbType || rule.Name != targetRuleName {
+				continue
+			}
+			return rule, true
+		}
+		return nil, false
+	}
+
+	rulesInDB, err := s.GetAllRules()
+	if err != nil {
+		return err
+	}
 	for dbType, rules := range rules {
 		for _, rule := range rules {
-			existedRule, exist, err := s.GetRule(rule.Name, dbType)
-			if err != nil {
-				return err
-			}
+			existedRule, exist := isRuleExistInDB(rulesInDB, rule.Name, dbType)
 			// rule will be created or update if:
 			// 1. rule not exist;
 			if !exist {
@@ -226,6 +238,10 @@ func (s *Storage) CreateRulesIfNotExist(rules map[string][]*driverV2.Rule) error
 				isParamSame := reflect.DeepEqual(existRuleParam, pluginRuleParam)
 
 				if !isRuleDescSame || !isRuleAnnotationSame || !isRuleLevelSame || !isRuleTypSame || !isParamSame {
+					if existedRule.Knowledge.Content != "" {
+						// 知识库是可以在页面上编辑的，而插件里只是默认内容，以页面上编辑后的内容为准
+						rule.Knowledge.Content = existedRule.Knowledge.Content
+					}
 					err := s.Save(GenerateRuleByDriverRule(rule, dbType))
 					if err != nil {
 						return err