Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: migrate SQL review rule payloads from JSON strings to typed proto messages (#18376)

Danny Xua9187c36d275
diff --git a/.gitignore b/.gitignore
index 23c4cc3ae8..e851c25954 100644
--- a/.gitignore
+++ b/.gitignore
@@ -38,3 +38,4 @@ bytebase-build
scripts/azure-marketplace/.cnab/
scripts/azure-marketplace/*.tgz
scripts/azure-marketplace/*.backup
+/main
diff --git a/backend/api/v1/org_policy_service_converter.go b/backend/api/v1/org_policy_service_converter.go
index 1bda1bd304..192ff3a93b 100644
--- a/backend/api/v1/org_policy_service_converter.go
+++ b/backend/api/v1/org_policy_service_converter.go
@@ -11,7 +11,8 @@ import (
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
)
-func convertToV1PBSQLReviewRules(ruleList []*storepb.SQLReviewRule) []*v1pb.SQLReviewRule {
+// ConvertToV1PBSQLReviewRules converts store SQL review rules to v1 API format.
+func ConvertToV1PBSQLReviewRules(ruleList []*storepb.SQLReviewRule) []*v1pb.SQLReviewRule {
var rules []*v1pb.SQLReviewRule
for _, rule := range ruleList {
level := v1pb.SQLReviewRule_LEVEL_UNSPECIFIED
@@ -22,18 +23,69 @@ func convertToV1PBSQLReviewRules(ruleList []*storepb.SQLReviewRule) []*v1pb.SQLR
level = v1pb.SQLReviewRule_WARNING
default:
}
- rules = append(rules, &v1pb.SQLReviewRule{
- Level: level,
- Type: v1pb.SQLReviewRule_Type(rule.Type),
- Payload: rule.Payload,
- Engine: convertToEngine(rule.Engine),
- })
+
+ v1Rule := &v1pb.SQLReviewRule{
+ Level: level,
+ Type: v1pb.SQLReviewRule_Type(rule.Type),
+ Engine: convertToEngine(rule.Engine),
+ }
+
+ // Convert typed payload from store to v1 API
+ switch payload := rule.Payload.(type) {
+ case *storepb.SQLReviewRule_NamingPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_NamingPayload{
+ NamingPayload: &v1pb.SQLReviewRule_NamingRulePayload{
+ MaxLength: payload.NamingPayload.MaxLength,
+ Format: payload.NamingPayload.Format,
+ },
+ }
+ case *storepb.SQLReviewRule_NumberPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_NumberPayload{
+ NumberPayload: &v1pb.SQLReviewRule_NumberRulePayload{
+ Number: payload.NumberPayload.Number,
+ },
+ }
+ case *storepb.SQLReviewRule_StringArrayPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &v1pb.SQLReviewRule_StringArrayRulePayload{
+ List: payload.StringArrayPayload.List,
+ },
+ }
+ case *storepb.SQLReviewRule_CommentConventionPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &v1pb.SQLReviewRule_CommentConventionRulePayload{
+ Required: payload.CommentConventionPayload.Required,
+ MaxLength: payload.CommentConventionPayload.MaxLength,
+ },
+ }
+ case *storepb.SQLReviewRule_NamingCasePayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_NamingCasePayload{
+ NamingCasePayload: &v1pb.SQLReviewRule_NamingCaseRulePayload{
+ Upper: payload.NamingCasePayload.Upper,
+ },
+ }
+ case *storepb.SQLReviewRule_StringPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_StringPayload{
+ StringPayload: &v1pb.SQLReviewRule_StringRulePayload{
+ Value: payload.StringPayload.Value,
+ },
+ }
+ case *storepb.SQLReviewRule_RequiredColumnPayload:
+ v1Rule.Payload = &v1pb.SQLReviewRule_RequiredColumnPayload{
+ RequiredColumnPayload: &v1pb.SQLReviewRule_RequiredColumnRulePayload{
+ ColumnList: payload.RequiredColumnPayload.ColumnList,
+ },
+ }
+ }
+
+ rules = append(rules, v1Rule)
}
return rules
}
-func convertToSQLReviewRules(rules []*v1pb.SQLReviewRule) ([]*storepb.SQLReviewRule, error) {
+// ConvertToSQLReviewRules converts v1 API SQL review rules to store format.
+func ConvertToSQLReviewRules(rules []*v1pb.SQLReviewRule) ([]*storepb.SQLReviewRule, error) {
var ruleList []*storepb.SQLReviewRule
for _, rule := range rules {
var level storepb.SQLReviewRule_Level
@@ -45,12 +97,62 @@ func convertToSQLReviewRules(rules []*v1pb.SQLReviewRule) ([]*storepb.SQLReviewR
default:
return nil, errors.Errorf("invalid rule level %v", rule.Level)
}
- ruleList = append(ruleList, &storepb.SQLReviewRule{
- Level: level,
- Payload: rule.Payload,
- Type: storepb.SQLReviewRule_Type(rule.Type),
- Engine: convertEngine(rule.Engine),
- })
+
+ storeRule := &storepb.SQLReviewRule{
+ Type: storepb.SQLReviewRule_Type(rule.Type),
+ Level: level,
+ Engine: convertEngine(rule.Engine),
+ }
+
+ // Convert typed payload from v1 API to store
+ switch payload := rule.Payload.(type) {
+ case *v1pb.SQLReviewRule_NamingPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ MaxLength: payload.NamingPayload.MaxLength,
+ Format: payload.NamingPayload.Format,
+ },
+ }
+ case *v1pb.SQLReviewRule_NumberPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: payload.NumberPayload.Number,
+ },
+ }
+ case *v1pb.SQLReviewRule_StringArrayPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: payload.StringArrayPayload.List,
+ },
+ }
+ case *v1pb.SQLReviewRule_CommentConventionPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{
+ Required: payload.CommentConventionPayload.Required,
+ MaxLength: payload.CommentConventionPayload.MaxLength,
+ },
+ }
+ case *v1pb.SQLReviewRule_NamingCasePayload:
+ storeRule.Payload = &storepb.SQLReviewRule_NamingCasePayload{
+ NamingCasePayload: &storepb.SQLReviewRule_NamingCaseRulePayload{
+ Upper: payload.NamingCasePayload.Upper,
+ },
+ }
+ case *v1pb.SQLReviewRule_StringPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_StringPayload{
+ StringPayload: &storepb.SQLReviewRule_StringRulePayload{
+ Value: payload.StringPayload.Value,
+ },
+ }
+ case *v1pb.SQLReviewRule_RequiredColumnPayload:
+ storeRule.Payload = &storepb.SQLReviewRule_RequiredColumnPayload{
+ RequiredColumnPayload: &storepb.SQLReviewRule_RequiredColumnRulePayload{
+ ColumnList: payload.RequiredColumnPayload.ColumnList,
+ },
+ }
+ }
+
+ ruleList = append(ruleList, storeRule)
}
return ruleList, nil
diff --git a/backend/api/v1/review_config_service.go b/backend/api/v1/review_config_service.go
index dd9e33e1d3..fa4bb5c692 100644
--- a/backend/api/v1/review_config_service.go
+++ b/backend/api/v1/review_config_service.go
@@ -2,6 +2,7 @@ package v1
import (
"context"
+ "regexp"
"connectrpc.com/connect"
"github.com/pkg/errors"
@@ -124,7 +125,7 @@ func (s *ReviewConfigService) UpdateReviewConfig(ctx context.Context, req *conne
if err := validateSQLReviewRules(req.Msg.ReviewConfig.Rules); err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- ruleList, err := convertToSQLReviewRules(req.Msg.ReviewConfig.Rules)
+ ruleList, err := ConvertToSQLReviewRules(req.Msg.ReviewConfig.Rules)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to convert rules"))
}
@@ -199,7 +200,7 @@ func (s *ReviewConfigService) DeleteReviewConfig(ctx context.Context, req *conne
}
func convertToReviewConfigMessage(reviewConfig *v1pb.ReviewConfig) (*store.ReviewConfigMessage, error) {
- ruleList, err := convertToSQLReviewRules(reviewConfig.Rules)
+ ruleList, err := ConvertToSQLReviewRules(reviewConfig.Rules)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to convert rules"))
}
@@ -237,7 +238,7 @@ func (s *ReviewConfigService) convertToV1ReviewConfig(ctx context.Context, revie
Name: common.FormatReviewConfig(reviewConfigMessage.ID),
Title: reviewConfigMessage.Name,
Enabled: reviewConfigMessage.Enforce,
- Rules: convertToV1PBSQLReviewRules(reviewConfigMessage.Payload.SqlReviewRules),
+ Rules: ConvertToV1PBSQLReviewRules(reviewConfigMessage.Payload.SqlReviewRules),
}
for _, policy := range tagPolicies {
@@ -302,34 +303,35 @@ func validateSQLReviewRules(rules []*v1pb.SQLReviewRule) error {
// TODO(rebelice): add other SQL review rule validation.
switch ruleType {
case storepb.SQLReviewRule_NAMING_TABLE, storepb.SQLReviewRule_NAMING_COLUMN, storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT:
- if _, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(rule.Payload); err != nil {
- return err
+ if payload := rule.GetNamingPayload(); payload != nil {
+ if _, err := regexp.Compile(payload.Format); err != nil {
+ return errors.Wrapf(err, "invalid naming rule format pattern %q", payload.Format)
+ }
}
case storepb.SQLReviewRule_NAMING_INDEX_FK, storepb.SQLReviewRule_NAMING_INDEX_IDX, storepb.SQLReviewRule_NAMING_INDEX_UK:
- if _, _, _, err := advisor.UnmarshalNamingRulePayloadAsTemplate(ruleType, rule.Payload); err != nil {
- return err
+ if payload := rule.GetNamingPayload(); payload != nil {
+ tokens, _ := advisor.ParseTemplateTokens(payload.Format)
+ for _, token := range tokens {
+ if _, ok := advisor.TemplateNamingTokens[ruleType][token]; !ok {
+ return errors.Errorf("invalid template token %s for rule %s", token, ruleType)
+ }
+ }
}
case storepb.SQLReviewRule_COLUMN_REQUIRED:
- if _, err := advisor.UnmarshalRequiredColumnList(rule.Payload); err != nil {
- return err
+ if payload := rule.GetStringArrayPayload(); payload != nil {
+ if len(payload.List) == 0 {
+ return errors.Errorf("column required rule must have at least one column")
+ }
}
case storepb.SQLReviewRule_COLUMN_COMMENT, storepb.SQLReviewRule_TABLE_COMMENT:
- if _, err := advisor.UnmarshalCommentConventionRulePayload(rule.Payload); err != nil {
- return err
- }
+ // Comment convention payload is valid by structure
case storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT,
storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT:
- if _, err := advisor.UnmarshalNumberTypeRulePayload(rule.Payload); err != nil {
- return err
- }
+ // Number payload is valid by structure
case storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST:
- if _, err := advisor.UnmarshalStringArrayTypeRulePayload(rule.Payload); err != nil {
- return err
- }
+ // String array payload is valid by structure
case storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE:
- if _, err := advisor.UnmarshalNamingCaseRulePayload(rule.Payload); err != nil {
- return err
- }
+ // Naming case payload is valid by structure
default:
}
}
diff --git a/backend/api/v1/review_config_service_test.go b/backend/api/v1/review_config_service_test.go
index 68238171fb..46852dce6f 100644
--- a/backend/api/v1/review_config_service_test.go
+++ b/backend/api/v1/review_config_service_test.go
@@ -25,10 +25,9 @@ func TestValidateSQLReviewRules(t *testing.T) {
name: "valid ERROR level",
rules: []*v1pb.SQLReviewRule{
{
- Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
- Level: v1pb.SQLReviewRule_ERROR,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
+ Level: v1pb.SQLReviewRule_ERROR,
+ Engine: v1pb.Engine_POSTGRES,
},
},
wantErr: false,
@@ -37,10 +36,9 @@ func TestValidateSQLReviewRules(t *testing.T) {
name: "valid WARNING level",
rules: []*v1pb.SQLReviewRule{
{
- Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
- Level: v1pb.SQLReviewRule_WARNING,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
+ Level: v1pb.SQLReviewRule_WARNING,
+ Engine: v1pb.Engine_POSTGRES,
},
},
wantErr: false,
@@ -49,10 +47,9 @@ func TestValidateSQLReviewRules(t *testing.T) {
name: "invalid LEVEL_UNSPECIFIED",
rules: []*v1pb.SQLReviewRule{
{
- Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
- Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
+ Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
+ Engine: v1pb.Engine_POSTGRES,
},
},
wantErr: true,
@@ -62,10 +59,9 @@ func TestValidateSQLReviewRules(t *testing.T) {
name: "invalid TYPE_UNSPECIFIED",
rules: []*v1pb.SQLReviewRule{
{
- Type: v1pb.SQLReviewRule_TYPE_UNSPECIFIED,
- Level: v1pb.SQLReviewRule_ERROR,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TYPE_UNSPECIFIED,
+ Level: v1pb.SQLReviewRule_ERROR,
+ Engine: v1pb.Engine_POSTGRES,
},
},
wantErr: true,
@@ -75,16 +71,14 @@ func TestValidateSQLReviewRules(t *testing.T) {
name: "multiple rules with one invalid",
rules: []*v1pb.SQLReviewRule{
{
- Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
- Level: v1pb.SQLReviewRule_ERROR,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TABLE_REQUIRE_PK,
+ Level: v1pb.SQLReviewRule_ERROR,
+ Engine: v1pb.Engine_POSTGRES,
},
{
- Type: v1pb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
- Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
- Engine: v1pb.Engine_POSTGRES,
- Payload: "",
+ Type: v1pb.SQLReviewRule_TABLE_NO_FOREIGN_KEY,
+ Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
+ Engine: v1pb.Engine_POSTGRES,
},
},
wantErr: true,
diff --git a/backend/generated-go/store/review_config.pb.go b/backend/generated-go/store/review_config.pb.go
index bf45910771..ff48784c3c 100644
--- a/backend/generated-go/store/review_config.pb.go
+++ b/backend/generated-go/store/review_config.pb.go
@@ -489,11 +489,20 @@ func (x *ReviewConfigPayload) GetSqlReviewRules() []*SQLReviewRule {
}
type SQLReviewRule struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- Type SQLReviewRule_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.store.SQLReviewRule_Type" json:"type,omitempty"`
- Level SQLReviewRule_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.store.SQLReviewRule_Level" json:"level,omitempty"`
- Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
- Engine Engine `protobuf:"varint,4,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Type SQLReviewRule_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.store.SQLReviewRule_Type" json:"type,omitempty"`
+ Level SQLReviewRule_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.store.SQLReviewRule_Level" json:"level,omitempty"`
+ // Types that are valid to be assigned to Payload:
+ //
+ // *SQLReviewRule_NamingPayload
+ // *SQLReviewRule_NumberPayload
+ // *SQLReviewRule_StringArrayPayload
+ // *SQLReviewRule_CommentConventionPayload
+ // *SQLReviewRule_RequiredColumnPayload
+ // *SQLReviewRule_StringPayload
+ // *SQLReviewRule_NamingCasePayload
+ Payload isSQLReviewRule_Payload `protobuf_oneof:"payload"`
+ Engine Engine `protobuf:"varint,10,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
@@ -542,11 +551,74 @@ func (x *SQLReviewRule) GetLevel() SQLReviewRule_Level {
return SQLReviewRule_LEVEL_UNSPECIFIED
}
-func (x *SQLReviewRule) GetPayload() string {
+func (x *SQLReviewRule) GetPayload() isSQLReviewRule_Payload {
if x != nil {
return x.Payload
}
- return ""
+ return nil
+}
+
+func (x *SQLReviewRule) GetNamingPayload() *SQLReviewRule_NamingRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NamingPayload); ok {
+ return x.NamingPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetNumberPayload() *SQLReviewRule_NumberRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NumberPayload); ok {
+ return x.NumberPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetStringArrayPayload() *SQLReviewRule_StringArrayRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_StringArrayPayload); ok {
+ return x.StringArrayPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetCommentConventionPayload() *SQLReviewRule_CommentConventionRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_CommentConventionPayload); ok {
+ return x.CommentConventionPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetRequiredColumnPayload() *SQLReviewRule_RequiredColumnRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_RequiredColumnPayload); ok {
+ return x.RequiredColumnPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetStringPayload() *SQLReviewRule_StringRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_StringPayload); ok {
+ return x.StringPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetNamingCasePayload() *SQLReviewRule_NamingCaseRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NamingCasePayload); ok {
+ return x.NamingCasePayload
+ }
+ }
+ return nil
}
func (x *SQLReviewRule) GetEngine() Engine {
@@ -556,18 +628,415 @@ func (x *SQLReviewRule) GetEngine() Engine {
return Engine_ENGINE_UNSPECIFIED
}
+type isSQLReviewRule_Payload interface {
+ isSQLReviewRule_Payload()
+}
+
+type SQLReviewRule_NamingPayload struct {
+ NamingPayload *SQLReviewRule_NamingRulePayload `protobuf:"bytes,3,opt,name=naming_payload,json=namingPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_NumberPayload struct {
+ NumberPayload *SQLReviewRule_NumberRulePayload `protobuf:"bytes,4,opt,name=number_payload,json=numberPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_StringArrayPayload struct {
+ StringArrayPayload *SQLReviewRule_StringArrayRulePayload `protobuf:"bytes,5,opt,name=string_array_payload,json=stringArrayPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_CommentConventionPayload struct {
+ CommentConventionPayload *SQLReviewRule_CommentConventionRulePayload `protobuf:"bytes,6,opt,name=comment_convention_payload,json=commentConventionPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_RequiredColumnPayload struct {
+ RequiredColumnPayload *SQLReviewRule_RequiredColumnRulePayload `protobuf:"bytes,7,opt,name=required_column_payload,json=requiredColumnPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_StringPayload struct {
+ StringPayload *SQLReviewRule_StringRulePayload `protobuf:"bytes,8,opt,name=string_payload,json=stringPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_NamingCasePayload struct {
+ NamingCasePayload *SQLReviewRule_NamingCaseRulePayload `protobuf:"bytes,9,opt,name=naming_case_payload,json=namingCasePayload,proto3,oneof"`
+}
+
+func (*SQLReviewRule_NamingPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_NumberPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_StringArrayPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_CommentConventionPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_RequiredColumnPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_StringPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_NamingCasePayload) isSQLReviewRule_Payload() {}
+
+// Payload message types for SQL review rules
+type SQLReviewRule_NamingRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ MaxLength int32 `protobuf:"varint,1,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
+ Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NamingRulePayload) Reset() {
+ *x = SQLReviewRule_NamingRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[2]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NamingRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NamingRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NamingRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[2]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NamingRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NamingRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 0}
+}
+
+func (x *SQLReviewRule_NamingRulePayload) GetMaxLength() int32 {
+ if x != nil {
+ return x.MaxLength
+ }
+ return 0
+}
+
+func (x *SQLReviewRule_NamingRulePayload) GetFormat() string {
+ if x != nil {
+ return x.Format
+ }
+ return ""
+}
+
+type SQLReviewRule_NumberRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Number int32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NumberRulePayload) Reset() {
+ *x = SQLReviewRule_NumberRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[3]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NumberRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NumberRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NumberRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[3]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NumberRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NumberRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 1}
+}
+
+func (x *SQLReviewRule_NumberRulePayload) GetNumber() int32 {
+ if x != nil {
+ return x.Number
+ }
+ return 0
+}
+
+type SQLReviewRule_StringArrayRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ List []string `protobuf:"bytes,1,rep,name=list,proto3" json:"list,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) Reset() {
+ *x = SQLReviewRule_StringArrayRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[4]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_StringArrayRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_StringArrayRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[4]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_StringArrayRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_StringArrayRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 2}
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) GetList() []string {
+ if x != nil {
+ return x.List
+ }
+ return nil
+}
+
+type SQLReviewRule_CommentConventionRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
+ MaxLength int32 `protobuf:"varint,2,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) Reset() {
+ *x = SQLReviewRule_CommentConventionRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[5]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_CommentConventionRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[5]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_CommentConventionRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_CommentConventionRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 3}
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) GetRequired() bool {
+ if x != nil {
+ return x.Required
+ }
+ return false
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) GetMaxLength() int32 {
+ if x != nil {
+ return x.MaxLength
+ }
+ return 0
+}
+
+type SQLReviewRule_RequiredColumnRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ ColumnList []string `protobuf:"bytes,1,rep,name=column_list,json=columnList,proto3" json:"column_list,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) Reset() {
+ *x = SQLReviewRule_RequiredColumnRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[6]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_RequiredColumnRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[6]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_RequiredColumnRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_RequiredColumnRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 4}
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) GetColumnList() []string {
+ if x != nil {
+ return x.ColumnList
+ }
+ return nil
+}
+
+type SQLReviewRule_StringRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_StringRulePayload) Reset() {
+ *x = SQLReviewRule_StringRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[7]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_StringRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_StringRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_StringRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[7]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_StringRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_StringRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 5}
+}
+
+func (x *SQLReviewRule_StringRulePayload) GetValue() string {
+ if x != nil {
+ return x.Value
+ }
+ return ""
+}
+
+type SQLReviewRule_NamingCaseRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Upper bool `protobuf:"varint,1,opt,name=upper,proto3" json:"upper,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) Reset() {
+ *x = SQLReviewRule_NamingCaseRulePayload{}
+ mi := &file_store_review_config_proto_msgTypes[8]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NamingCaseRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_review_config_proto_msgTypes[8]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NamingCaseRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NamingCaseRulePayload) Descriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 6}
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) GetUpper() bool {
+ if x != nil {
+ return x.Upper
+ }
+ return false
+}
+
var File_store_review_config_proto protoreflect.FileDescriptor
const file_store_review_config_proto_rawDesc = "" +
"\n" +
"\x19store/review_config.proto\x12\x0ebytebase.store\x1a\x12store/common.proto\"^\n" +
"\x13ReviewConfigPayload\x12G\n" +
- "\x10sql_review_rules\x18\x01 \x03(\v2\x1d.bytebase.store.SQLReviewRuleR\x0esqlReviewRules\"\xb7\x1e\n" +
+ "\x10sql_review_rules\x18\x01 \x03(\v2\x1d.bytebase.store.SQLReviewRuleR\x0esqlReviewRules\"\x90'\n" +
"\rSQLReviewRule\x126\n" +
"\x04type\x18\x01 \x01(\x0e2\".bytebase.store.SQLReviewRule.TypeR\x04type\x129\n" +
- "\x05level\x18\x02 \x01(\x0e2#.bytebase.store.SQLReviewRule.LevelR\x05level\x12\x18\n" +
- "\apayload\x18\x03 \x01(\tR\apayload\x12.\n" +
- "\x06engine\x18\x04 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\"6\n" +
+ "\x05level\x18\x02 \x01(\x0e2#.bytebase.store.SQLReviewRule.LevelR\x05level\x12X\n" +
+ "\x0enaming_payload\x18\x03 \x01(\v2/.bytebase.store.SQLReviewRule.NamingRulePayloadH\x00R\rnamingPayload\x12X\n" +
+ "\x0enumber_payload\x18\x04 \x01(\v2/.bytebase.store.SQLReviewRule.NumberRulePayloadH\x00R\rnumberPayload\x12h\n" +
+ "\x14string_array_payload\x18\x05 \x01(\v24.bytebase.store.SQLReviewRule.StringArrayRulePayloadH\x00R\x12stringArrayPayload\x12z\n" +
+ "\x1acomment_convention_payload\x18\x06 \x01(\v2:.bytebase.store.SQLReviewRule.CommentConventionRulePayloadH\x00R\x18commentConventionPayload\x12q\n" +
+ "\x17required_column_payload\x18\a \x01(\v27.bytebase.store.SQLReviewRule.RequiredColumnRulePayloadH\x00R\x15requiredColumnPayload\x12X\n" +
+ "\x0estring_payload\x18\b \x01(\v2/.bytebase.store.SQLReviewRule.StringRulePayloadH\x00R\rstringPayload\x12e\n" +
+ "\x13naming_case_payload\x18\t \x01(\v23.bytebase.store.SQLReviewRule.NamingCaseRulePayloadH\x00R\x11namingCasePayload\x12.\n" +
+ "\x06engine\x18\n" +
+ " \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\x1aJ\n" +
+ "\x11NamingRulePayload\x12\x1d\n" +
+ "\n" +
+ "max_length\x18\x01 \x01(\x05R\tmaxLength\x12\x16\n" +
+ "\x06format\x18\x02 \x01(\tR\x06format\x1a+\n" +
+ "\x11NumberRulePayload\x12\x16\n" +
+ "\x06number\x18\x01 \x01(\x05R\x06number\x1a,\n" +
+ "\x16StringArrayRulePayload\x12\x12\n" +
+ "\x04list\x18\x01 \x03(\tR\x04list\x1aY\n" +
+ "\x1cCommentConventionRulePayload\x12\x1a\n" +
+ "\brequired\x18\x01 \x01(\bR\brequired\x12\x1d\n" +
+ "\n" +
+ "max_length\x18\x02 \x01(\x05R\tmaxLength\x1a<\n" +
+ "\x19RequiredColumnRulePayload\x12\x1f\n" +
+ "\vcolumn_list\x18\x01 \x03(\tR\n" +
+ "columnList\x1a)\n" +
+ "\x11StringRulePayload\x12\x14\n" +
+ "\x05value\x18\x01 \x01(\tR\x05value\x1a-\n" +
+ "\x15NamingCaseRulePayload\x12\x14\n" +
+ "\x05upper\x18\x01 \x01(\bR\x05upper\"6\n" +
"\x05Level\x12\x15\n" +
"\x11LEVEL_UNSPECIFIED\x10\x00\x12\t\n" +
"\x05ERROR\x10\x01\x12\v\n" +
@@ -683,7 +1152,8 @@ const file_store_review_config_proto_rawDesc = "" +
"\x1fSYSTEM_FUNCTION_DISALLOW_CREATE\x10j\x12#\n" +
"\x1fSYSTEM_FUNCTION_DISALLOWED_LIST\x10k\x12\x1b\n" +
"\x17ADVICE_ONLINE_MIGRATION\x10l\x12\x1e\n" +
- "\x1aBUILTIN_PRIOR_BACKUP_CHECK\x10mB\x94\x01\n" +
+ "\x1aBUILTIN_PRIOR_BACKUP_CHECK\x10mB\t\n" +
+ "\apayloadB\x94\x01\n" +
"\x12com.bytebase.storeB\x11ReviewConfigProtoP\x01Z\x12generated-go/store\xa2\x02\x03BSX\xaa\x02\x0eBytebase.Store\xca\x02\x0eBytebase\\Store\xe2\x02\x1aBytebase\\Store\\GPBMetadata\xea\x02\x0fBytebase::Storeb\x06proto3"
var (
@@ -699,24 +1169,38 @@ func file_store_review_config_proto_rawDescGZIP() []byte {
}
var file_store_review_config_proto_enumTypes = make([]protoimpl.EnumInfo, 2)
-var file_store_review_config_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
+var file_store_review_config_proto_msgTypes = make([]protoimpl.MessageInfo, 9)
var file_store_review_config_proto_goTypes = []any{
- (SQLReviewRule_Level)(0), // 0: bytebase.store.SQLReviewRule.Level
- (SQLReviewRule_Type)(0), // 1: bytebase.store.SQLReviewRule.Type
- (*ReviewConfigPayload)(nil), // 2: bytebase.store.ReviewConfigPayload
- (*SQLReviewRule)(nil), // 3: bytebase.store.SQLReviewRule
- (Engine)(0), // 4: bytebase.store.Engine
+ (SQLReviewRule_Level)(0), // 0: bytebase.store.SQLReviewRule.Level
+ (SQLReviewRule_Type)(0), // 1: bytebase.store.SQLReviewRule.Type
+ (*ReviewConfigPayload)(nil), // 2: bytebase.store.ReviewConfigPayload
+ (*SQLReviewRule)(nil), // 3: bytebase.store.SQLReviewRule
+ (*SQLReviewRule_NamingRulePayload)(nil), // 4: bytebase.store.SQLReviewRule.NamingRulePayload
+ (*SQLReviewRule_NumberRulePayload)(nil), // 5: bytebase.store.SQLReviewRule.NumberRulePayload
+ (*SQLReviewRule_StringArrayRulePayload)(nil), // 6: bytebase.store.SQLReviewRule.StringArrayRulePayload
+ (*SQLReviewRule_CommentConventionRulePayload)(nil), // 7: bytebase.store.SQLReviewRule.CommentConventionRulePayload
+ (*SQLReviewRule_RequiredColumnRulePayload)(nil), // 8: bytebase.store.SQLReviewRule.RequiredColumnRulePayload
+ (*SQLReviewRule_StringRulePayload)(nil), // 9: bytebase.store.SQLReviewRule.StringRulePayload
+ (*SQLReviewRule_NamingCaseRulePayload)(nil), // 10: bytebase.store.SQLReviewRule.NamingCaseRulePayload
+ (Engine)(0), // 11: bytebase.store.Engine
}
var file_store_review_config_proto_depIdxs = []int32{
- 3, // 0: bytebase.store.ReviewConfigPayload.sql_review_rules:type_name -> bytebase.store.SQLReviewRule
- 1, // 1: bytebase.store.SQLReviewRule.type:type_name -> bytebase.store.SQLReviewRule.Type
- 0, // 2: bytebase.store.SQLReviewRule.level:type_name -> bytebase.store.SQLReviewRule.Level
- 4, // 3: bytebase.store.SQLReviewRule.engine:type_name -> bytebase.store.Engine
- 4, // [4:4] is the sub-list for method output_type
- 4, // [4:4] is the sub-list for method input_type
- 4, // [4:4] is the sub-list for extension type_name
- 4, // [4:4] is the sub-list for extension extendee
- 0, // [0:4] is the sub-list for field type_name
+ 3, // 0: bytebase.store.ReviewConfigPayload.sql_review_rules:type_name -> bytebase.store.SQLReviewRule
+ 1, // 1: bytebase.store.SQLReviewRule.type:type_name -> bytebase.store.SQLReviewRule.Type
+ 0, // 2: bytebase.store.SQLReviewRule.level:type_name -> bytebase.store.SQLReviewRule.Level
+ 4, // 3: bytebase.store.SQLReviewRule.naming_payload:type_name -> bytebase.store.SQLReviewRule.NamingRulePayload
+ 5, // 4: bytebase.store.SQLReviewRule.number_payload:type_name -> bytebase.store.SQLReviewRule.NumberRulePayload
+ 6, // 5: bytebase.store.SQLReviewRule.string_array_payload:type_name -> bytebase.store.SQLReviewRule.StringArrayRulePayload
+ 7, // 6: bytebase.store.SQLReviewRule.comment_convention_payload:type_name -> bytebase.store.SQLReviewRule.CommentConventionRulePayload
+ 8, // 7: bytebase.store.SQLReviewRule.required_column_payload:type_name -> bytebase.store.SQLReviewRule.RequiredColumnRulePayload
+ 9, // 8: bytebase.store.SQLReviewRule.string_payload:type_name -> bytebase.store.SQLReviewRule.StringRulePayload
+ 10, // 9: bytebase.store.SQLReviewRule.naming_case_payload:type_name -> bytebase.store.SQLReviewRule.NamingCaseRulePayload
+ 11, // 10: bytebase.store.SQLReviewRule.engine:type_name -> bytebase.store.Engine
+ 11, // [11:11] is the sub-list for method output_type
+ 11, // [11:11] is the sub-list for method input_type
+ 11, // [11:11] is the sub-list for extension type_name
+ 11, // [11:11] is the sub-list for extension extendee
+ 0, // [0:11] is the sub-list for field type_name
}
func init() { file_store_review_config_proto_init() }
@@ -725,13 +1209,22 @@ func file_store_review_config_proto_init() {
return
}
file_store_common_proto_init()
+ file_store_review_config_proto_msgTypes[1].OneofWrappers = []any{
+ (*SQLReviewRule_NamingPayload)(nil),
+ (*SQLReviewRule_NumberPayload)(nil),
+ (*SQLReviewRule_StringArrayPayload)(nil),
+ (*SQLReviewRule_CommentConventionPayload)(nil),
+ (*SQLReviewRule_RequiredColumnPayload)(nil),
+ (*SQLReviewRule_StringPayload)(nil),
+ (*SQLReviewRule_NamingCasePayload)(nil),
+ }
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_store_review_config_proto_rawDesc), len(file_store_review_config_proto_rawDesc)),
NumEnums: 2,
- NumMessages: 2,
+ NumMessages: 9,
NumExtensions: 0,
NumServices: 0,
},
diff --git a/backend/generated-go/store/review_config_equal.pb.go b/backend/generated-go/store/review_config_equal.pb.go
index a5b8ce48c6..a5311abe4a 100644
--- a/backend/generated-go/store/review_config_equal.pb.go
+++ b/backend/generated-go/store/review_config_equal.pb.go
@@ -21,6 +21,113 @@ func (x *ReviewConfigPayload) Equal(y *ReviewConfigPayload) bool {
return true
}
+func (x *SQLReviewRule_NamingRulePayload) Equal(y *SQLReviewRule_NamingRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.MaxLength != y.MaxLength {
+ return false
+ }
+ if x.Format != y.Format {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_NumberRulePayload) Equal(y *SQLReviewRule_NumberRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Number != y.Number {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) Equal(y *SQLReviewRule_StringArrayRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.List) != len(y.List) {
+ return false
+ }
+ for i := 0; i < len(x.List); i++ {
+ if x.List[i] != y.List[i] {
+ return false
+ }
+ }
+ return true
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) Equal(y *SQLReviewRule_CommentConventionRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Required != y.Required {
+ return false
+ }
+ if x.MaxLength != y.MaxLength {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) Equal(y *SQLReviewRule_RequiredColumnRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.ColumnList) != len(y.ColumnList) {
+ return false
+ }
+ for i := 0; i < len(x.ColumnList); i++ {
+ if x.ColumnList[i] != y.ColumnList[i] {
+ return false
+ }
+ }
+ return true
+}
+
+func (x *SQLReviewRule_StringRulePayload) Equal(y *SQLReviewRule_StringRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Value != y.Value {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) Equal(y *SQLReviewRule_NamingCaseRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Upper != y.Upper {
+ return false
+ }
+ return true
+}
+
func (x *SQLReviewRule) Equal(y *SQLReviewRule) bool {
if x == y {
return true
@@ -34,7 +141,25 @@ func (x *SQLReviewRule) Equal(y *SQLReviewRule) bool {
if x.Level != y.Level {
return false
}
- if x.Payload != y.Payload {
+ if !x.GetNamingPayload().Equal(y.GetNamingPayload()) {
+ return false
+ }
+ if !x.GetNumberPayload().Equal(y.GetNumberPayload()) {
+ return false
+ }
+ if !x.GetStringArrayPayload().Equal(y.GetStringArrayPayload()) {
+ return false
+ }
+ if !x.GetCommentConventionPayload().Equal(y.GetCommentConventionPayload()) {
+ return false
+ }
+ if !x.GetRequiredColumnPayload().Equal(y.GetRequiredColumnPayload()) {
+ return false
+ }
+ if !x.GetStringPayload().Equal(y.GetStringPayload()) {
+ return false
+ }
+ if !x.GetNamingCasePayload().Equal(y.GetNamingCasePayload()) {
return false
}
if x.Engine != y.Engine {
diff --git a/backend/generated-go/v1/review_config_service.pb.go b/backend/generated-go/v1/review_config_service.pb.go
index 12e48ba710..68e11a1343 100644
--- a/backend/generated-go/v1/review_config_service.pb.go
+++ b/backend/generated-go/v1/review_config_service.pb.go
@@ -822,10 +822,20 @@ type SQLReviewRule struct {
Type SQLReviewRule_Type `protobuf:"varint,1,opt,name=type,proto3,enum=bytebase.v1.SQLReviewRule_Type" json:"type,omitempty"`
// The severity level of the rule.
Level SQLReviewRule_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.v1.SQLReviewRule_Level" json:"level,omitempty"`
- // The payload is a JSON string that varies by rule type.
- Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
+ // The payload is a typed message that varies by rule type.
+ //
+ // Types that are valid to be assigned to Payload:
+ //
+ // *SQLReviewRule_NamingPayload
+ // *SQLReviewRule_NumberPayload
+ // *SQLReviewRule_StringArrayPayload
+ // *SQLReviewRule_CommentConventionPayload
+ // *SQLReviewRule_RequiredColumnPayload
+ // *SQLReviewRule_StringPayload
+ // *SQLReviewRule_NamingCasePayload
+ Payload isSQLReviewRule_Payload `protobuf_oneof:"payload"`
// The database engine this rule applies to.
- Engine Engine `protobuf:"varint,4,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`
+ Engine Engine `protobuf:"varint,10,opt,name=engine,proto3,enum=bytebase.v1.Engine" json:"engine,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
@@ -874,11 +884,74 @@ func (x *SQLReviewRule) GetLevel() SQLReviewRule_Level {
return SQLReviewRule_LEVEL_UNSPECIFIED
}
-func (x *SQLReviewRule) GetPayload() string {
+func (x *SQLReviewRule) GetPayload() isSQLReviewRule_Payload {
if x != nil {
return x.Payload
}
- return ""
+ return nil
+}
+
+func (x *SQLReviewRule) GetNamingPayload() *SQLReviewRule_NamingRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NamingPayload); ok {
+ return x.NamingPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetNumberPayload() *SQLReviewRule_NumberRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NumberPayload); ok {
+ return x.NumberPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetStringArrayPayload() *SQLReviewRule_StringArrayRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_StringArrayPayload); ok {
+ return x.StringArrayPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetCommentConventionPayload() *SQLReviewRule_CommentConventionRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_CommentConventionPayload); ok {
+ return x.CommentConventionPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetRequiredColumnPayload() *SQLReviewRule_RequiredColumnRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_RequiredColumnPayload); ok {
+ return x.RequiredColumnPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetStringPayload() *SQLReviewRule_StringRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_StringPayload); ok {
+ return x.StringPayload
+ }
+ }
+ return nil
+}
+
+func (x *SQLReviewRule) GetNamingCasePayload() *SQLReviewRule_NamingCaseRulePayload {
+ if x != nil {
+ if x, ok := x.Payload.(*SQLReviewRule_NamingCasePayload); ok {
+ return x.NamingCasePayload
+ }
+ }
+ return nil
}
func (x *SQLReviewRule) GetEngine() Engine {
@@ -888,6 +961,377 @@ func (x *SQLReviewRule) GetEngine() Engine {
return Engine_ENGINE_UNSPECIFIED
}
+type isSQLReviewRule_Payload interface {
+ isSQLReviewRule_Payload()
+}
+
+type SQLReviewRule_NamingPayload struct {
+ NamingPayload *SQLReviewRule_NamingRulePayload `protobuf:"bytes,3,opt,name=naming_payload,json=namingPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_NumberPayload struct {
+ NumberPayload *SQLReviewRule_NumberRulePayload `protobuf:"bytes,4,opt,name=number_payload,json=numberPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_StringArrayPayload struct {
+ StringArrayPayload *SQLReviewRule_StringArrayRulePayload `protobuf:"bytes,5,opt,name=string_array_payload,json=stringArrayPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_CommentConventionPayload struct {
+ CommentConventionPayload *SQLReviewRule_CommentConventionRulePayload `protobuf:"bytes,6,opt,name=comment_convention_payload,json=commentConventionPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_RequiredColumnPayload struct {
+ RequiredColumnPayload *SQLReviewRule_RequiredColumnRulePayload `protobuf:"bytes,7,opt,name=required_column_payload,json=requiredColumnPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_StringPayload struct {
+ StringPayload *SQLReviewRule_StringRulePayload `protobuf:"bytes,8,opt,name=string_payload,json=stringPayload,proto3,oneof"`
+}
+
+type SQLReviewRule_NamingCasePayload struct {
+ NamingCasePayload *SQLReviewRule_NamingCaseRulePayload `protobuf:"bytes,9,opt,name=naming_case_payload,json=namingCasePayload,proto3,oneof"`
+}
+
+func (*SQLReviewRule_NamingPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_NumberPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_StringArrayPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_CommentConventionPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_RequiredColumnPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_StringPayload) isSQLReviewRule_Payload() {}
+
+func (*SQLReviewRule_NamingCasePayload) isSQLReviewRule_Payload() {}
+
+// Payload message types for SQL review rules
+type SQLReviewRule_NamingRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ MaxLength int32 `protobuf:"varint,1,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
+ Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NamingRulePayload) Reset() {
+ *x = SQLReviewRule_NamingRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[8]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NamingRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NamingRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NamingRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[8]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NamingRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NamingRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 0}
+}
+
+func (x *SQLReviewRule_NamingRulePayload) GetMaxLength() int32 {
+ if x != nil {
+ return x.MaxLength
+ }
+ return 0
+}
+
+func (x *SQLReviewRule_NamingRulePayload) GetFormat() string {
+ if x != nil {
+ return x.Format
+ }
+ return ""
+}
+
+type SQLReviewRule_NumberRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Number int32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NumberRulePayload) Reset() {
+ *x = SQLReviewRule_NumberRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[9]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NumberRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NumberRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NumberRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[9]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NumberRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NumberRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 1}
+}
+
+func (x *SQLReviewRule_NumberRulePayload) GetNumber() int32 {
+ if x != nil {
+ return x.Number
+ }
+ return 0
+}
+
+type SQLReviewRule_StringArrayRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ List []string `protobuf:"bytes,1,rep,name=list,proto3" json:"list,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) Reset() {
+ *x = SQLReviewRule_StringArrayRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[10]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_StringArrayRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_StringArrayRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[10]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_StringArrayRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_StringArrayRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 2}
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) GetList() []string {
+ if x != nil {
+ return x.List
+ }
+ return nil
+}
+
+type SQLReviewRule_CommentConventionRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Required bool `protobuf:"varint,1,opt,name=required,proto3" json:"required,omitempty"`
+ MaxLength int32 `protobuf:"varint,2,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) Reset() {
+ *x = SQLReviewRule_CommentConventionRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[11]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_CommentConventionRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[11]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_CommentConventionRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_CommentConventionRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 3}
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) GetRequired() bool {
+ if x != nil {
+ return x.Required
+ }
+ return false
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) GetMaxLength() int32 {
+ if x != nil {
+ return x.MaxLength
+ }
+ return 0
+}
+
+type SQLReviewRule_RequiredColumnRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ ColumnList []string `protobuf:"bytes,1,rep,name=column_list,json=columnList,proto3" json:"column_list,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) Reset() {
+ *x = SQLReviewRule_RequiredColumnRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[12]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_RequiredColumnRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[12]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_RequiredColumnRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_RequiredColumnRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 4}
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) GetColumnList() []string {
+ if x != nil {
+ return x.ColumnList
+ }
+ return nil
+}
+
+type SQLReviewRule_StringRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_StringRulePayload) Reset() {
+ *x = SQLReviewRule_StringRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[13]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_StringRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_StringRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_StringRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[13]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_StringRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_StringRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 5}
+}
+
+func (x *SQLReviewRule_StringRulePayload) GetValue() string {
+ if x != nil {
+ return x.Value
+ }
+ return ""
+}
+
+type SQLReviewRule_NamingCaseRulePayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Upper bool `protobuf:"varint,1,opt,name=upper,proto3" json:"upper,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) Reset() {
+ *x = SQLReviewRule_NamingCaseRulePayload{}
+ mi := &file_v1_review_config_service_proto_msgTypes[14]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SQLReviewRule_NamingCaseRulePayload) ProtoMessage() {}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_review_config_service_proto_msgTypes[14]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use SQLReviewRule_NamingCaseRulePayload.ProtoReflect.Descriptor instead.
+func (*SQLReviewRule_NamingCaseRulePayload) Descriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 6}
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) GetUpper() bool {
+ if x != nil {
+ return x.Upper
+ }
+ return false
+}
+
var File_v1_review_config_service_proto protoreflect.FileDescriptor
const file_v1_review_config_service_proto_rawDesc = "" +
@@ -915,12 +1359,38 @@ const file_v1_review_config_service_proto_rawDesc = "" +
"\aenabled\x18\x03 \x01(\bR\aenabled\x120\n" +
"\x05rules\x18\a \x03(\v2\x1a.bytebase.v1.SQLReviewRuleR\x05rules\x12\x1c\n" +
"\tresources\x18\b \x03(\tR\tresources:<\xeaA9\n" +
- "\x19bytebase.com/ReviewConfig\x12\x1creviewConfigs/{reviewConfig}\"\xae\x1e\n" +
+ "\x19bytebase.com/ReviewConfig\x12\x1creviewConfigs/{reviewConfig}\"\xf2&\n" +
"\rSQLReviewRule\x123\n" +
"\x04type\x18\x01 \x01(\x0e2\x1f.bytebase.v1.SQLReviewRule.TypeR\x04type\x126\n" +
- "\x05level\x18\x02 \x01(\x0e2 .bytebase.v1.SQLReviewRule.LevelR\x05level\x12\x18\n" +
- "\apayload\x18\x03 \x01(\tR\apayload\x12+\n" +
- "\x06engine\x18\x04 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\"6\n" +
+ "\x05level\x18\x02 \x01(\x0e2 .bytebase.v1.SQLReviewRule.LevelR\x05level\x12U\n" +
+ "\x0enaming_payload\x18\x03 \x01(\v2,.bytebase.v1.SQLReviewRule.NamingRulePayloadH\x00R\rnamingPayload\x12U\n" +
+ "\x0enumber_payload\x18\x04 \x01(\v2,.bytebase.v1.SQLReviewRule.NumberRulePayloadH\x00R\rnumberPayload\x12e\n" +
+ "\x14string_array_payload\x18\x05 \x01(\v21.bytebase.v1.SQLReviewRule.StringArrayRulePayloadH\x00R\x12stringArrayPayload\x12w\n" +
+ "\x1acomment_convention_payload\x18\x06 \x01(\v27.bytebase.v1.SQLReviewRule.CommentConventionRulePayloadH\x00R\x18commentConventionPayload\x12n\n" +
+ "\x17required_column_payload\x18\a \x01(\v24.bytebase.v1.SQLReviewRule.RequiredColumnRulePayloadH\x00R\x15requiredColumnPayload\x12U\n" +
+ "\x0estring_payload\x18\b \x01(\v2,.bytebase.v1.SQLReviewRule.StringRulePayloadH\x00R\rstringPayload\x12b\n" +
+ "\x13naming_case_payload\x18\t \x01(\v20.bytebase.v1.SQLReviewRule.NamingCaseRulePayloadH\x00R\x11namingCasePayload\x12+\n" +
+ "\x06engine\x18\n" +
+ " \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\x1aJ\n" +
+ "\x11NamingRulePayload\x12\x1d\n" +
+ "\n" +
+ "max_length\x18\x01 \x01(\x05R\tmaxLength\x12\x16\n" +
+ "\x06format\x18\x02 \x01(\tR\x06format\x1a+\n" +
+ "\x11NumberRulePayload\x12\x16\n" +
+ "\x06number\x18\x01 \x01(\x05R\x06number\x1a,\n" +
+ "\x16StringArrayRulePayload\x12\x12\n" +
+ "\x04list\x18\x01 \x03(\tR\x04list\x1aY\n" +
+ "\x1cCommentConventionRulePayload\x12\x1a\n" +
+ "\brequired\x18\x01 \x01(\bR\brequired\x12\x1d\n" +
+ "\n" +
+ "max_length\x18\x02 \x01(\x05R\tmaxLength\x1a<\n" +
+ "\x19RequiredColumnRulePayload\x12\x1f\n" +
+ "\vcolumn_list\x18\x01 \x03(\tR\n" +
+ "columnList\x1a)\n" +
+ "\x11StringRulePayload\x12\x14\n" +
+ "\x05value\x18\x01 \x01(\tR\x05value\x1a-\n" +
+ "\x15NamingCaseRulePayload\x12\x14\n" +
+ "\x05upper\x18\x01 \x01(\bR\x05upper\"6\n" +
"\x05Level\x12\x15\n" +
"\x11LEVEL_UNSPECIFIED\x10\x00\x12\t\n" +
"\x05ERROR\x10\x01\x12\v\n" +
@@ -1036,7 +1506,8 @@ const file_v1_review_config_service_proto_rawDesc = "" +
"\x1fSYSTEM_FUNCTION_DISALLOW_CREATE\x10j\x12#\n" +
"\x1fSYSTEM_FUNCTION_DISALLOWED_LIST\x10k\x12\x1b\n" +
"\x17ADVICE_ONLINE_MIGRATION\x10l\x12\x1e\n" +
- "\x1aBUILTIN_PRIOR_BACKUP_CHECK\x10m2\xed\x06\n" +
+ "\x1aBUILTIN_PRIOR_BACKUP_CHECK\x10mB\t\n" +
+ "\apayload2\xed\x06\n" +
"\x13ReviewConfigService\x12\xa3\x01\n" +
"\x12CreateReviewConfig\x12&.bytebase.v1.CreateReviewConfigRequest\x1a\x19.bytebase.v1.ReviewConfig\"J\xdaA\x00\x8a\xea0\x17bb.reviewConfigs.create\x90\xea0\x01\x82\xd3\xe4\x93\x02\":\rreview_config\"\x11/v1/reviewConfigs\x12\x9d\x01\n" +
"\x11ListReviewConfigs\x12%.bytebase.v1.ListReviewConfigsRequest\x1a&.bytebase.v1.ListReviewConfigsResponse\"9\xdaA\x00\x8a\xea0\x15bb.reviewConfigs.list\x90\xea0\x01\x82\xd3\xe4\x93\x02\x13\x12\x11/v1/reviewConfigs\x12\x98\x01\n" +
@@ -1058,46 +1529,60 @@ func file_v1_review_config_service_proto_rawDescGZIP() []byte {
}
var file_v1_review_config_service_proto_enumTypes = make([]protoimpl.EnumInfo, 2)
-var file_v1_review_config_service_proto_msgTypes = make([]protoimpl.MessageInfo, 8)
+var file_v1_review_config_service_proto_msgTypes = make([]protoimpl.MessageInfo, 15)
var file_v1_review_config_service_proto_goTypes = []any{
- (SQLReviewRule_Level)(0), // 0: bytebase.v1.SQLReviewRule.Level
- (SQLReviewRule_Type)(0), // 1: bytebase.v1.SQLReviewRule.Type
- (*ListReviewConfigsRequest)(nil), // 2: bytebase.v1.ListReviewConfigsRequest
- (*ListReviewConfigsResponse)(nil), // 3: bytebase.v1.ListReviewConfigsResponse
- (*CreateReviewConfigRequest)(nil), // 4: bytebase.v1.CreateReviewConfigRequest
- (*UpdateReviewConfigRequest)(nil), // 5: bytebase.v1.UpdateReviewConfigRequest
- (*GetReviewConfigRequest)(nil), // 6: bytebase.v1.GetReviewConfigRequest
- (*DeleteReviewConfigRequest)(nil), // 7: bytebase.v1.DeleteReviewConfigRequest
- (*ReviewConfig)(nil), // 8: bytebase.v1.ReviewConfig
- (*SQLReviewRule)(nil), // 9: bytebase.v1.SQLReviewRule
- (*fieldmaskpb.FieldMask)(nil), // 10: google.protobuf.FieldMask
- (Engine)(0), // 11: bytebase.v1.Engine
- (*emptypb.Empty)(nil), // 12: google.protobuf.Empty
+ (SQLReviewRule_Level)(0), // 0: bytebase.v1.SQLReviewRule.Level
+ (SQLReviewRule_Type)(0), // 1: bytebase.v1.SQLReviewRule.Type
+ (*ListReviewConfigsRequest)(nil), // 2: bytebase.v1.ListReviewConfigsRequest
+ (*ListReviewConfigsResponse)(nil), // 3: bytebase.v1.ListReviewConfigsResponse
+ (*CreateReviewConfigRequest)(nil), // 4: bytebase.v1.CreateReviewConfigRequest
+ (*UpdateReviewConfigRequest)(nil), // 5: bytebase.v1.UpdateReviewConfigRequest
+ (*GetReviewConfigRequest)(nil), // 6: bytebase.v1.GetReviewConfigRequest
+ (*DeleteReviewConfigRequest)(nil), // 7: bytebase.v1.DeleteReviewConfigRequest
+ (*ReviewConfig)(nil), // 8: bytebase.v1.ReviewConfig
+ (*SQLReviewRule)(nil), // 9: bytebase.v1.SQLReviewRule
+ (*SQLReviewRule_NamingRulePayload)(nil), // 10: bytebase.v1.SQLReviewRule.NamingRulePayload
+ (*SQLReviewRule_NumberRulePayload)(nil), // 11: bytebase.v1.SQLReviewRule.NumberRulePayload
+ (*SQLReviewRule_StringArrayRulePayload)(nil), // 12: bytebase.v1.SQLReviewRule.StringArrayRulePayload
+ (*SQLReviewRule_CommentConventionRulePayload)(nil), // 13: bytebase.v1.SQLReviewRule.CommentConventionRulePayload
+ (*SQLReviewRule_RequiredColumnRulePayload)(nil), // 14: bytebase.v1.SQLReviewRule.RequiredColumnRulePayload
+ (*SQLReviewRule_StringRulePayload)(nil), // 15: bytebase.v1.SQLReviewRule.StringRulePayload
+ (*SQLReviewRule_NamingCaseRulePayload)(nil), // 16: bytebase.v1.SQLReviewRule.NamingCaseRulePayload
+ (*fieldmaskpb.FieldMask)(nil), // 17: google.protobuf.FieldMask
+ (Engine)(0), // 18: bytebase.v1.Engine
+ (*emptypb.Empty)(nil), // 19: google.protobuf.Empty
}
var file_v1_review_config_service_proto_depIdxs = []int32{
8, // 0: bytebase.v1.ListReviewConfigsResponse.review_configs:type_name -> bytebase.v1.ReviewConfig
8, // 1: bytebase.v1.CreateReviewConfigRequest.review_config:type_name -> bytebase.v1.ReviewConfig
8, // 2: bytebase.v1.UpdateReviewConfigRequest.review_config:type_name -> bytebase.v1.ReviewConfig
- 10, // 3: bytebase.v1.UpdateReviewConfigRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 17, // 3: bytebase.v1.UpdateReviewConfigRequest.update_mask:type_name -> google.protobuf.FieldMask
9, // 4: bytebase.v1.ReviewConfig.rules:type_name -> bytebase.v1.SQLReviewRule
1, // 5: bytebase.v1.SQLReviewRule.type:type_name -> bytebase.v1.SQLReviewRule.Type
0, // 6: bytebase.v1.SQLReviewRule.level:type_name -> bytebase.v1.SQLReviewRule.Level
- 11, // 7: bytebase.v1.SQLReviewRule.engine:type_name -> bytebase.v1.Engine
- 4, // 8: bytebase.v1.ReviewConfigService.CreateReviewConfig:input_type -> bytebase.v1.CreateReviewConfigRequest
- 2, // 9: bytebase.v1.ReviewConfigService.ListReviewConfigs:input_type -> bytebase.v1.ListReviewConfigsRequest
- 6, // 10: bytebase.v1.ReviewConfigService.GetReviewConfig:input_type -> bytebase.v1.GetReviewConfigRequest
- 5, // 11: bytebase.v1.ReviewConfigService.UpdateReviewConfig:input_type -> bytebase.v1.UpdateReviewConfigRequest
- 7, // 12: bytebase.v1.ReviewConfigService.DeleteReviewConfig:input_type -> bytebase.v1.DeleteReviewConfigRequest
- 8, // 13: bytebase.v1.ReviewConfigService.CreateReviewConfig:output_type -> bytebase.v1.ReviewConfig
- 3, // 14: bytebase.v1.ReviewConfigService.ListReviewConfigs:output_type -> bytebase.v1.ListReviewConfigsResponse
- 8, // 15: bytebase.v1.ReviewConfigService.GetReviewConfig:output_type -> bytebase.v1.ReviewConfig
- 8, // 16: bytebase.v1.ReviewConfigService.UpdateReviewConfig:output_type -> bytebase.v1.ReviewConfig
- 12, // 17: bytebase.v1.ReviewConfigService.DeleteReviewConfig:output_type -> google.protobuf.Empty
- 13, // [13:18] is the sub-list for method output_type
- 8, // [8:13] is the sub-list for method input_type
- 8, // [8:8] is the sub-list for extension type_name
- 8, // [8:8] is the sub-list for extension extendee
- 0, // [0:8] is the sub-list for field type_name
+ 10, // 7: bytebase.v1.SQLReviewRule.naming_payload:type_name -> bytebase.v1.SQLReviewRule.NamingRulePayload
+ 11, // 8: bytebase.v1.SQLReviewRule.number_payload:type_name -> bytebase.v1.SQLReviewRule.NumberRulePayload
+ 12, // 9: bytebase.v1.SQLReviewRule.string_array_payload:type_name -> bytebase.v1.SQLReviewRule.StringArrayRulePayload
+ 13, // 10: bytebase.v1.SQLReviewRule.comment_convention_payload:type_name -> bytebase.v1.SQLReviewRule.CommentConventionRulePayload
+ 14, // 11: bytebase.v1.SQLReviewRule.required_column_payload:type_name -> bytebase.v1.SQLReviewRule.RequiredColumnRulePayload
+ 15, // 12: bytebase.v1.SQLReviewRule.string_payload:type_name -> bytebase.v1.SQLReviewRule.StringRulePayload
+ 16, // 13: bytebase.v1.SQLReviewRule.naming_case_payload:type_name -> bytebase.v1.SQLReviewRule.NamingCaseRulePayload
+ 18, // 14: bytebase.v1.SQLReviewRule.engine:type_name -> bytebase.v1.Engine
+ 4, // 15: bytebase.v1.ReviewConfigService.CreateReviewConfig:input_type -> bytebase.v1.CreateReviewConfigRequest
+ 2, // 16: bytebase.v1.ReviewConfigService.ListReviewConfigs:input_type -> bytebase.v1.ListReviewConfigsRequest
+ 6, // 17: bytebase.v1.ReviewConfigService.GetReviewConfig:input_type -> bytebase.v1.GetReviewConfigRequest
+ 5, // 18: bytebase.v1.ReviewConfigService.UpdateReviewConfig:input_type -> bytebase.v1.UpdateReviewConfigRequest
+ 7, // 19: bytebase.v1.ReviewConfigService.DeleteReviewConfig:input_type -> bytebase.v1.DeleteReviewConfigRequest
+ 8, // 20: bytebase.v1.ReviewConfigService.CreateReviewConfig:output_type -> bytebase.v1.ReviewConfig
+ 3, // 21: bytebase.v1.ReviewConfigService.ListReviewConfigs:output_type -> bytebase.v1.ListReviewConfigsResponse
+ 8, // 22: bytebase.v1.ReviewConfigService.GetReviewConfig:output_type -> bytebase.v1.ReviewConfig
+ 8, // 23: bytebase.v1.ReviewConfigService.UpdateReviewConfig:output_type -> bytebase.v1.ReviewConfig
+ 19, // 24: bytebase.v1.ReviewConfigService.DeleteReviewConfig:output_type -> google.protobuf.Empty
+ 20, // [20:25] is the sub-list for method output_type
+ 15, // [15:20] is the sub-list for method input_type
+ 15, // [15:15] is the sub-list for extension type_name
+ 15, // [15:15] is the sub-list for extension extendee
+ 0, // [0:15] is the sub-list for field type_name
}
func init() { file_v1_review_config_service_proto_init() }
@@ -1107,13 +1592,22 @@ func file_v1_review_config_service_proto_init() {
}
file_v1_annotation_proto_init()
file_v1_common_proto_init()
+ file_v1_review_config_service_proto_msgTypes[7].OneofWrappers = []any{
+ (*SQLReviewRule_NamingPayload)(nil),
+ (*SQLReviewRule_NumberPayload)(nil),
+ (*SQLReviewRule_StringArrayPayload)(nil),
+ (*SQLReviewRule_CommentConventionPayload)(nil),
+ (*SQLReviewRule_RequiredColumnPayload)(nil),
+ (*SQLReviewRule_StringPayload)(nil),
+ (*SQLReviewRule_NamingCasePayload)(nil),
+ }
type x struct{}
out := protoimpl.TypeBuilder{
File: protoimpl.DescBuilder{
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_review_config_service_proto_rawDesc), len(file_v1_review_config_service_proto_rawDesc)),
NumEnums: 2,
- NumMessages: 8,
+ NumMessages: 15,
NumExtensions: 0,
NumServices: 1,
},
diff --git a/backend/generated-go/v1/review_config_service_equal.pb.go b/backend/generated-go/v1/review_config_service_equal.pb.go
index f98854ab9b..509b7d769e 100644
--- a/backend/generated-go/v1/review_config_service_equal.pb.go
+++ b/backend/generated-go/v1/review_config_service_equal.pb.go
@@ -133,6 +133,113 @@ func (x *ReviewConfig) Equal(y *ReviewConfig) bool {
return true
}
+func (x *SQLReviewRule_NamingRulePayload) Equal(y *SQLReviewRule_NamingRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.MaxLength != y.MaxLength {
+ return false
+ }
+ if x.Format != y.Format {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_NumberRulePayload) Equal(y *SQLReviewRule_NumberRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Number != y.Number {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_StringArrayRulePayload) Equal(y *SQLReviewRule_StringArrayRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.List) != len(y.List) {
+ return false
+ }
+ for i := 0; i < len(x.List); i++ {
+ if x.List[i] != y.List[i] {
+ return false
+ }
+ }
+ return true
+}
+
+func (x *SQLReviewRule_CommentConventionRulePayload) Equal(y *SQLReviewRule_CommentConventionRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Required != y.Required {
+ return false
+ }
+ if x.MaxLength != y.MaxLength {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_RequiredColumnRulePayload) Equal(y *SQLReviewRule_RequiredColumnRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if len(x.ColumnList) != len(y.ColumnList) {
+ return false
+ }
+ for i := 0; i < len(x.ColumnList); i++ {
+ if x.ColumnList[i] != y.ColumnList[i] {
+ return false
+ }
+ }
+ return true
+}
+
+func (x *SQLReviewRule_StringRulePayload) Equal(y *SQLReviewRule_StringRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Value != y.Value {
+ return false
+ }
+ return true
+}
+
+func (x *SQLReviewRule_NamingCaseRulePayload) Equal(y *SQLReviewRule_NamingCaseRulePayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Upper != y.Upper {
+ return false
+ }
+ return true
+}
+
func (x *SQLReviewRule) Equal(y *SQLReviewRule) bool {
if x == y {
return true
@@ -146,7 +253,25 @@ func (x *SQLReviewRule) Equal(y *SQLReviewRule) bool {
if x.Level != y.Level {
return false
}
- if x.Payload != y.Payload {
+ if !x.GetNamingPayload().Equal(y.GetNamingPayload()) {
+ return false
+ }
+ if !x.GetNumberPayload().Equal(y.GetNumberPayload()) {
+ return false
+ }
+ if !x.GetStringArrayPayload().Equal(y.GetStringArrayPayload()) {
+ return false
+ }
+ if !x.GetCommentConventionPayload().Equal(y.GetCommentConventionPayload()) {
+ return false
+ }
+ if !x.GetRequiredColumnPayload().Equal(y.GetRequiredColumnPayload()) {
+ return false
+ }
+ if !x.GetStringPayload().Equal(y.GetStringPayload()) {
+ return false
+ }
+ if !x.GetNamingCasePayload().Equal(y.GetNamingCasePayload()) {
return false
}
if x.Engine != y.Engine {
diff --git a/backend/migrator/migration/3.13/0018##migrate_review_config_payload_to_proto.sql b/backend/migrator/migration/3.13/0018##migrate_review_config_payload_to_proto.sql
new file mode 100644
index 0000000000..8eef71b2d0
--- /dev/null
+++ b/backend/migrator/migration/3.13/0018##migrate_review_config_payload_to_proto.sql
@@ -0,0 +1,78 @@
+-- Migrate SQL review rule payloads from flat JSON to typed proto format
+-- Old format: payload was stored as a JSON string like "{\"maxLength\":64,\"format\":\"^[a-z]+$\"}"
+-- New format: payload is a typed object like {"namingPayload":{"maxLength":64,"format":"^[a-z]+$"}}
+-- Note: Old proto had 'string payload', so protojson stored it as a JSON string
+-- This migration parses the JSON string and wraps it in the appropriate typed payload field
+
+DO $$
+DECLARE
+ r RECORD;
+BEGIN
+ FOR r IN SELECT id, payload FROM review_config
+ LOOP
+ UPDATE review_config
+ SET payload = jsonb_set(
+ r.payload,
+ '{sqlReviewRules}',
+ (
+ SELECT jsonb_agg(
+ CASE
+ -- Naming rules: parse JSON string and wrap in namingPayload
+ WHEN (rule->>'type') IN (
+ 'NAMING_TABLE', 'NAMING_COLUMN', 'NAMING_INDEX_PK', 'NAMING_INDEX_UK',
+ 'NAMING_INDEX_FK', 'NAMING_INDEX_IDX', 'NAMING_COLUMN_AUTO_INCREMENT',
+ 'TABLE_DROP_NAMING_CONVENTION'
+ ) AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(rule, '{namingPayload}', (rule->>'payload')::jsonb) - 'payload'
+
+ -- Number rules: parse JSON string and wrap in numberPayload
+ WHEN (rule->>'type') IN (
+ 'STATEMENT_INSERT_ROW_LIMIT', 'STATEMENT_AFFECTED_ROW_LIMIT',
+ 'STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT', 'STATEMENT_MAXIMUM_LIMIT_VALUE',
+ 'STATEMENT_MAXIMUM_JOIN_TABLE_COUNT', 'STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION',
+ 'STATEMENT_MAX_EXECUTION_TIME', 'STATEMENT_QUERY_MINIMUM_PLAN_LEVEL',
+ 'COLUMN_MAXIMUM_CHARACTER_LENGTH', 'COLUMN_MAXIMUM_VARCHAR_LENGTH',
+ 'COLUMN_AUTO_INCREMENT_INITIAL_VALUE', 'COLUMN_CURRENT_TIME_COUNT_LIMIT',
+ 'INDEX_KEY_NUMBER_LIMIT', 'INDEX_TOTAL_NUMBER_LIMIT',
+ 'TABLE_TEXT_FIELDS_TOTAL_LENGTH', 'TABLE_LIMIT_SIZE', 'SYSTEM_COMMENT_LENGTH'
+ ) AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(rule, '{numberPayload}', (rule->>'payload')::jsonb) - 'payload'
+
+ -- String array rules: parse JSON string and wrap in stringArrayPayload
+ WHEN (rule->>'type') IN (
+ 'COLUMN_REQUIRED', 'COLUMN_TYPE_DISALLOW_LIST',
+ 'INDEX_PRIMARY_KEY_TYPE_ALLOWLIST', 'INDEX_TYPE_ALLOW_LIST',
+ 'SYSTEM_CHARSET_ALLOWLIST', 'SYSTEM_COLLATION_ALLOWLIST',
+ 'SYSTEM_FUNCTION_DISALLOWED_LIST', 'TABLE_DISALLOW_DDL', 'TABLE_DISALLOW_DML'
+ ) AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(rule, '{stringArrayPayload}', (rule->>'payload')::jsonb) - 'payload'
+
+ -- Comment convention rules: parse JSON string and wrap in commentConventionPayload
+ WHEN (rule->>'type') IN ('TABLE_COMMENT', 'COLUMN_COMMENT')
+ AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(rule, '{commentConventionPayload}', (rule->>'payload')::jsonb) - 'payload'
+
+ -- Naming case rule: parse JSON string and wrap in namingCasePayload
+ WHEN (rule->>'type') = 'NAMING_IDENTIFIER_CASE'
+ AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(rule, '{namingCasePayload}', (rule->>'payload')::jsonb) - 'payload'
+
+ -- String rule: parse JSON string, rename field from "string" to "value", and wrap in stringPayload
+ WHEN (rule->>'type') = 'NAMING_FULLY_QUALIFIED'
+ AND rule->>'payload' IS NOT NULL AND rule->>'payload' != '' AND rule->>'payload' != 'null' AND rule->>'payload' != '{}'
+ THEN jsonb_set(
+ rule,
+ '{stringPayload}',
+ jsonb_build_object('value', (rule->>'payload')::jsonb->>'string')
+ ) - 'payload'
+
+ -- Rules with empty/null payload or already migrated - remove payload field
+ ELSE rule - 'payload'
+ END
+ )
+ FROM jsonb_array_elements(r.payload->'sqlReviewRules') AS rules(rule)
+ )
+ )
+ WHERE id = r.id;
+ END LOOP;
+END $$;
diff --git a/backend/migrator/migrator_test.go b/backend/migrator/migrator_test.go
index e03e4ccc5e..7457778a3d 100644
--- a/backend/migrator/migrator_test.go
+++ b/backend/migrator/migrator_test.go
@@ -12,7 +12,7 @@ import (
func TestLatestVersion(t *testing.T) {
files, err := getSortedVersionedFiles()
require.NoError(t, err)
- require.Equal(t, semver.MustParse("3.13.17"), *files[len(files)-1].version)
+ require.Equal(t, semver.MustParse("3.13.18"), *files[len(files)-1].version)
}
func TestVersionUnique(t *testing.T) {
diff --git a/backend/plugin/advisor/builtin_rules.go b/backend/plugin/advisor/builtin_rules.go
index d34379225c..bb0cffe9c4 100644
--- a/backend/plugin/advisor/builtin_rules.go
+++ b/backend/plugin/advisor/builtin_rules.go
@@ -7,10 +7,9 @@ func GetBuiltinRules(engine storepb.Engine) []*storepb.SQLReviewRule {
case storepb.Engine_MYSQL, storepb.Engine_POSTGRES, storepb.Engine_TIDB, storepb.Engine_MSSQL, storepb.Engine_ORACLE:
return []*storepb.SQLReviewRule{
{
- Type: storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,
- Level: storepb.SQLReviewRule_WARNING,
- Payload: "",
- Engine: engine,
+ Type: storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,
+ Level: storepb.SQLReviewRule_WARNING,
+ Engine: engine,
},
}
default:
diff --git a/backend/plugin/advisor/mssql/rule_column_maximum_varchar_length.go b/backend/plugin/advisor/mssql/rule_column_maximum_varchar_length.go
index f93b227b9d..50e2e8a5be 100644
--- a/backend/plugin/advisor/mssql/rule_column_maximum_varchar_length.go
+++ b/backend/plugin/advisor/mssql/rule_column_maximum_varchar_length.go
@@ -7,6 +7,8 @@ import (
"math"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -43,17 +45,17 @@ func (*ColumnMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
// Create the rule
- rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mssql/rule_column_require.go b/backend/plugin/advisor/mssql/rule_column_require.go
index 7a783e777e..c9ed82cec2 100644
--- a/backend/plugin/advisor/mssql/rule_column_require.go
+++ b/backend/plugin/advisor/mssql/rule_column_require.go
@@ -5,6 +5,8 @@ import (
"fmt"
"slices"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -41,13 +43,13 @@ func (*ColumnRequireAdvisor) Check(_ context.Context, checkCtx advisor.Context)
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
// Create the rule
- rule := NewColumnRequireRule(level, checkCtx.Rule.Type.String(), columnList)
+ rule := NewColumnRequireRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mssql/rule_column_type_disallow_list.go b/backend/plugin/advisor/mssql/rule_column_type_disallow_list.go
index 1a424a1862..abc2642f8f 100644
--- a/backend/plugin/advisor/mssql/rule_column_type_disallow_list.go
+++ b/backend/plugin/advisor/mssql/rule_column_type_disallow_list.go
@@ -5,6 +5,8 @@ import (
"slices"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -38,13 +40,13 @@ func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column type disallow list rule")
}
disallowTypes := []string{}
- for _, tp := range payload.List {
+ for _, tp := range stringArrayPayload.List {
disallowTypes = append(disallowTypes, strings.ToUpper(tp))
}
diff --git a/backend/plugin/advisor/mssql/rule_naming_table.go b/backend/plugin/advisor/mssql/rule_naming_table.go
index 4940e69b70..e8aa570290 100644
--- a/backend/plugin/advisor/mssql/rule_naming_table.go
+++ b/backend/plugin/advisor/mssql/rule_naming_table.go
@@ -8,6 +8,7 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/tsql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -40,9 +41,19 @@ func (*NamingTableAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mssql/rule_table_disallow_ddl.go b/backend/plugin/advisor/mssql/rule_table_disallow_ddl.go
index a2a7544fe3..98130b3abb 100644
--- a/backend/plugin/advisor/mssql/rule_table_disallow_ddl.go
+++ b/backend/plugin/advisor/mssql/rule_table_disallow_ddl.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -38,13 +40,13 @@ func (*TableDisallowDDLAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for table disallow DDL rule")
}
// Create the rule
- rule := NewTableDisallowDDLRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewTableDisallowDDLRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mssql/rule_table_disallow_dml.go b/backend/plugin/advisor/mssql/rule_table_disallow_dml.go
index 26f0e67573..87a8c4963a 100644
--- a/backend/plugin/advisor/mssql/rule_table_disallow_dml.go
+++ b/backend/plugin/advisor/mssql/rule_table_disallow_dml.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -38,13 +40,13 @@ func (*TableDisallowDMLAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for table disallow DML rule")
}
// Create the rule
- rule := NewTableDisallowDMLRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewTableDisallowDMLRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mssql/rule_table_drop_naming_convention.go b/backend/plugin/advisor/mssql/rule_table_drop_naming_convention.go
index 1e39baa843..2a02e2c14a 100644
--- a/backend/plugin/advisor/mssql/rule_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/mssql/rule_table_drop_naming_convention.go
@@ -5,14 +5,14 @@ import (
"fmt"
"regexp"
- "github.com/bytebase/bytebase/backend/plugin/advisor/code"
-
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/tsql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
tsqlparser "github.com/bytebase/bytebase/backend/plugin/parser/tsql"
)
@@ -40,9 +40,15 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_charset_allowlist.go b/backend/plugin/advisor/mysql/rule_charset_allowlist.go
index a7e3af7c42..3e2db329b0 100644
--- a/backend/plugin/advisor/mysql/rule_charset_allowlist.go
+++ b/backend/plugin/advisor/mysql/rule_charset_allowlist.go
@@ -40,13 +40,10 @@ func (*CharsetAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
allowList := make(map[string]bool)
- for _, charset := range payload.List {
+ for _, charset := range stringArrayPayload.List {
allowList[strings.ToLower(charset)] = true
}
diff --git a/backend/plugin/advisor/mysql/rule_collation_allowlist.go b/backend/plugin/advisor/mysql/rule_collation_allowlist.go
index 808a748a0c..b716cd870f 100644
--- a/backend/plugin/advisor/mysql/rule_collation_allowlist.go
+++ b/backend/plugin/advisor/mysql/rule_collation_allowlist.go
@@ -41,13 +41,10 @@ func (*CollationAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Cont
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Create the rule
- rule := NewCollationAllowlistRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewCollationAllowlistRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_column_auto_increment_initial_value.go b/backend/plugin/advisor/mysql/rule_column_auto_increment_initial_value.go
index 189b2df1b1..a362150a72 100644
--- a/backend/plugin/advisor/mysql/rule_column_auto_increment_initial_value.go
+++ b/backend/plugin/advisor/mysql/rule_column_auto_increment_initial_value.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -44,13 +46,13 @@ func (*ColumnAutoIncrementInitialValueAdvisor) Check(_ context.Context, checkCtx
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for column auto increment initial value rule")
}
// Create the rule
- rule := NewColumnAutoIncrementInitialValueRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnAutoIncrementInitialValueRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_column_comment_convention.go b/backend/plugin/advisor/mysql/rule_column_comment_convention.go
index a5f9a7be49..6b028e6b01 100644
--- a/backend/plugin/advisor/mysql/rule_column_comment_convention.go
+++ b/backend/plugin/advisor/mysql/rule_column_comment_convention.go
@@ -40,13 +40,10 @@ func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
// Create the rule
- rule := NewColumnCommentConventionRule(level, checkCtx.Rule.Type.String(), payload)
+ rule := NewColumnCommentConventionRule(level, checkCtx.Rule.Type.String(), commentPayload)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
@@ -63,11 +60,11 @@ func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor
// ColumnCommentConventionRule checks for column comment convention.
type ColumnCommentConventionRule struct {
BaseRule
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
}
// NewColumnCommentConventionRule creates a new ColumnCommentConventionRule.
-func NewColumnCommentConventionRule(level storepb.Advice_Status, title string, payload *advisor.CommentConventionRulePayload) *ColumnCommentConventionRule {
+func NewColumnCommentConventionRule(level storepb.Advice_Status, title string, payload *storepb.SQLReviewRule_CommentConventionRulePayload) *ColumnCommentConventionRule {
return &ColumnCommentConventionRule{
BaseRule: BaseRule{
level: level,
@@ -192,7 +189,7 @@ func (r *ColumnCommentConventionRule) checkFieldDefinition(tableName, columnName
continue
}
comment = mysqlparser.NormalizeMySQLTextLiteral(attribute.TextLiteral())
- if r.payload.MaxLength >= 0 && len(comment) > r.payload.MaxLength {
+ if r.payload.MaxLength >= 0 && int32(len(comment)) > r.payload.MaxLength {
r.AddAdvice(&storepb.Advice{
Status: r.level,
Code: code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go b/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go
index 3789b646c3..3ecde628e4 100644
--- a/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go
+++ b/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -43,13 +45,13 @@ func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for column maximum character length rule")
}
// Create the rule
- rule := NewColumnMaximumCharacterLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnMaximumCharacterLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go b/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go
index ab0addca4f..0991a0a281 100644
--- a/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go
+++ b/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -42,13 +44,13 @@ func (*ColumnMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for column maximum varchar length rule")
}
// Create the rule
- rule := NewVarcharLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewVarcharLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_column_required.go b/backend/plugin/advisor/mysql/rule_column_required.go
index 6dadb2de84..38a9dd99d2 100644
--- a/backend/plugin/advisor/mysql/rule_column_required.go
+++ b/backend/plugin/advisor/mysql/rule_column_required.go
@@ -6,6 +6,8 @@ import (
"slices"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -44,12 +46,12 @@ func (*ColumnRequirementAdvisor) Check(_ context.Context, checkCtx advisor.Conte
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
requiredColumns := make(columnSet)
- for _, column := range columnList {
+ for _, column := range stringArrayPayload.List {
requiredColumns[column] = true
}
diff --git a/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go b/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go
index 88764348d3..6196258479 100644
--- a/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go
+++ b/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go
@@ -43,13 +43,10 @@ func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- paylaod, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
typeRestriction := make(map[string]bool)
- for _, tp := range paylaod.List {
+ for _, tp := range stringArrayPayload.List {
typeRestriction[strings.ToUpper(tp)] = true
}
diff --git a/backend/plugin/advisor/mysql/rule_function_disallowed_list.go b/backend/plugin/advisor/mysql/rule_function_disallowed_list.go
index 5c46ae79c9..c18b576f3e 100644
--- a/backend/plugin/advisor/mysql/rule_function_disallowed_list.go
+++ b/backend/plugin/advisor/mysql/rule_function_disallowed_list.go
@@ -40,13 +40,10 @@ func (*FunctionDisallowedListAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
var disallowList []string
- for _, fn := range payload.List {
+ for _, fn := range stringArrayPayload.List {
disallowList = append(disallowList, strings.ToUpper(fn))
}
diff --git a/backend/plugin/advisor/mysql/rule_index_key_number_limit.go b/backend/plugin/advisor/mysql/rule_index_key_number_limit.go
index e6f8bdf647..dbf2bbba4f 100644
--- a/backend/plugin/advisor/mysql/rule_index_key_number_limit.go
+++ b/backend/plugin/advisor/mysql/rule_index_key_number_limit.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -41,13 +43,13 @@ func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Con
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewIndexKeyNumberLimitRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewIndexKeyNumberLimitRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_index_primary_key_type_allowlist.go b/backend/plugin/advisor/mysql/rule_index_primary_key_type_allowlist.go
index 245c9d246c..2e2a5e4fae 100644
--- a/backend/plugin/advisor/mysql/rule_index_primary_key_type_allowlist.go
+++ b/backend/plugin/advisor/mysql/rule_index_primary_key_type_allowlist.go
@@ -43,12 +43,9 @@ func (*IndexPrimaryKeyTypeAllowlistAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
allowlist := make(map[string]bool)
- for _, tp := range payload.List {
+ for _, tp := range stringArrayPayload.List {
allowlist[strings.ToLower(tp)] = true
}
diff --git a/backend/plugin/advisor/mysql/rule_index_total_number_limit.go b/backend/plugin/advisor/mysql/rule_index_total_number_limit.go
index becb7f840b..3aca1f8555 100644
--- a/backend/plugin/advisor/mysql/rule_index_total_number_limit.go
+++ b/backend/plugin/advisor/mysql/rule_index_total_number_limit.go
@@ -5,6 +5,8 @@ import (
"fmt"
"slices"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -43,13 +45,13 @@ func (*IndexTotalNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.C
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewIndexTotalNumberLimitRule(level, checkCtx.Rule.Type.String(), payload.Number, checkCtx.FinalMetadata)
+ rule := NewIndexTotalNumberLimitRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number), checkCtx.FinalMetadata)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_index_type_allow_list.go b/backend/plugin/advisor/mysql/rule_index_type_allow_list.go
index 917ff66876..9ac553254a 100644
--- a/backend/plugin/advisor/mysql/rule_index_type_allow_list.go
+++ b/backend/plugin/advisor/mysql/rule_index_type_allow_list.go
@@ -40,13 +40,10 @@ func (*IndexTypeAllowListAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Create the rule
- rule := NewIndexTypeAllowListRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewIndexTypeAllowListRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_insert_row_limit.go b/backend/plugin/advisor/mysql/rule_insert_row_limit.go
index 492460f949..6913f24132 100644
--- a/backend/plugin/advisor/mysql/rule_insert_row_limit.go
+++ b/backend/plugin/advisor/mysql/rule_insert_row_limit.go
@@ -43,13 +43,13 @@ func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Contex
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewInsertRowLimitRule(ctx, level, checkCtx.Rule.Type.String(), payload.Number, checkCtx.Driver)
+ rule := NewInsertRowLimitRule(ctx, level, checkCtx.Rule.Type.String(), int(numberPayload.Number), checkCtx.Driver)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go b/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go
index a00e9e64ec..02bd73611f 100644
--- a/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go
+++ b/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go
@@ -7,6 +7,7 @@ import (
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -41,9 +42,19 @@ func (*NamingAutoIncrementColumnAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_naming_column.go b/backend/plugin/advisor/mysql/rule_naming_column.go
index 190064045c..46ecfc48f0 100644
--- a/backend/plugin/advisor/mysql/rule_naming_column.go
+++ b/backend/plugin/advisor/mysql/rule_naming_column.go
@@ -7,6 +7,7 @@ import (
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -38,9 +39,20 @@ func (*NamingColumnConventionAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for naming column rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go b/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go
index 18d58182c1..0a0f413f54 100644
--- a/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strings"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -42,9 +44,23 @@ func (*NamingFKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_naming_index_convention.go b/backend/plugin/advisor/mysql/rule_naming_index_convention.go
index b2d3209904..7af3ad6c3a 100644
--- a/backend/plugin/advisor/mysql/rule_naming_index_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_index_convention.go
@@ -7,6 +7,7 @@ import (
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -51,9 +52,23 @@ func (*NamingIndexConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_naming_table.go b/backend/plugin/advisor/mysql/rule_naming_table.go
index 07d326b499..3c24d7e266 100644
--- a/backend/plugin/advisor/mysql/rule_naming_table.go
+++ b/backend/plugin/advisor/mysql/rule_naming_table.go
@@ -42,9 +42,19 @@ func (*NamingTableConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for naming table rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go b/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go
index e9568acfaa..5bb19a9181 100644
--- a/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go
@@ -7,6 +7,7 @@ import (
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -43,9 +44,23 @@ func (*NamingUKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_online_migration.go b/backend/plugin/advisor/mysql/rule_online_migration.go
index 793196a569..30cce58c68 100644
--- a/backend/plugin/advisor/mysql/rule_online_migration.go
+++ b/backend/plugin/advisor/mysql/rule_online_migration.go
@@ -40,11 +40,11 @@ func (*OnlineMigrationAdvisor) Check(ctx context.Context, checkCtx advisor.Conte
return nil, errors.Errorf("failed to convert to StmtNode")
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- minRows := int64(payload.Number)
+ minRows := int64(int(numberPayload.Number))
level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
if err != nil {
diff --git a/backend/plugin/advisor/mysql/rule_statement_affected_row_limit.go b/backend/plugin/advisor/mysql/rule_statement_affected_row_limit.go
index 49ecfe75e8..dbaba52469 100644
--- a/backend/plugin/advisor/mysql/rule_statement_affected_row_limit.go
+++ b/backend/plugin/advisor/mysql/rule_statement_affected_row_limit.go
@@ -42,13 +42,13 @@ func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx adv
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewStatementAffectedRowLimitRule(ctx, level, checkCtx.Rule.Type.String(), payload.Number, checkCtx.Driver)
+ rule := NewStatementAffectedRowLimitRule(ctx, level, checkCtx.Rule.Type.String(), int(numberPayload.Number), checkCtx.Driver)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_statement_maximum_join_table_count.go b/backend/plugin/advisor/mysql/rule_statement_maximum_join_table_count.go
index 016e205f1f..76b83b8c1e 100644
--- a/backend/plugin/advisor/mysql/rule_statement_maximum_join_table_count.go
+++ b/backend/plugin/advisor/mysql/rule_statement_maximum_join_table_count.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -35,13 +37,13 @@ func (*StatementMaximumJoinTableCountAdvisor) Check(_ context.Context, checkCtx
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewStatementMaximumJoinTableCountRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewStatementMaximumJoinTableCountRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_statement_maximum_limit_value.go b/backend/plugin/advisor/mysql/rule_statement_maximum_limit_value.go
index 960ad05221..5e4f6cf7a0 100644
--- a/backend/plugin/advisor/mysql/rule_statement_maximum_limit_value.go
+++ b/backend/plugin/advisor/mysql/rule_statement_maximum_limit_value.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -39,13 +41,13 @@ func (*StatementMaximumLimitValueAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewStatementMaximumLimitValueRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewStatementMaximumLimitValueRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_statement_maximum_statements_in_transaction.go b/backend/plugin/advisor/mysql/rule_statement_maximum_statements_in_transaction.go
index 4a564c756c..505111660f 100644
--- a/backend/plugin/advisor/mysql/rule_statement_maximum_statements_in_transaction.go
+++ b/backend/plugin/advisor/mysql/rule_statement_maximum_statements_in_transaction.go
@@ -3,6 +3,8 @@ package mysql
import (
"context"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -32,13 +34,13 @@ func (*StatementMaximumStatementsInTransactionAdvisor) Check(_ context.Context,
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewStatementMaximumStatementsInTransactionRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewStatementMaximumStatementsInTransactionRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_statement_query_minimum_plan_level.go b/backend/plugin/advisor/mysql/rule_statement_query_minimum_plan_level.go
index dc06ee6404..a12be82cc4 100644
--- a/backend/plugin/advisor/mysql/rule_statement_query_minimum_plan_level.go
+++ b/backend/plugin/advisor/mysql/rule_statement_query_minimum_plan_level.go
@@ -40,13 +40,13 @@ func (*StatementQueryMinumumPlanLevelAdvisor) Check(ctx context.Context, checkCt
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringPayload := checkCtx.Rule.GetStringPayload()
+ if stringPayload == nil {
+ return nil, errors.New("string_payload is required for this rule")
}
// Create the rule
- rule := NewStatementQueryMinumumPlanLevelRule(ctx, level, checkCtx.Rule.Type.String(), checkCtx.Driver, convertExplainTypeFromString(strings.ToUpper(payload.String)))
+ rule := NewStatementQueryMinumumPlanLevelRule(ctx, level, checkCtx.Rule.Type.String(), checkCtx.Driver, convertExplainTypeFromString(strings.ToUpper(stringPayload.Value)))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_statement_where_maximum_logical_operator_count.go b/backend/plugin/advisor/mysql/rule_statement_where_maximum_logical_operator_count.go
index 6742e192d6..5228857b1b 100644
--- a/backend/plugin/advisor/mysql/rule_statement_where_maximum_logical_operator_count.go
+++ b/backend/plugin/advisor/mysql/rule_statement_where_maximum_logical_operator_count.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -35,15 +37,15 @@ func (*StatementWhereMaximumLogicalOperatorCountAdvisor) Check(_ context.Context
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
var allAdvice []*storepb.Advice
for _, stmt := range stmtList {
// Create the rule for each statement
- rule := NewStatementWhereMaximumLogicalOperatorCountRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewStatementWhereMaximumLogicalOperatorCountRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_table_comment_convention.go b/backend/plugin/advisor/mysql/rule_table_comment_convention.go
index f22dced7e2..9d236653aa 100644
--- a/backend/plugin/advisor/mysql/rule_table_comment_convention.go
+++ b/backend/plugin/advisor/mysql/rule_table_comment_convention.go
@@ -40,13 +40,10 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
// Create the rule
- rule := NewTableCommentConventionRule(level, checkCtx.Rule.Type.String(), payload)
+ rule := NewTableCommentConventionRule(level, checkCtx.Rule.Type.String(), commentPayload)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
@@ -63,11 +60,11 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
// TableCommentConventionRule checks for table comment convention.
type TableCommentConventionRule struct {
BaseRule
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
}
// NewTableCommentConventionRule creates a new TableCommentConventionRule.
-func NewTableCommentConventionRule(level storepb.Advice_Status, title string, payload *advisor.CommentConventionRulePayload) *TableCommentConventionRule {
+func NewTableCommentConventionRule(level storepb.Advice_Status, title string, payload *storepb.SQLReviewRule_CommentConventionRulePayload) *TableCommentConventionRule {
return &TableCommentConventionRule{
BaseRule: BaseRule{
level: level,
@@ -116,7 +113,7 @@ func (r *TableCommentConventionRule) checkCreateTable(ctx *mysql.CreateTableCont
StartPosition: common.ConvertANTLRLineToPosition(r.baseLine + ctx.GetStart().GetLine()),
})
}
- if r.payload.MaxLength >= 0 && len(comment) > r.payload.MaxLength {
+ if r.payload.MaxLength >= 0 && int32(len(comment)) > r.payload.MaxLength {
r.AddAdvice(&storepb.Advice{
Status: r.level,
Code: code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/mysql/rule_table_disallow_ddl.go b/backend/plugin/advisor/mysql/rule_table_disallow_ddl.go
index 421f4b33fa..7ab3e4703e 100644
--- a/backend/plugin/advisor/mysql/rule_table_disallow_ddl.go
+++ b/backend/plugin/advisor/mysql/rule_table_disallow_ddl.go
@@ -38,13 +38,10 @@ func (*TableDisallowDDLAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Create the rule
- rule := NewTableDisallowDDLRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewTableDisallowDDLRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_table_disallow_dml.go b/backend/plugin/advisor/mysql/rule_table_disallow_dml.go
index 305be2e059..e0cc9c7018 100644
--- a/backend/plugin/advisor/mysql/rule_table_disallow_dml.go
+++ b/backend/plugin/advisor/mysql/rule_table_disallow_dml.go
@@ -38,13 +38,10 @@ func (*TableDisallowDMLAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Create the rule
- rule := NewTableDisallowDMLRule(level, checkCtx.Rule.Type.String(), payload.List)
+ rule := NewTableDisallowDMLRule(level, checkCtx.Rule.Type.String(), stringArrayPayload.List)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go b/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go
index 05fc199453..2fe3a1f059 100644
--- a/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go
@@ -9,6 +9,7 @@ import (
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -41,9 +42,14 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
// Create the rule
diff --git a/backend/plugin/advisor/mysql/rule_table_limit_size.go b/backend/plugin/advisor/mysql/rule_table_limit_size.go
index 69e3a71e32..ab1497e522 100644
--- a/backend/plugin/advisor/mysql/rule_table_limit_size.go
+++ b/backend/plugin/advisor/mysql/rule_table_limit_size.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -30,9 +32,9 @@ var (
// If table size > xx bytes, then warning/error.
func (*MaximumTableSizeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
stmtList, err := getANTLRTree(checkCtx)
@@ -55,7 +57,7 @@ func (*MaximumTableSizeAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if statTypeChecker.IsDDL {
// Create the rule
- rule := NewTableLimitSizeRule(status, checkCtx.Rule.Type.String(), payload.Number, checkCtx.DBSchema)
+ rule := NewTableLimitSizeRule(status, checkCtx.Rule.Type.String(), int(numberPayload.Number), checkCtx.DBSchema)
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/mysql/rule_table_text_fields_total_length.go b/backend/plugin/advisor/mysql/rule_table_text_fields_total_length.go
index a188b26c0f..730819175d 100644
--- a/backend/plugin/advisor/mysql/rule_table_text_fields_total_length.go
+++ b/backend/plugin/advisor/mysql/rule_table_text_fields_total_length.go
@@ -7,6 +7,8 @@ import (
"strconv"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -42,13 +44,13 @@ func (*TableMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
// Create the rule
- rule := NewTableTextFieldsTotalLengthRule(level, checkCtx.Rule.Type.String(), checkCtx.FinalMetadata, payload.Number)
+ rule := NewTableTextFieldsTotalLengthRule(level, checkCtx.Rule.Type.String(), checkCtx.FinalMetadata, int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go b/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
index 8233384e09..ae4e1f7123 100644
--- a/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
+++ b/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
@@ -5,6 +5,8 @@ import (
"database/sql"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -40,15 +42,15 @@ func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Contex
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
checker := &insertRowLimitChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- maxRow: payload.Number,
+ maxRow: int(numberPayload.Number),
driver: checkCtx.Driver,
ctx: ctx,
}
diff --git a/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go b/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go
index 8f0f4290fa..99665b3318 100644
--- a/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go
+++ b/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go
@@ -5,6 +5,8 @@ import (
"database/sql"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
"github.com/bytebase/parser/mysql"
@@ -40,14 +42,14 @@ func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx adv
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
checker := &statementAffectedRowLimitChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- maxRow: payload.Number,
+ maxRow: int(numberPayload.Number),
driver: checkCtx.Driver,
ctx: ctx,
}
diff --git a/backend/plugin/advisor/oracle/rule_column_comment_convention.go b/backend/plugin/advisor/oracle/rule_column_comment_convention.go
index 281df00662..182b660169 100644
--- a/backend/plugin/advisor/oracle/rule_column_comment_convention.go
+++ b/backend/plugin/advisor/oracle/rule_column_comment_convention.go
@@ -38,12 +38,9 @@ func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
- rule := NewColumnCommentConventionRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, payload)
+ rule := NewColumnCommentConventionRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, commentPayload)
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
@@ -60,7 +57,7 @@ type ColumnCommentConventionRule struct {
BaseRule
currentDatabase string
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
tableName string
columnNames []string
@@ -69,7 +66,7 @@ type ColumnCommentConventionRule struct {
}
// NewColumnCommentConventionRule creates a new ColumnCommentConventionRule.
-func NewColumnCommentConventionRule(level storepb.Advice_Status, title string, currentDatabase string, payload *advisor.CommentConventionRulePayload) *ColumnCommentConventionRule {
+func NewColumnCommentConventionRule(level storepb.Advice_Status, title string, currentDatabase string, payload *storepb.SQLReviewRule_CommentConventionRulePayload) *ColumnCommentConventionRule {
return &ColumnCommentConventionRule{
BaseRule: NewBaseRule(level, title, 0),
currentDatabase: currentDatabase,
@@ -166,7 +163,7 @@ func (r *ColumnCommentConventionRule) GetAdviceList() ([]*storepb.Advice, error)
)
}
} else {
- if r.payload.MaxLength > 0 && len(comment) > r.payload.MaxLength {
+ if r.payload.MaxLength > 0 && int32(len(comment)) > r.payload.MaxLength {
r.AddAdvice(
r.level,
code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/oracle/rule_column_maximum_character_length.go b/backend/plugin/advisor/oracle/rule_column_maximum_character_length.go
index 374d22407d..e9d6e085c0 100644
--- a/backend/plugin/advisor/oracle/rule_column_maximum_character_length.go
+++ b/backend/plugin/advisor/oracle/rule_column_maximum_character_length.go
@@ -6,6 +6,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -40,16 +42,16 @@ func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
- rule := NewColumnMaximumCharacterLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnMaximumCharacterLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_column_maximum_varchar_length.go b/backend/plugin/advisor/oracle/rule_column_maximum_varchar_length.go
index 693dfe6638..b84d3c49d6 100644
--- a/backend/plugin/advisor/oracle/rule_column_maximum_varchar_length.go
+++ b/backend/plugin/advisor/oracle/rule_column_maximum_varchar_length.go
@@ -6,6 +6,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -40,16 +42,16 @@ func (*ColumnMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
- rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_column_require.go b/backend/plugin/advisor/oracle/rule_column_require.go
index a0b1d7541e..7c24d1e035 100644
--- a/backend/plugin/advisor/oracle/rule_column_require.go
+++ b/backend/plugin/advisor/oracle/rule_column_require.go
@@ -7,6 +7,8 @@ import (
"slices"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -41,12 +43,12 @@ func (*ColumnRequireAdvisor) Check(_ context.Context, checkCtx advisor.Context)
if err != nil {
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
- rule := NewColumnRequireRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, columnList)
+ rule := NewColumnRequireRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, stringArrayPayload.List)
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_column_type_disallow_list.go b/backend/plugin/advisor/oracle/rule_column_type_disallow_list.go
index d5311ac994..c7835c49d6 100644
--- a/backend/plugin/advisor/oracle/rule_column_type_disallow_list.go
+++ b/backend/plugin/advisor/oracle/rule_column_type_disallow_list.go
@@ -41,12 +41,9 @@ func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
- rule := NewColumnTypeDisallowListRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, payload.List)
+ rule := NewColumnTypeDisallowListRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, stringArrayPayload.List)
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_index_key_number_limit.go b/backend/plugin/advisor/oracle/rule_index_key_number_limit.go
index a951e1a88a..9d938d1908 100644
--- a/backend/plugin/advisor/oracle/rule_index_key_number_limit.go
+++ b/backend/plugin/advisor/oracle/rule_index_key_number_limit.go
@@ -5,6 +5,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -39,16 +41,16 @@ func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Con
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
- rule := NewIndexKeyNumberLimitRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, payload.Number)
+ rule := NewIndexKeyNumberLimitRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, int(numberPayload.Number))
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_naming_identifier_case.go b/backend/plugin/advisor/oracle/rule_naming_identifier_case.go
index 59435ad906..c9a0ee3a91 100644
--- a/backend/plugin/advisor/oracle/rule_naming_identifier_case.go
+++ b/backend/plugin/advisor/oracle/rule_naming_identifier_case.go
@@ -39,12 +39,9 @@ func (*NamingIdentifierCaseAdvisor) Check(_ context.Context, checkCtx advisor.Co
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNamingCaseRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ namingCasePayload := checkCtx.Rule.GetNamingCasePayload()
- rule := NewNamingIdentifierCaseRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, payload.Upper)
+ rule := NewNamingIdentifierCaseRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, namingCasePayload.Upper)
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
diff --git a/backend/plugin/advisor/oracle/rule_naming_table.go b/backend/plugin/advisor/oracle/rule_naming_table.go
index a5ce3a07ef..067e3be90a 100644
--- a/backend/plugin/advisor/oracle/rule_naming_table.go
+++ b/backend/plugin/advisor/oracle/rule_naming_table.go
@@ -8,6 +8,7 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/plsql"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -39,9 +40,19 @@ func (*NamingTableAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := NewNamingTableRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, format, maxLength)
diff --git a/backend/plugin/advisor/oracle/rule_table_comment_convention.go b/backend/plugin/advisor/oracle/rule_table_comment_convention.go
index 76ebf5da36..f474faece4 100644
--- a/backend/plugin/advisor/oracle/rule_table_comment_convention.go
+++ b/backend/plugin/advisor/oracle/rule_table_comment_convention.go
@@ -38,12 +38,9 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
- rule := NewTableCommentConventionRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, payload)
+ rule := NewTableCommentConventionRule(level, checkCtx.Rule.Type.String(), checkCtx.CurrentDatabase, commentPayload)
checker := NewGenericChecker([]Rule{rule})
for _, stmtNode := range stmtList {
@@ -60,7 +57,7 @@ type TableCommentConventionRule struct {
BaseRule
currentDatabase string
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
tableNames []string
tableComment map[string]string
@@ -68,7 +65,7 @@ type TableCommentConventionRule struct {
}
// NewTableCommentConventionRule creates a new TableCommentConventionRule.
-func NewTableCommentConventionRule(level storepb.Advice_Status, title string, currentDatabase string, payload *advisor.CommentConventionRulePayload) *TableCommentConventionRule {
+func NewTableCommentConventionRule(level storepb.Advice_Status, title string, currentDatabase string, payload *storepb.SQLReviewRule_CommentConventionRulePayload) *TableCommentConventionRule {
return &TableCommentConventionRule{
BaseRule: NewBaseRule(level, title, 0),
currentDatabase: currentDatabase,
@@ -135,7 +132,7 @@ func (r *TableCommentConventionRule) GetAdviceList() ([]*storepb.Advice, error)
)
}
} else {
- if r.payload.MaxLength > 0 && len(comment) > r.payload.MaxLength {
+ if r.payload.MaxLength > 0 && int32(len(comment)) > r.payload.MaxLength {
r.AddAdvice(
r.level,
code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/pg/advisor_collation_allowlist.go b/backend/plugin/advisor/pg/advisor_collation_allowlist.go
index 1260d7f434..5c4e67bd5a 100644
--- a/backend/plugin/advisor/pg/advisor_collation_allowlist.go
+++ b/backend/plugin/advisor/pg/advisor_collation_allowlist.go
@@ -36,13 +36,10 @@ func (*CollationAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Cont
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
allowlist := make(map[string]bool)
- for _, collation := range payload.List {
+ for _, collation := range stringArrayPayload.List {
allowlist[collation] = true
}
diff --git a/backend/plugin/advisor/pg/advisor_column_comment_convention.go b/backend/plugin/advisor/pg/advisor_column_comment_convention.go
index 06a793b839..3e06784681 100644
--- a/backend/plugin/advisor/pg/advisor_column_comment_convention.go
+++ b/backend/plugin/advisor/pg/advisor_column_comment_convention.go
@@ -36,15 +36,12 @@ func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
rule := &columnCommentConventionRule{
level: level,
title: checkCtx.Rule.Type.String(),
- payload: payload,
+ payload: commentPayload,
}
checker := NewGenericChecker([]Rule{rule})
@@ -79,7 +76,7 @@ type columnCommentConventionRule struct {
level storepb.Advice_Status
title string
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
columns []columnInfo
comments []commentInfo
@@ -243,7 +240,7 @@ func (r *columnCommentConventionRule) generateAdvice() []*storepb.Advice {
comment := matchedComment.comment
// Check max length
- if r.payload.MaxLength > 0 && len(comment) > r.payload.MaxLength {
+ if r.payload.MaxLength > 0 && int32(len(comment)) > r.payload.MaxLength {
adviceList = append(adviceList, &storepb.Advice{
Status: r.level,
Code: code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go b/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go
index 21125a4d87..0dbdd2b235 100644
--- a/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go
+++ b/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -38,12 +40,12 @@ func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
@@ -52,7 +54,7 @@ func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx ad
level: level,
title: checkCtx.Rule.Type.String(),
},
- maximum: payload.Number,
+ maximum: int(numberPayload.Number),
}
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/pg/advisor_column_required.go b/backend/plugin/advisor/pg/advisor_column_required.go
index 9495ba61d8..a83d721169 100644
--- a/backend/plugin/advisor/pg/advisor_column_required.go
+++ b/backend/plugin/advisor/pg/advisor_column_required.go
@@ -6,6 +6,8 @@ import (
"slices"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -43,14 +45,14 @@ func (*ColumnRequirementAdvisor) Check(_ context.Context, checkCtx advisor.Conte
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
// Convert to map for O(1) lookup
requiredColumnsMap := make(columnSet)
- for _, col := range columnList {
+ for _, col := range stringArrayPayload.List {
requiredColumnsMap[col] = true
}
diff --git a/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go b/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go
index 958faaa436..a78ab596d8 100644
--- a/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go
+++ b/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go
@@ -40,14 +40,11 @@ func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Convert disallowed types to lowercase for case-insensitive comparison
typeRestriction := make(map[string]bool)
- for _, tp := range payload.List {
+ for _, tp := range stringArrayPayload.List {
typeRestriction[strings.ToLower(tp)] = true
}
diff --git a/backend/plugin/advisor/pg/advisor_comment_convention.go b/backend/plugin/advisor/pg/advisor_comment_convention.go
index e01dbddd22..9f80c1654a 100644
--- a/backend/plugin/advisor/pg/advisor_comment_convention.go
+++ b/backend/plugin/advisor/pg/advisor_comment_convention.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
@@ -37,9 +39,9 @@ func (*CommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Conte
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &commentConventionRule{
@@ -47,7 +49,7 @@ func (*CommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Conte
level: level,
title: checkCtx.Rule.Type.String(),
},
- maxLength: payload.Number,
+ maxLength: int(numberPayload.Number),
}
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/pg/advisor_encoding_allowlist.go b/backend/plugin/advisor/pg/advisor_encoding_allowlist.go
index fdc1d5b5ed..da3bec7585 100644
--- a/backend/plugin/advisor/pg/advisor_encoding_allowlist.go
+++ b/backend/plugin/advisor/pg/advisor_encoding_allowlist.go
@@ -38,14 +38,11 @@ func (*EncodingAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Conte
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
// Convert allowlist to lowercase for case-insensitive comparison
allowlist := make(map[string]bool)
- for _, encoding := range payload.List {
+ for _, encoding := range stringArrayPayload.List {
allowlist[strings.ToLower(encoding)] = true
}
diff --git a/backend/plugin/advisor/pg/advisor_index_key_number_limit.go b/backend/plugin/advisor/pg/advisor_index_key_number_limit.go
index bf6713071f..6981db91b6 100644
--- a/backend/plugin/advisor/pg/advisor_index_key_number_limit.go
+++ b/backend/plugin/advisor/pg/advisor_index_key_number_limit.go
@@ -4,6 +4,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -39,9 +41,9 @@ func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Con
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &indexKeyNumberLimitRule{
@@ -49,7 +51,7 @@ func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Con
level: level,
title: checkCtx.Rule.Type.String(),
},
- max: payload.Number,
+ max: int(numberPayload.Number),
}
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go b/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go
index 226cc89825..eb740bf4c6 100644
--- a/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go
+++ b/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go
@@ -39,14 +39,11 @@ func (*IndexPrimaryKeyTypeAllowlistAdvisor) Check(_ context.Context, checkCtx ad
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
rule := &indexPrimaryKeyTypeAllowlistRule{
BaseRule: BaseRule{level: level, title: checkCtx.Rule.Type.String()},
- allowlist: payload.List,
+ allowlist: stringArrayPayload.List,
}
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/pg/advisor_index_total_number_limit.go b/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
index 67b1f8f8f9..e27023201c 100644
--- a/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
+++ b/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
@@ -5,6 +5,8 @@ import (
"fmt"
"slices"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -39,14 +41,14 @@ func (*IndexTotalNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.C
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &indexTotalNumberLimitRule{
BaseRule: BaseRule{level: level, title: checkCtx.Rule.Type.String()},
- max: payload.Number,
+ max: int(numberPayload.Number),
finalMetadata: checkCtx.FinalMetadata,
tableLine: make(tableLineMap),
}
diff --git a/backend/plugin/advisor/pg/advisor_insert_row_limit.go b/backend/plugin/advisor/pg/advisor_insert_row_limit.go
index fb9cc767d1..20ea107038 100644
--- a/backend/plugin/advisor/pg/advisor_insert_row_limit.go
+++ b/backend/plugin/advisor/pg/advisor_insert_row_limit.go
@@ -41,9 +41,9 @@ func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &insertRowLimitRule{
@@ -51,14 +51,14 @@ func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Contex
level: level,
title: checkCtx.Rule.Type.String(),
},
- maxRow: payload.Number,
+ maxRow: int(numberPayload.Number),
driver: checkCtx.Driver,
ctx: ctx,
statementsText: checkCtx.Statements,
UsePostgresDatabaseOwner: checkCtx.UsePostgresDatabaseOwner,
}
- if payload.Number > 0 {
+ if int(numberPayload.Number) > 0 {
checker := NewGenericChecker([]Rule{rule})
for _, parseResult := range parseResults {
diff --git a/backend/plugin/advisor/pg/advisor_naming_column.go b/backend/plugin/advisor/pg/advisor_naming_column.go
index fd793c3926..694885c2dd 100644
--- a/backend/plugin/advisor/pg/advisor_naming_column.go
+++ b/backend/plugin/advisor/pg/advisor_naming_column.go
@@ -5,6 +5,8 @@ import (
"fmt"
"regexp"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
@@ -39,9 +41,19 @@ func (*NamingColumnConventionAdvisor) Check(_ context.Context, checkCtx advisor.
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingColumnConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go
index a06804c79a..b5bcfd9cff 100644
--- a/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go
+++ b/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go
@@ -6,6 +6,8 @@ import (
"regexp"
"strings"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
@@ -40,9 +42,23 @@ func (*NamingFKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingFKConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_naming_index_convention.go b/backend/plugin/advisor/pg/advisor_naming_index_convention.go
index 02b27928e6..61115bac34 100644
--- a/backend/plugin/advisor/pg/advisor_naming_index_convention.go
+++ b/backend/plugin/advisor/pg/advisor_naming_index_convention.go
@@ -6,8 +6,8 @@ import (
"strings"
"github.com/antlr4-go/antlr/v4"
-
parser "github.com/bytebase/parser/postgresql"
+ "github.com/pkg/errors"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
@@ -40,9 +40,23 @@ func (*NamingIndexConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingIndexConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go
index 329b2eba9a..d854ade9c4 100644
--- a/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go
+++ b/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go
@@ -6,8 +6,8 @@ import (
"strings"
"github.com/antlr4-go/antlr/v4"
-
parser "github.com/bytebase/parser/postgresql"
+ "github.com/pkg/errors"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
@@ -40,9 +40,23 @@ func (*NamingPKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingPKConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_naming_table.go b/backend/plugin/advisor/pg/advisor_naming_table.go
index ee6215097f..a3bf7aa258 100644
--- a/backend/plugin/advisor/pg/advisor_naming_table.go
+++ b/backend/plugin/advisor/pg/advisor_naming_table.go
@@ -6,6 +6,7 @@ import (
"regexp"
"github.com/antlr4-go/antlr/v4"
+ "github.com/pkg/errors"
parser "github.com/bytebase/parser/postgresql"
@@ -39,9 +40,19 @@ func (*NamingTableConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for naming table rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingTableConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go
index 1c2e8630b5..e94e95ee01 100644
--- a/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go
+++ b/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go
@@ -8,6 +8,7 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
+ "github.com/pkg/errors"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
@@ -40,9 +41,23 @@ func (*NamingUKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingUKConventionRule{
diff --git a/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go b/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go
index 00ce4a488c..8d79c1d6ac 100644
--- a/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go
+++ b/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go
@@ -5,6 +5,8 @@ import (
"database/sql"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
@@ -39,9 +41,9 @@ func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx adv
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &statementAffectedRowLimitRule{
@@ -49,14 +51,14 @@ func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx adv
level: level,
title: checkCtx.Rule.Type.String(),
},
- maxRow: payload.Number,
+ maxRow: int(numberPayload.Number),
ctx: ctx,
driver: checkCtx.Driver,
usePostgresDatabaseOwner: checkCtx.UsePostgresDatabaseOwner,
statementsText: checkCtx.Statements,
}
- if payload.Number > 0 && checkCtx.Driver != nil {
+ if int(numberPayload.Number) > 0 && checkCtx.Driver != nil {
checker := NewGenericChecker([]Rule{rule})
for _, parseResult := range parseResults {
diff --git a/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go b/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go
index 5adaa6d44c..4da2dc3c75 100644
--- a/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go
+++ b/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go
@@ -6,6 +6,8 @@ import (
"strconv"
"strings"
+ "github.com/pkg/errors"
+
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
@@ -37,9 +39,9 @@ func (*StatementMaximumLimitValueAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
rule := &statementMaximumLimitValueRule{
@@ -47,7 +49,7 @@ func (*StatementMaximumLimitValueAdvisor) Check(_ context.Context, checkCtx advi
level: level,
title: checkCtx.Rule.Type.String(),
},
- limitMaxValue: payload.Number,
+ limitMaxValue: int(numberPayload.Number),
}
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/pg/advisor_table_comment_convention.go b/backend/plugin/advisor/pg/advisor_table_comment_convention.go
index d1b304d73d..4d691e3683 100644
--- a/backend/plugin/advisor/pg/advisor_table_comment_convention.go
+++ b/backend/plugin/advisor/pg/advisor_table_comment_convention.go
@@ -37,17 +37,14 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
rule := &tableCommentConventionRule{
BaseRule: BaseRule{
level: level,
title: checkCtx.Rule.Type.String(),
},
- payload: payload,
+ payload: commentPayload,
statementsText: checkCtx.Statements,
createdTables: make(map[string]*tableInfo),
tableComments: make(map[string]*tableCommentInfo),
@@ -80,7 +77,7 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
}
} else {
comment := tableCommentInfo.comment
- if rule.payload.MaxLength > 0 && len(comment) > rule.payload.MaxLength {
+ if rule.payload.MaxLength > 0 && int32(len(comment)) > rule.payload.MaxLength {
rule.AddAdvice(&storepb.Advice{
Status: rule.level,
Code: code.CommentTooLong.Int32(),
@@ -113,7 +110,7 @@ type tableCommentInfo struct {
type tableCommentConventionRule struct {
BaseRule
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
statementsText string
createdTables map[string]*tableInfo
diff --git a/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go b/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go
index 1801ccce8a..4366de441e 100644
--- a/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go
@@ -5,6 +5,8 @@ import (
"fmt"
"regexp"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -40,9 +42,14 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
rule := &tableDropNamingConventionRule{
diff --git a/backend/plugin/advisor/pg/test_helper.go b/backend/plugin/advisor/pg/test_helper.go
index e7f0d58805..e9f20105e8 100644
--- a/backend/plugin/advisor/pg/test_helper.go
+++ b/backend/plugin/advisor/pg/test_helper.go
@@ -76,12 +76,13 @@ func RunPGSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbTyp
require.True(t, ok, "failed to clone schema metadata")
finalMetadata := model.NewDatabaseMetadata(finalCatalogClone, nil, nil, storepb.Engine_POSTGRES, true /* isCaseSensitive for PostgreSQL */)
- // Get default payload, or use empty string for test-only rules
- payload, err := advisor.SetDefaultSQLReviewRulePayload(rule, dbType)
- if err != nil {
- // For test-only rules (like "hello-world"), use empty payload
- payload = ""
+ // Create rule and set default payload (if applicable)
+ sqlRule := &storepb.SQLReviewRule{
+ Type: rule,
+ Level: storepb.SQLReviewRule_WARNING,
}
+ // Try to set default payload, ignore error for test-only rules
+ _ = advisor.SetDefaultSQLReviewRulePayload(sqlRule, dbType)
// Parse SQL using base.Parse() to get AST
unifiedASTs, err := base.Parse(dbType, tc.Statement)
@@ -100,13 +101,7 @@ func RunPGSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbTyp
advice := schema.WalkThrough(dbType, finalMetadata, unifiedASTs)
require.Nil(t, advice, "Failed to walk through final catalog: %s", tc.Statement)
- ruleList := []*storepb.SQLReviewRule{
- {
- Type: rule,
- Level: storepb.SQLReviewRule_WARNING,
- Payload: payload,
- },
- }
+ ruleList := []*storepb.SQLReviewRule{sqlRule}
// Call the advisor directly with ANTLR AST
adviceList, err := advisor.Check(
diff --git a/backend/plugin/advisor/redshift/advisor_table_drop_naming_convention.go b/backend/plugin/advisor/redshift/advisor_table_drop_naming_convention.go
index 23359e4c11..607e9ba82e 100644
--- a/backend/plugin/advisor/redshift/advisor_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/redshift/advisor_table_drop_naming_convention.go
@@ -9,6 +9,7 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/redshift"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -39,9 +40,14 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
listener := &tableDropNamingConventionListener{
diff --git a/backend/plugin/advisor/snowflake/rule_column_maximum_varchar_length.go b/backend/plugin/advisor/snowflake/rule_column_maximum_varchar_length.go
index 59a6701e9e..9bf76f2243 100644
--- a/backend/plugin/advisor/snowflake/rule_column_maximum_varchar_length.go
+++ b/backend/plugin/advisor/snowflake/rule_column_maximum_varchar_length.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strconv"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -44,17 +46,17 @@ func (*ColumnMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for this rule")
}
- if payload.Number <= 0 {
+ if int(numberPayload.Number) <= 0 {
return nil, nil
}
// Create the rule
- rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), payload.Number)
+ rule := NewColumnMaximumVarcharLengthRule(level, checkCtx.Rule.Type.String(), int(numberPayload.Number))
// Create the generic checker with the rule
checker := NewGenericChecker([]Rule{rule})
diff --git a/backend/plugin/advisor/snowflake/rule_column_require.go b/backend/plugin/advisor/snowflake/rule_column_require.go
index bad284c958..db889ea761 100644
--- a/backend/plugin/advisor/snowflake/rule_column_require.go
+++ b/backend/plugin/advisor/snowflake/rule_column_require.go
@@ -6,6 +6,8 @@ import (
"fmt"
"slices"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/antlr4-go/antlr/v4"
@@ -40,13 +42,13 @@ func (*ColumnRequireAdvisor) Check(_ context.Context, checkCtx advisor.Context)
if err != nil {
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
requireColumns := make(map[string]any)
- for _, column := range columnList {
+ for _, column := range stringArrayPayload.List {
requireColumns[column] = true
}
diff --git a/backend/plugin/advisor/snowflake/rule_naming_table.go b/backend/plugin/advisor/snowflake/rule_naming_table.go
index 54428466b4..d74f5ef9be 100644
--- a/backend/plugin/advisor/snowflake/rule_naming_table.go
+++ b/backend/plugin/advisor/snowflake/rule_naming_table.go
@@ -10,6 +10,7 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/snowflake"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -40,9 +41,19 @@ func (*NamingTableAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
rule := NewNamingTableRule(level, checkCtx.Rule.Type.String(), format, maxLength)
diff --git a/backend/plugin/advisor/snowflake/rule_table_drop_naming_convention.go b/backend/plugin/advisor/snowflake/rule_table_drop_naming_convention.go
index 7e1e98b9a0..43d4680e69 100644
--- a/backend/plugin/advisor/snowflake/rule_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/snowflake/rule_table_drop_naming_convention.go
@@ -6,14 +6,14 @@ import (
"fmt"
"regexp"
- "github.com/bytebase/bytebase/backend/plugin/advisor/code"
-
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/snowflake"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
snowsqlparser "github.com/bytebase/bytebase/backend/plugin/parser/snowflake"
)
@@ -41,9 +41,14 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
rule := NewTableDropNamingConventionRule(level, checkCtx.Rule.Type.String(), format)
diff --git a/backend/plugin/advisor/sql_review.go b/backend/plugin/advisor/sql_review.go
index af3cc78205..dc2340f263 100644
--- a/backend/plugin/advisor/sql_review.go
+++ b/backend/plugin/advisor/sql_review.go
@@ -2,7 +2,6 @@ package advisor
import (
"context"
- "encoding/json"
"regexp"
"github.com/pkg/errors"
@@ -38,11 +37,11 @@ const (
// ReferencedColumnNameTemplateToken is the token for referenced column name.
ReferencedColumnNameTemplateToken = "{{referenced_column}}"
- // defaultNameLengthLimit is the default length limit for naming rules.
+ // DefaultNameLengthLimit is the default length limit for naming rules.
// PostgreSQL has it's own naming length limit, will auto slice the name to make sure its length <= 63
// https://www.postgresql.org/docs/current/limits.html.
// While MySQL does not enforce the limit, thus we use PostgreSQL's 63 as the default limit.
- defaultNameLengthLimit = 63
+ DefaultNameLengthLimit = 63
)
var (
@@ -69,98 +68,12 @@ var (
}
)
-// NamingRulePayload is the payload for naming rule.
-type NamingRulePayload struct {
- MaxLength int `json:"maxLength"`
- Format string `json:"format"`
-}
-
-// StringArrayTypeRulePayload is the payload for rules with string array value.
-type StringArrayTypeRulePayload struct {
- List []string `json:"list"`
-}
-
-// RequiredColumnRulePayload is the payload for required column rule.
-type RequiredColumnRulePayload struct {
- ColumnList []string `json:"columnList"`
-}
-
-// CommentConventionRulePayload is the payload for comment convention rule.
-type CommentConventionRulePayload struct {
- Required bool `json:"required"`
- MaxLength int `json:"maxLength"`
-}
-
-// NumberTypeRulePayload is the number type payload.
-type NumberTypeRulePayload struct {
- Number int `json:"number"`
-}
-
-// StringTypeRulePayload is the string type payload.
-type StringTypeRulePayload struct {
- String string `json:"string"`
-}
-
-// NamingCaseRulePayload is the payload for naming case rule.
-type NamingCaseRulePayload struct {
- // Upper is true means the case should be upper case, otherwise lower case.
- Upper bool `json:"upper"`
-}
-
-// UnmarshalNamingRulePayloadAsRegexp will unmarshal payload to NamingRulePayload and compile it as regular expression.
-func UnmarshalNamingRulePayloadAsRegexp(payload string) (*regexp.Regexp, int, error) {
- var nr NamingRulePayload
- if err := json.Unmarshal([]byte(payload), &nr); err != nil {
- return nil, 0, errors.Wrapf(err, "failed to unmarshal naming rule payload %q", payload)
- }
-
- format, err := regexp.Compile(nr.Format)
- if err != nil {
- return nil, 0, errors.Wrapf(err, "failed to compile regular expression \"%s\"", nr.Format)
- }
-
- // We need to be compatible with existed naming rules in the database. 0 means using the default length limit.
- maxLength := nr.MaxLength
- if maxLength == 0 {
- maxLength = defaultNameLengthLimit
- }
-
- return format, maxLength, nil
-}
-
-// UnmarshalNamingRulePayloadAsTemplate will unmarshal payload to NamingRulePayload and extract all the template keys.
-// For example, "hard_code_{{table}}_{{column}}_end" will return
-// "hard_code_{{table}}_{{column}}_end", ["{{table}}", "{{column}}"].
-func UnmarshalNamingRulePayloadAsTemplate(ruleType storepb.SQLReviewRule_Type, payload string) (string, []string, int, error) {
- var nr NamingRulePayload
- if err := json.Unmarshal([]byte(payload), &nr); err != nil {
- return "", nil, 0, errors.Wrapf(err, "failed to unmarshal naming rule payload %q", payload)
- }
-
- template := nr.Format
- keys, _ := parseTemplateTokens(template)
-
- for _, key := range keys {
- if _, ok := TemplateNamingTokens[ruleType][key]; !ok {
- return "", nil, 0, errors.Errorf("invalid template %s for rule %s", key, ruleType)
- }
- }
-
- // We need to be compatible with existed naming rules in the database. 0 means using the default length limit.
- maxLength := nr.MaxLength
- if maxLength == 0 {
- maxLength = defaultNameLengthLimit
- }
-
- return template, keys, maxLength, nil
-}
-
-// parseTemplateTokens parses the template and returns template tokens and their delimiters.
+// ParseTemplateTokens parses the template and returns template tokens and their delimiters.
// For example, if the template is "{{DB_NAME}}_hello_{{LOCATION}}", then the tokens will be ["{{DB_NAME}}", "{{LOCATION}}"],
// and the delimiters will be ["_hello_"].
// The caller will usually replace the tokens with a normal string, or a regexp. In the latter case, it will be a problem
// if there are special regexp characters such as "$" in the delimiters. The caller should escape the delimiters in such cases.
-func parseTemplateTokens(template string) ([]string, []string) {
+func ParseTemplateTokens(template string) ([]string, []string) {
r := regexp.MustCompile(`{{[^{}]+}}`)
tokens := r.FindAllString(template, -1)
if len(tokens) > 0 {
@@ -176,83 +89,6 @@ func parseTemplateTokens(template string) ([]string, []string) {
return nil, nil
}
-// UnmarshalRequiredColumnList will unmarshal payload and parse the required column list.
-func UnmarshalRequiredColumnList(payload string) ([]string, error) {
- stringArrayRulePayload, err := UnmarshalStringArrayTypeRulePayload(payload)
- if err != nil {
- return nil, err
- }
- if len(stringArrayRulePayload.List) != 0 {
- return stringArrayRulePayload.List, nil
- }
-
- // The RequiredColumnRulePayload is deprecated.
- // Just keep it to compatible with old data, and we can remove this later.
- columnRulePayload, err := unmarshalRequiredColumnRulePayload(payload)
- if err != nil {
- return nil, err
- }
-
- return columnRulePayload.ColumnList, nil
-}
-
-// unmarshalRequiredColumnRulePayload will unmarshal payload to RequiredColumnRulePayload.
-func unmarshalRequiredColumnRulePayload(payload string) (*RequiredColumnRulePayload, error) {
- var rcr RequiredColumnRulePayload
- if err := json.Unmarshal([]byte(payload), &rcr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal required column rule payload %q", payload)
- }
- if len(rcr.ColumnList) == 0 {
- return nil, errors.Errorf("invalid required column rule payload, column list cannot be empty")
- }
- return &rcr, nil
-}
-
-// UnmarshalCommentConventionRulePayload will unmarshal payload to CommentConventionRulePayload.
-func UnmarshalCommentConventionRulePayload(payload string) (*CommentConventionRulePayload, error) {
- var ccr CommentConventionRulePayload
- if err := json.Unmarshal([]byte(payload), &ccr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal comment convention rule payload %q", payload)
- }
- return &ccr, nil
-}
-
-// UnmarshalNumberTypeRulePayload will unmarshal payload to NumberTypeRulePayload.
-func UnmarshalNumberTypeRulePayload(payload string) (*NumberTypeRulePayload, error) {
- var nlr NumberTypeRulePayload
- if err := json.Unmarshal([]byte(payload), &nlr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal number type rule payload %q", payload)
- }
- return &nlr, nil
-}
-
-// UnmarshalStringTypeRulePayload will unmarshal payload to StringTypeRulePayload.
-func UnmarshalStringTypeRulePayload(payload string) (*StringTypeRulePayload, error) {
- var slr StringTypeRulePayload
- if err := json.Unmarshal([]byte(payload), &slr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal string type rule payload %q", payload)
- }
- return &slr, nil
-}
-
-// UnmarshalStringArrayTypeRulePayload will unmarshal payload to StringArrayTypeRulePayload.
-func UnmarshalStringArrayTypeRulePayload(payload string) (*StringArrayTypeRulePayload, error) {
- var trr StringArrayTypeRulePayload
- if err := json.Unmarshal([]byte(payload), &trr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal string array rule payload %q", payload)
- }
- return &trr, nil
-}
-
-// UnmarshalNamingCaseRulePayload will unmarshal payload to NamingCaseRulePayload.
-func UnmarshalNamingCaseRulePayload(payload string) (*NamingCaseRulePayload, error) {
- var ncr NamingCaseRulePayload
- if err := json.Unmarshal([]byte(payload), &ncr); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal naming case rule payload %q", payload)
- }
- return &ncr, nil
-}
-
// SQLReviewCheck checks the statements with sql review rules.
func SQLReviewCheck(
ctx context.Context,
diff --git a/backend/plugin/advisor/tidb/advisor_charset_allowlist.go b/backend/plugin/advisor/tidb/advisor_charset_allowlist.go
index 87042912ac..e67c7bc4af 100644
--- a/backend/plugin/advisor/tidb/advisor_charset_allowlist.go
+++ b/backend/plugin/advisor/tidb/advisor_charset_allowlist.go
@@ -39,16 +39,13 @@ func (*CharsetAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Contex
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
checker := &charsetAllowlistChecker{
level: level,
title: checkCtx.Rule.Type.String(),
allowlist: make(map[string]bool),
}
- for _, charset := range payload.List {
+ for _, charset := range stringArrayPayload.List {
checker.allowlist[strings.ToLower(charset)] = true
}
diff --git a/backend/plugin/advisor/tidb/advisor_collation_allowlist.go b/backend/plugin/advisor/tidb/advisor_collation_allowlist.go
index 1288d416f8..d0128e5230 100644
--- a/backend/plugin/advisor/tidb/advisor_collation_allowlist.go
+++ b/backend/plugin/advisor/tidb/advisor_collation_allowlist.go
@@ -40,16 +40,13 @@ func (*CollationAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Cont
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
checker := &collationAllowlistChecker{
level: level,
title: checkCtx.Rule.Type.String(),
allowlist: make(map[string]bool),
}
- for _, collation := range payload.List {
+ for _, collation := range stringArrayPayload.List {
checker.allowlist[strings.ToLower(collation)] = true
}
diff --git a/backend/plugin/advisor/tidb/advisor_column_auto_increment_initial_value.go b/backend/plugin/advisor/tidb/advisor_column_auto_increment_initial_value.go
index 6dfd5dcf77..7e54b3253e 100644
--- a/backend/plugin/advisor/tidb/advisor_column_auto_increment_initial_value.go
+++ b/backend/plugin/advisor/tidb/advisor_column_auto_increment_initial_value.go
@@ -6,6 +6,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
@@ -40,14 +42,14 @@ func (*ColumnAutoIncrementInitialValueAdvisor) Check(_ context.Context, checkCtx
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for column auto increment initial value rule")
}
checker := &columnAutoIncrementInitialValueChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- value: payload.Number,
+ value: int(numberPayload.Number),
}
for _, stmt := range stmtList {
diff --git a/backend/plugin/advisor/tidb/advisor_column_comment_convention.go b/backend/plugin/advisor/tidb/advisor_column_comment_convention.go
index bf57a697b7..f3d8938965 100644
--- a/backend/plugin/advisor/tidb/advisor_column_comment_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_column_comment_convention.go
@@ -40,14 +40,11 @@ func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
checker := &columnCommentConventionChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- payload: payload,
+ payload: commentPayload,
}
for _, stmt := range stmtList {
@@ -65,7 +62,7 @@ type columnCommentConventionChecker struct {
title string
text string
line int
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
}
type columnCommentData struct {
@@ -130,7 +127,7 @@ func (checker *columnCommentConventionChecker) Enter(in ast.Node) (ast.Node, boo
StartPosition: common.ConvertANTLRLineToPosition(column.line),
})
}
- if checker.payload.MaxLength >= 0 && len(column.comment) > checker.payload.MaxLength {
+ if checker.payload.MaxLength >= 0 && int32(len(column.comment)) > checker.payload.MaxLength {
checker.adviceList = append(checker.adviceList, &storepb.Advice{
Status: checker.level,
Code: code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/tidb/advisor_column_maximum_character_length.go b/backend/plugin/advisor/tidb/advisor_column_maximum_character_length.go
index c7fdfc347e..f9aa947c00 100644
--- a/backend/plugin/advisor/tidb/advisor_column_maximum_character_length.go
+++ b/backend/plugin/advisor/tidb/advisor_column_maximum_character_length.go
@@ -6,6 +6,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
@@ -41,14 +43,14 @@ func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for column maximum character length rule")
}
checker := &columnMaximumCharacterLengthChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- maximum: payload.Number,
+ maximum: int(numberPayload.Number),
}
for _, stmt := range stmtList {
diff --git a/backend/plugin/advisor/tidb/advisor_column_required.go b/backend/plugin/advisor/tidb/advisor_column_required.go
index 5d71a45a1d..8177922257 100644
--- a/backend/plugin/advisor/tidb/advisor_column_required.go
+++ b/backend/plugin/advisor/tidb/advisor_column_required.go
@@ -6,6 +6,8 @@ import (
"slices"
"strings"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
@@ -40,12 +42,12 @@ func (*ColumnRequirementAdvisor) Check(_ context.Context, checkCtx advisor.Conte
if err != nil {
return nil, err
}
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ if stringArrayPayload == nil {
+ return nil, errors.New("string_array_payload is required for column required rule")
}
requiredColumns := make(columnSet)
- for _, column := range columnList {
+ for _, column := range stringArrayPayload.List {
requiredColumns[column] = true
}
checker := &columnRequirementChecker{
diff --git a/backend/plugin/advisor/tidb/advisor_column_type_disallow_list.go b/backend/plugin/advisor/tidb/advisor_column_type_disallow_list.go
index 1cee6d6952..90e58ed4a9 100644
--- a/backend/plugin/advisor/tidb/advisor_column_type_disallow_list.go
+++ b/backend/plugin/advisor/tidb/advisor_column_type_disallow_list.go
@@ -41,16 +41,13 @@ func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- paylaod, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
checker := &columnTypeDisallowListChecker{
level: level,
title: checkCtx.Rule.Type.String(),
typeRestriction: make(map[string]bool),
}
- for _, tp := range paylaod.List {
+ for _, tp := range stringArrayPayload.List {
checker.typeRestriction[strings.ToUpper(tp)] = true
}
diff --git a/backend/plugin/advisor/tidb/advisor_index_key_number_limit.go b/backend/plugin/advisor/tidb/advisor_index_key_number_limit.go
index 9ff6370f76..6586c80ce3 100644
--- a/backend/plugin/advisor/tidb/advisor_index_key_number_limit.go
+++ b/backend/plugin/advisor/tidb/advisor_index_key_number_limit.go
@@ -6,6 +6,8 @@ import (
"context"
"fmt"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
@@ -40,14 +42,14 @@ func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Con
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for index key number limit rule")
}
checker := &indexKeyNumberLimitChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- max: payload.Number,
+ max: int(numberPayload.Number),
}
for _, stmt := range stmtList {
diff --git a/backend/plugin/advisor/tidb/advisor_index_primary_key_type_allowlist.go b/backend/plugin/advisor/tidb/advisor_index_primary_key_type_allowlist.go
index 251e5537b1..78e3d1e781 100644
--- a/backend/plugin/advisor/tidb/advisor_index_primary_key_type_allowlist.go
+++ b/backend/plugin/advisor/tidb/advisor_index_primary_key_type_allowlist.go
@@ -44,12 +44,9 @@ func (*IndexPrimaryKeyTypeAllowlistAdvisor) Check(_ context.Context, checkCtx ad
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
allowlist := make(map[string]bool)
- for _, tp := range payload.List {
+ for _, tp := range stringArrayPayload.List {
allowlist[strings.ToLower(tp)] = true
}
checker := &indexPrimaryKeyTypeAllowlistChecker{
diff --git a/backend/plugin/advisor/tidb/advisor_index_total_number_limit.go b/backend/plugin/advisor/tidb/advisor_index_total_number_limit.go
index 43191f8fb4..4b115020b4 100644
--- a/backend/plugin/advisor/tidb/advisor_index_total_number_limit.go
+++ b/backend/plugin/advisor/tidb/advisor_index_total_number_limit.go
@@ -7,6 +7,8 @@ import (
"fmt"
"slices"
+ "github.com/pkg/errors"
+
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
@@ -42,14 +44,14 @@ func (*IndexTotalNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.C
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for index total number limit rule")
}
checker := &indexTotalNumberLimitChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- max: payload.Number,
+ max: int(numberPayload.Number),
lineForTable: make(map[string]int),
finalMetadata: checkCtx.FinalMetadata,
}
diff --git a/backend/plugin/advisor/tidb/advisor_naming_auto_increment_column.go b/backend/plugin/advisor/tidb/advisor_naming_auto_increment_column.go
index c4c8b8e665..8e1c400417 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_auto_increment_column.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_auto_increment_column.go
@@ -8,6 +8,7 @@ import (
"regexp"
"github.com/pingcap/tidb/pkg/parser/ast"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -40,9 +41,19 @@ func (*NamingAutoIncrementColumnAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingAutoIncrementColumnChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_naming_column.go b/backend/plugin/advisor/tidb/advisor_naming_column.go
index d3ed4ca6a3..1b6d8b105b 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_column.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_column.go
@@ -6,6 +6,7 @@ import (
"regexp"
"github.com/pingcap/tidb/pkg/parser/ast"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -38,9 +39,19 @@ func (*NamingColumnConventionAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingColumnConventionChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_naming_foreign_key_convention.go b/backend/plugin/advisor/tidb/advisor_naming_foreign_key_convention.go
index 57d1839f6b..c6539c3df3 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_foreign_key_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_foreign_key_convention.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strings"
+ "github.com/pkg/errors"
+
"github.com/pingcap/tidb/pkg/parser/ast"
"github.com/bytebase/bytebase/backend/common"
@@ -39,9 +41,23 @@ func (*NamingFKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingFKConventionChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_naming_index_convention.go b/backend/plugin/advisor/tidb/advisor_naming_index_convention.go
index 04f27e7880..34157636c5 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_index_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_index_convention.go
@@ -6,6 +6,8 @@ import (
"regexp"
"strings"
+ "github.com/pkg/errors"
+
"github.com/pingcap/tidb/pkg/parser/ast"
"github.com/bytebase/bytebase/backend/common"
@@ -41,9 +43,23 @@ func (*NamingIndexConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingIndexConventionChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_naming_table.go b/backend/plugin/advisor/tidb/advisor_naming_table.go
index 69d0f6e556..608a19c237 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_table.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_table.go
@@ -6,6 +6,7 @@ import (
"regexp"
"github.com/pingcap/tidb/pkg/parser/ast"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -38,9 +39,19 @@ func (*NamingTableConventionAdvisor) Check(_ context.Context, checkCtx advisor.C
if err != nil {
return nil, err
}
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for naming table rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingTableConventionChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_naming_unique_key_convention.go b/backend/plugin/advisor/tidb/advisor_naming_unique_key_convention.go
index e086fddd20..e0ad230177 100644
--- a/backend/plugin/advisor/tidb/advisor_naming_unique_key_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_naming_unique_key_convention.go
@@ -5,6 +5,8 @@ import (
"fmt"
"strings"
+ "github.com/pkg/errors"
+
"github.com/pingcap/tidb/pkg/parser/ast"
"github.com/bytebase/bytebase/backend/common"
@@ -40,9 +42,23 @@ func (*NamingUKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Cont
return nil, err
}
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(storepb.SQLReviewRule_Type(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for this rule")
+ }
+
+ format := namingPayload.Format
+ templateList, _ := advisor.ParseTemplateTokens(format)
+
+ for _, key := range templateList {
+ if _, ok := advisor.TemplateNamingTokens[checkCtx.Rule.Type][key]; !ok {
+ return nil, errors.Errorf("invalid template %s for rule %s", key, checkCtx.Rule.Type)
+ }
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
}
checker := &namingUKConventionChecker{
level: level,
diff --git a/backend/plugin/advisor/tidb/advisor_statement_maximum_limit_value.go b/backend/plugin/advisor/tidb/advisor_statement_maximum_limit_value.go
index dd4bc9bd29..a1b588cd76 100644
--- a/backend/plugin/advisor/tidb/advisor_statement_maximum_limit_value.go
+++ b/backend/plugin/advisor/tidb/advisor_statement_maximum_limit_value.go
@@ -8,6 +8,7 @@ import (
"github.com/pingcap/tidb/pkg/parser/ast"
driver "github.com/pingcap/tidb/pkg/types/parser_driver"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -40,15 +41,15 @@ func (*StatementMaximumLimitValueAdvisor) Check(_ context.Context, checkCtx advi
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
+ numberPayload := checkCtx.Rule.GetNumberPayload()
+ if numberPayload == nil {
+ return nil, errors.New("number_payload is required for maximum limit value rule")
}
checker := &statementMaximumLimitValueChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- limitMaxValue: payload.Number,
+ limitMaxValue: int(numberPayload.Number),
}
for _, stmt := range stmtList {
diff --git a/backend/plugin/advisor/tidb/advisor_table_comment_convention.go b/backend/plugin/advisor/tidb/advisor_table_comment_convention.go
index 520379e054..e164088838 100644
--- a/backend/plugin/advisor/tidb/advisor_table_comment_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_table_comment_convention.go
@@ -39,14 +39,11 @@ func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.
if err != nil {
return nil, err
}
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
checker := &tableCommentConventionChecker{
level: level,
title: checkCtx.Rule.Type.String(),
- payload: payload,
+ payload: commentPayload,
}
for _, stmt := range stmtList {
@@ -64,7 +61,7 @@ type tableCommentConventionChecker struct {
title string
text string
line int
- payload *advisor.CommentConventionRulePayload
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
}
// Enter implements the ast.Visitor interface.
@@ -80,7 +77,7 @@ func (checker *tableCommentConventionChecker) Enter(in ast.Node) (ast.Node, bool
StartPosition: common.ConvertANTLRLineToPosition(checker.line),
})
}
- if checker.payload.MaxLength >= 0 && len(comment) > checker.payload.MaxLength {
+ if checker.payload.MaxLength >= 0 && int32(len(comment)) > checker.payload.MaxLength {
checker.adviceList = append(checker.adviceList, &storepb.Advice{
Status: checker.level,
Code: code.CommentTooLong.Int32(),
diff --git a/backend/plugin/advisor/tidb/advisor_table_drop_naming_convention.go b/backend/plugin/advisor/tidb/advisor_table_drop_naming_convention.go
index 501eb2a402..a7ad31571f 100644
--- a/backend/plugin/advisor/tidb/advisor_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/tidb/advisor_table_drop_naming_convention.go
@@ -8,6 +8,7 @@ import (
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/pingcap/tidb/pkg/parser/ast"
+ "github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -39,9 +40,14 @@ func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advis
if err != nil {
return nil, err
}
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
+ namingPayload := checkCtx.Rule.GetNamingPayload()
+ if namingPayload == nil {
+ return nil, errors.New("naming_payload is required for table drop naming convention rule")
+ }
+
+ format, err := regexp.Compile(namingPayload.Format)
if err != nil {
- return nil, err
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
checker := &namingDropTableConventionChecker{
diff --git a/backend/plugin/advisor/utils_for_tests.go b/backend/plugin/advisor/utils_for_tests.go
index 49ce3b9cb9..0224ef8ac5 100644
--- a/backend/plugin/advisor/utils_for_tests.go
+++ b/backend/plugin/advisor/utils_for_tests.go
@@ -3,7 +3,6 @@ package advisor
import (
"context"
"database/sql"
- "encoding/json"
"fmt"
"io"
"os"
@@ -224,16 +223,14 @@ func RunSQLReviewRuleTest(t *testing.T, rule storepb.SQLReviewRule_Type, dbType
require.True(t, ok, "failed to clone catalog metadata")
finalMetadata := model.NewDatabaseMetadata(finalCatalogClone, nil, nil, dbType, isCaseSensitive)
- payload, err := SetDefaultSQLReviewRulePayload(rule, dbType)
+ sqlRule := &storepb.SQLReviewRule{
+ Type: rule,
+ Level: storepb.SQLReviewRule_WARNING,
+ }
+ err := SetDefaultSQLReviewRulePayload(sqlRule, dbType)
require.NoError(t, err)
- ruleList := []*storepb.SQLReviewRule{
- {
- Type: rule,
- Level: storepb.SQLReviewRule_WARNING,
- Payload: string(payload),
- },
- }
+ ruleList := []*storepb.SQLReviewRule{sqlRule}
checkCtx := Context{
Charset: "",
@@ -343,10 +340,8 @@ func (*MockDriver) Dump(_ context.Context, _ io.Writer, _ *storepb.DatabaseSchem
}
// SetDefaultSQLReviewRulePayload sets the default payload for this rule.
-func SetDefaultSQLReviewRulePayload(ruleTp storepb.SQLReviewRule_Type, dbType storepb.Engine) (string, error) {
- var payload []byte
- var err error
- switch ruleTp {
+func SetDefaultSQLReviewRulePayload(rule *storepb.SQLReviewRule, dbType storepb.Engine) error {
+ switch rule.Type {
case storepb.SQLReviewRule_ENGINE_MYSQL_USE_INNODB,
storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,
storepb.SQLReviewRule_NAMING_FULLY_QUALIFIED,
@@ -412,12 +407,14 @@ func SetDefaultSQLReviewRulePayload(ruleTp storepb.SQLReviewRule_Type, dbType st
storepb.SQLReviewRule_STATEMENT_DISALLOW_CROSS_DB_QUERIES,
storepb.SQLReviewRule_INDEX_NOT_REDUNDANT:
case storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "_delete$",
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "_delete$",
+ },
+ }
case storepb.SQLReviewRule_NAMING_TABLE, storepb.SQLReviewRule_NAMING_COLUMN:
format := "^[a-z]+(_[a-z]+)*$"
- maxLength := 64
+ maxLength := int32(64)
switch dbType {
case storepb.Engine_SNOWFLAKE:
format = "^[A-Z]+(_[A-Z]+)*$"
@@ -426,140 +423,193 @@ func SetDefaultSQLReviewRulePayload(ruleTp storepb.SQLReviewRule_Type, dbType st
default:
// Use default format for other databases
}
- payload, err = json.Marshal(NamingRulePayload{
- Format: format,
- MaxLength: maxLength,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: format,
+ MaxLength: maxLength,
+ },
+ }
case storepb.SQLReviewRule_NAMING_INDEX_IDX:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "^$|^idx_{{table}}_{{column_list}}$",
- MaxLength: 64,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^idx_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ }
case storepb.SQLReviewRule_NAMING_INDEX_PK:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "^$|^pk_{{table}}_{{column_list}}$",
- MaxLength: 64,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^pk_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ }
case storepb.SQLReviewRule_NAMING_INDEX_UK:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "^$|^uk_{{table}}_{{column_list}}$",
- MaxLength: 64,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^uk_{{table}}_{{column_list}}$",
+ MaxLength: 64,
+ },
+ }
case storepb.SQLReviewRule_NAMING_INDEX_FK:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$",
- MaxLength: 64,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$",
+ MaxLength: 64,
+ },
+ }
case storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT:
- payload, err = json.Marshal(NamingRulePayload{
- Format: "^id$",
- MaxLength: 64,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingPayload{
+ NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{
+ Format: "^id$",
+ MaxLength: 64,
+ },
+ }
case storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 5,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ }
case storepb.SQLReviewRule_STATEMENT_MAXIMUM_JOIN_TABLE_COUNT:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 2,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 2,
+ },
+ }
case storepb.SQLReviewRule_STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 2,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 2,
+ },
+ }
case storepb.SQLReviewRule_STATEMENT_MAXIMUM_LIMIT_VALUE:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 1000,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 1000,
+ },
+ }
case storepb.SQLReviewRule_TABLE_COMMENT, storepb.SQLReviewRule_COLUMN_COMMENT:
- payload, err = json.Marshal(CommentConventionRulePayload{
- Required: true,
- MaxLength: 10,
- })
+ rule.Payload = &storepb.SQLReviewRule_CommentConventionPayload{
+ CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{
+ Required: true,
+ MaxLength: 10,
+ },
+ }
case storepb.SQLReviewRule_COLUMN_REQUIRED:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{
- "id",
- "created_ts",
- "updated_ts",
- "creator_id",
- "updater_id",
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{
+ "id",
+ "created_ts",
+ "updated_ts",
+ "creator_id",
+ "updater_id",
+ },
},
- })
+ }
case storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"JSON", "BINARY_FLOAT"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"JSON", "BINARY_FLOAT"},
+ },
+ }
case storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 20,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ }
case storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 2560,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 2560,
+ },
+ }
case storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 20,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ }
case storepb.SQLReviewRule_TABLE_DISALLOW_DDL:
if dbType == storepb.Engine_MSSQL {
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"MySchema.Identifier"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"MySchema.Identifier"},
+ },
+ }
} else {
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"identifier"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"identifier"},
+ },
+ }
}
case storepb.SQLReviewRule_TABLE_DISALLOW_DML:
if dbType == storepb.Engine_MSSQL {
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"MySchema.Identifier"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"MySchema.Identifier"},
+ },
+ }
} else {
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"identifier"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"identifier"},
+ },
+ }
}
case storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 5,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 5,
+ },
+ }
case storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"utf8mb4", "UTF8"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4", "UTF8"},
+ },
+ }
case storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"utf8mb4_0900_ai_ci"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"utf8mb4_0900_ai_ci"},
+ },
+ }
case storepb.SQLReviewRule_SYSTEM_COMMENT_LENGTH:
- payload, err = json.Marshal(NumberTypeRulePayload{
- Number: 20,
- })
+ rule.Payload = &storepb.SQLReviewRule_NumberPayload{
+ NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{
+ Number: 20,
+ },
+ }
case storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"serial", "bigserial", "int", "bigint"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"serial", "bigserial", "int", "bigint"},
+ },
+ }
case storepb.SQLReviewRule_INDEX_TYPE_ALLOW_LIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"BTREE", "HASH"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"BTREE", "HASH"},
+ },
+ }
case storepb.SQLReviewRule_NAMING_IDENTIFIER_CASE:
- payload, err = json.Marshal(NamingCaseRulePayload{
- Upper: true,
- })
+ rule.Payload = &storepb.SQLReviewRule_NamingCasePayload{
+ NamingCasePayload: &storepb.SQLReviewRule_NamingCaseRulePayload{
+ Upper: true,
+ },
+ }
case storepb.SQLReviewRule_SYSTEM_FUNCTION_DISALLOWED_LIST:
- payload, err = json.Marshal(StringArrayTypeRulePayload{
- List: []string{"rand", "uuid", "sleep"},
- })
+ rule.Payload = &storepb.SQLReviewRule_StringArrayPayload{
+ StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{
+ List: []string{"rand", "uuid", "sleep"},
+ },
+ }
default:
- return "", errors.Errorf("unknown SQL review type for default payload: %s", ruleTp)
+ return errors.Errorf("unknown SQL review type for default payload: %s", rule.Type)
}
- if err != nil {
- return "", err
- }
- return string(payload), nil
+ return nil
}
diff --git a/backend/tests/sql_review_test.go b/backend/tests/sql_review_test.go
index 75363a81f5..2092a290d6 100644
--- a/backend/tests/sql_review_test.go
+++ b/backend/tests/sql_review_test.go
@@ -22,6 +22,7 @@ import (
"google.golang.org/protobuf/types/known/fieldmaskpb"
"gopkg.in/yaml.v3"
+ apiv1 "github.com/bytebase/bytebase/backend/api/v1"
"github.com/bytebase/bytebase/backend/common"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
@@ -101,8 +102,7 @@ func TestSQLReviewForPostgreSQL(t *testing.T) {
_, err = pgDB.Exec("ALTER USER bytebase WITH SUPERUSER")
a.NoError(err)
- reviewConfig, err := prodTemplateReviewConfigForPostgreSQL()
- a.NoError(err)
+ reviewConfig := prodTemplateReviewConfigForPostgreSQL()
createdConfig, err := ctl.reviewConfigServiceClient.CreateReviewConfig(ctx, connect.NewRequest(&v1pb.CreateReviewConfigRequest{
ReviewConfig: reviewConfig,
@@ -269,8 +269,7 @@ func TestSQLReviewForMySQL(t *testing.T) {
_, err = mysqlDB.Exec("GRANT ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE VIEW, DELETE, DROP, EVENT, EXECUTE, INDEX, INSERT, PROCESS, REFERENCES, SELECT, SHOW DATABASES, SHOW VIEW, TRIGGER, UPDATE, USAGE, REPLICATION CLIENT, REPLICATION SLAVE, LOCK TABLES, RELOAD ON *.* to bytebase")
a.NoError(err)
- reviewConfig, err := prodTemplateReviewConfigForMySQL()
- a.NoError(err)
+ reviewConfig := prodTemplateReviewConfigForMySQL()
createdConfig, err := ctl.reviewConfigServiceClient.CreateReviewConfig(ctx, connect.NewRequest(&v1pb.CreateReviewConfigRequest{
ReviewConfig: reviewConfig,
@@ -524,7 +523,7 @@ func equalReviewResultProtos(a *require.Assertions, want, got []*v1pb.PlanCheckR
}
}
-func prodTemplateReviewConfigForPostgreSQL() (*v1pb.ReviewConfig, error) {
+func prodTemplateReviewConfigForPostgreSQL() *v1pb.ReviewConfig {
config := &v1pb.ReviewConfig{
Name: common.FormatReviewConfig(generateRandomString("review")),
Title: "Prod",
@@ -685,17 +684,11 @@ func prodTemplateReviewConfigForPostgreSQL() (*v1pb.ReviewConfig, error) {
},
}
- for _, rule := range config.Rules {
- payload, err := advisor.SetDefaultSQLReviewRulePayload(storepb.SQLReviewRule_Type(rule.Type), storepb.Engine_POSTGRES)
- if err != nil {
- return nil, err
- }
- rule.Payload = payload
- }
- return config, nil
+ setV1SQLReviewRulePayloads(config.Rules, v1pb.Engine_POSTGRES)
+ return config
}
-func prodTemplateReviewConfigForMySQL() (*v1pb.ReviewConfig, error) {
+func prodTemplateReviewConfigForMySQL() *v1pb.ReviewConfig {
config := &v1pb.ReviewConfig{
Name: common.FormatReviewConfig(generateRandomString("review")),
Title: "Prod",
@@ -963,12 +956,31 @@ func prodTemplateReviewConfigForMySQL() (*v1pb.ReviewConfig, error) {
},
}
- for _, rule := range config.Rules {
- payload, err := advisor.SetDefaultSQLReviewRulePayload(storepb.SQLReviewRule_Type(rule.Type), storepb.Engine_POSTGRES)
- if err != nil {
- return nil, err
+ setV1SQLReviewRulePayloads(config.Rules, v1pb.Engine_MYSQL)
+ return config
+}
+
+// setV1SQLReviewRulePayloads sets default payloads for v1pb rules by converting to storepb and back.
+func setV1SQLReviewRulePayloads(rules []*v1pb.SQLReviewRule, engine v1pb.Engine) {
+ // Convert v1pb rules to storepb format
+ storeRules, err := apiv1.ConvertToSQLReviewRules(rules)
+ if err != nil {
+ // This shouldn't fail for test data, but if it does, panic to fail the test
+ panic(fmt.Sprintf("failed to convert rules: %v", err))
+ }
+
+ // Set default payloads using the advisor package
+ for _, storeRule := range storeRules {
+ storeRule.Engine = storepb.Engine(engine)
+ if err := advisor.SetDefaultSQLReviewRulePayload(storeRule, storepb.Engine(engine)); err != nil {
+ panic(fmt.Sprintf("failed to set payload for rule %v: %v", storeRule.Type, err))
}
- rule.Payload = payload
}
- return config, nil
+
+ // Convert back to v1pb and copy payloads
+ convertedRules := apiv1.ConvertToV1PBSQLReviewRules(storeRules)
+ for i, rule := range rules {
+ rule.Payload = convertedRules[i].Payload
+ rule.Engine = engine
+ }
}
diff --git a/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue b/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
index 928bedb4d1..ed7963b08f 100644
--- a/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
+++ b/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
@@ -527,11 +527,15 @@ const getActiveRule = (type: string): RuleTemplateV2 | undefined => {
componentList: [],
};
}
+ // Convert string to enum for comparison
+ const typeKey = type as keyof typeof SQLReviewRule_Type;
+ const typeEnum = SQLReviewRule_Type[typeKey];
+
const rule = reviewPolicy.value?.ruleList.find((rule) => {
if (engine && rule.engine !== engine) {
return false;
}
- return rule.type === type;
+ return rule.type === typeEnum;
});
if (!rule) {
return undefined;
diff --git a/frontend/src/components/SQLReview/components/utils.ts b/frontend/src/components/SQLReview/components/utils.ts
index bd4e0478e5..ea6cfd7b0b 100644
--- a/frontend/src/components/SQLReview/components/utils.ts
+++ b/frontend/src/components/SQLReview/components/utils.ts
@@ -17,10 +17,8 @@ export const rulesToTemplate = (review: SQLReviewPolicy) => {
const ruleTemplateList: RuleTemplateV2[] = [];
for (const rule of review.ruleList) {
- // Convert type string to enum for map lookup
- const typeKey = rule.type as keyof typeof SQLReviewRule_Type;
- const type =
- SQLReviewRule_Type[typeKey] ?? SQLReviewRule_Type.TYPE_UNSPECIFIED;
+ // rule.type is already SQLReviewRule_Type enum
+ const type = rule.type ?? SQLReviewRule_Type.TYPE_UNSPECIFIED;
const ruleTemplate = ruleTemplateMapV2.get(rule.engine)?.get(type);
if (!ruleTemplate) {
diff --git a/frontend/src/store/modules/sqlReview.ts b/frontend/src/store/modules/sqlReview.ts
index c7c377302d..10b904d228 100644
--- a/frontend/src/store/modules/sqlReview.ts
+++ b/frontend/src/store/modules/sqlReview.ts
@@ -22,8 +22,6 @@ import {
GetReviewConfigRequestSchema,
ListReviewConfigsRequestSchema,
ReviewConfigSchema,
- SQLReviewRule_Type,
- SQLReviewRuleSchema,
UpdateReviewConfigRequestSchema,
} from "@/types/proto-es/v1/review_config_service_pb";
import { usePolicyV1Store } from "./v1/policy";
@@ -68,24 +66,11 @@ const removeReviewConfigTag = async (resources: string[]) => {
const convertToSQLReviewPolicy = (
reviewConfig: ReviewConfig
): SQLReviewPolicy | undefined => {
- const ruleList: SchemaPolicyRule[] = [];
- for (const r of reviewConfig.rules) {
- const rule: SchemaPolicyRule = {
- type: SQLReviewRule_Type[r.type] as string,
- level: r.level,
- engine: r.engine,
- };
- if (r.payload && r.payload !== "{}") {
- rule.payload = JSON.parse(r.payload);
- }
- ruleList.push(rule);
- }
-
return {
id: reviewConfig.name,
name: reviewConfig.title,
resources: reviewConfig.resources,
- ruleList,
+ ruleList: reviewConfig.rules, // Use proto rules directly
enforce: reviewConfig.enabled,
};
};
@@ -191,14 +176,7 @@ export const useSQLReviewStore = defineStore("sqlReview", {
}
if (ruleList) {
updateMask.push("rules");
- patch.rules = ruleList.map((r) => {
- return create(SQLReviewRuleSchema, {
- type: SQLReviewRule_Type[r.type as keyof typeof SQLReviewRule_Type],
- level: r.level,
- engine: r.engine,
- payload: r.payload ? JSON.stringify(r.payload) : "{}",
- });
- });
+ patch.rules = ruleList; // Use proto rules directly
}
const request = create(UpdateReviewConfigRequestSchema, {
diff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts b/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
index c7bc767d62..964b9eeaa1 100644
--- a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
@@ -202,16 +202,58 @@ export declare type SQLReviewRule = Message<"bytebase.v1.SQLReviewRule"> & {
level: SQLReviewRule_Level;
/**
- * The payload is a JSON string that varies by rule type.
+ * The payload is a typed message that varies by rule type.
*
- * @generated from field: string payload = 3;
- */
- payload: string;
+ * @generated from oneof bytebase.v1.SQLReviewRule.payload
+ */
+ payload: {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.NamingRulePayload naming_payload = 3;
+ */
+ value: SQLReviewRule_NamingRulePayload;
+ case: "namingPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.NumberRulePayload number_payload = 4;
+ */
+ value: SQLReviewRule_NumberRulePayload;
+ case: "numberPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.StringArrayRulePayload string_array_payload = 5;
+ */
+ value: SQLReviewRule_StringArrayRulePayload;
+ case: "stringArrayPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.CommentConventionRulePayload comment_convention_payload = 6;
+ */
+ value: SQLReviewRule_CommentConventionRulePayload;
+ case: "commentConventionPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.RequiredColumnRulePayload required_column_payload = 7;
+ */
+ value: SQLReviewRule_RequiredColumnRulePayload;
+ case: "requiredColumnPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.StringRulePayload string_payload = 8;
+ */
+ value: SQLReviewRule_StringRulePayload;
+ case: "stringPayload";
+ } | {
+ /**
+ * @generated from field: bytebase.v1.SQLReviewRule.NamingCaseRulePayload naming_case_payload = 9;
+ */
+ value: SQLReviewRule_NamingCaseRulePayload;
+ case: "namingCasePayload";
+ } | { case: undefined; value?: undefined };
/**
* The database engine this rule applies to.
*
- * @generated from field: bytebase.v1.Engine engine = 4;
+ * @generated from field: bytebase.v1.Engine engine = 10;
*/
engine: Engine;
};
@@ -222,6 +264,130 @@ export declare type SQLReviewRule = Message<"bytebase.v1.SQLReviewRule"> & {
*/
export declare const SQLReviewRuleSchema: GenMessage<SQLReviewRule>;
+/**
+ * Payload message types for SQL review rules
+ *
+ * @generated from message bytebase.v1.SQLReviewRule.NamingRulePayload
+ */
+export declare type SQLReviewRule_NamingRulePayload = Message<"bytebase.v1.SQLReviewRule.NamingRulePayload"> & {
+ /**
+ * @generated from field: int32 max_length = 1;
+ */
+ maxLength: number;
+
+ /**
+ * @generated from field: string format = 2;
+ */
+ format: string;
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NamingRulePayload.
+ * Use `create(SQLReviewRule_NamingRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_NamingRulePayloadSchema: GenMessage<SQLReviewRule_NamingRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.NumberRulePayload
+ */
+export declare type SQLReviewRule_NumberRulePayload = Message<"bytebase.v1.SQLReviewRule.NumberRulePayload"> & {
+ /**
+ * @generated from field: int32 number = 1;
+ */
+ number: number;
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NumberRulePayload.
+ * Use `create(SQLReviewRule_NumberRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_NumberRulePayloadSchema: GenMessage<SQLReviewRule_NumberRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.StringArrayRulePayload
+ */
+export declare type SQLReviewRule_StringArrayRulePayload = Message<"bytebase.v1.SQLReviewRule.StringArrayRulePayload"> & {
+ /**
+ * @generated from field: repeated string list = 1;
+ */
+ list: string[];
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.StringArrayRulePayload.
+ * Use `create(SQLReviewRule_StringArrayRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_StringArrayRulePayloadSchema: GenMessage<SQLReviewRule_StringArrayRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.CommentConventionRulePayload
+ */
+export declare type SQLReviewRule_CommentConventionRulePayload = Message<"bytebase.v1.SQLReviewRule.CommentConventionRulePayload"> & {
+ /**
+ * @generated from field: bool required = 1;
+ */
+ required: boolean;
+
+ /**
+ * @generated from field: int32 max_length = 2;
+ */
+ maxLength: number;
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.CommentConventionRulePayload.
+ * Use `create(SQLReviewRule_CommentConventionRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_CommentConventionRulePayloadSchema: GenMessage<SQLReviewRule_CommentConventionRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.RequiredColumnRulePayload
+ */
+export declare type SQLReviewRule_RequiredColumnRulePayload = Message<"bytebase.v1.SQLReviewRule.RequiredColumnRulePayload"> & {
+ /**
+ * @generated from field: repeated string column_list = 1;
+ */
+ columnList: string[];
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.RequiredColumnRulePayload.
+ * Use `create(SQLReviewRule_RequiredColumnRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_RequiredColumnRulePayloadSchema: GenMessage<SQLReviewRule_RequiredColumnRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.StringRulePayload
+ */
+export declare type SQLReviewRule_StringRulePayload = Message<"bytebase.v1.SQLReviewRule.StringRulePayload"> & {
+ /**
+ * @generated from field: string value = 1;
+ */
+ value: string;
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.StringRulePayload.
+ * Use `create(SQLReviewRule_StringRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_StringRulePayloadSchema: GenMessage<SQLReviewRule_StringRulePayload>;
+
+/**
+ * @generated from message bytebase.v1.SQLReviewRule.NamingCaseRulePayload
+ */
+export declare type SQLReviewRule_NamingCaseRulePayload = Message<"bytebase.v1.SQLReviewRule.NamingCaseRulePayload"> & {
+ /**
+ * @generated from field: bool upper = 1;
+ */
+ upper: boolean;
+};
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NamingCaseRulePayload.
+ * Use `create(SQLReviewRule_NamingCaseRulePayloadSchema)` to create a new message.
+ */
+export declare const SQLReviewRule_NamingCaseRulePayloadSchema: GenMessage<SQLReviewRule_NamingCaseRulePayload>;
+
/**
* The severity level for SQL review rules.
*
diff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.js b/frontend/src/types/proto-es/v1/review_config_service_pb.js
index e2785a1a69..96033fd351 100644
--- a/frontend/src/types/proto-es/v1/review_config_service_pb.js
+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.js
@@ -16,7 +16,7 @@ import { file_v1_common } from "./common_pb";
* Describes the file v1/review_config_service.proto.
*/
export const file_v1_review_config_service = /*@__PURE__*/
- fileDesc("Ch52MS9yZXZpZXdfY29uZmlnX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhoKGExpc3RSZXZpZXdDb25maWdzUmVxdWVzdCJOChlMaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlEjEKDnJldmlld19jb25maWdzGAEgAygLMhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIlIKGUNyZWF0ZVJldmlld0NvbmZpZ1JlcXVlc3QSNQoNcmV2aWV3X2NvbmZpZxgBIAEoCzIZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZ0ID4EECIpoBChlVcGRhdGVSZXZpZXdDb25maWdSZXF1ZXN0EjUKDXJldmlld19jb25maWcYASABKAsyGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWdCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJJChZHZXRSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyJMChlEZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyLHAQoMUmV2aWV3Q29uZmlnEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESDwoHZW5hYmxlZBgDIAEoCBIpCgVydWxlcxgHIAMoCzIaLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUSEQoJcmVzb3VyY2VzGAggAygJOjzqQTkKGWJ5dGViYXNlLmNvbS9SZXZpZXdDb25maWcSHHJldmlld0NvbmZpZ3Mve3Jldmlld0NvbmZpZ30ikB4KDVNRTFJldmlld1J1bGUSLQoEdHlwZRgBIAEoDjIfLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuVHlwZRIvCgVsZXZlbBgCIAEoDjIgLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuTGV2ZWwSDwoHcGF5bG9hZBgDIAEoCRIjCgZlbmdpbmUYBCABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUiNgoFTGV2ZWwSFQoRTEVWRUxfVU5TUEVDSUZJRUQQABIJCgVFUlJPUhABEgsKB1dBUk5JTkcQAiKwHAoEVHlwZRIUChBUWVBFX1VOU1BFQ0lGSUVEEAASGwoXRU5HSU5FX01ZU1FMX1VTRV9JTk5PREIQARIaChZOQU1JTkdfRlVMTFlfUVVBTElGSUVEEAISEAoMTkFNSU5HX1RBQkxFEAMSEQoNTkFNSU5HX0NPTFVNThAEEhMKD05BTUlOR19JTkRFWF9QSxAFEhMKD05BTUlOR19JTkRFWF9VSxAGEhMKD05BTUlOR19JTkRFWF9GSxAHEhQKEE5BTUlOR19JTkRFWF9JRFgQCBIgChxOQU1JTkdfQ09MVU1OX0FVVE9fSU5DUkVNRU5UEAkSGwoXTkFNSU5HX1RBQkxFX05PX0tFWVdPUkQQChIgChxOQU1JTkdfSURFTlRJRklFUl9OT19LRVlXT1JEEAsSGgoWTkFNSU5HX0lERU5USUZJRVJfQ0FTRRAMEiIKHlNUQVRFTUVOVF9TRUxFQ1RfTk9fU0VMRUNUX0FMTBANEiIKHlNUQVRFTUVOVF9XSEVSRV9SRVFVSVJFX1NFTEVDVBAOEikKJVNUQVRFTUVOVF9XSEVSRV9SRVFVSVJFX1VQREFURV9ERUxFVEUQDxIsCihTVEFURU1FTlRfV0hFUkVfTk9fTEVBRElOR19XSUxEQ0FSRF9MSUtFEBASJQohU1RBVEVNRU5UX0RJU0FMTE9XX09OX0RFTF9DQVNDQURFEBESJQohU1RBVEVNRU5UX0RJU0FMTE9XX1JNX1RCTF9DQVNDQURFEBISHQoZU1RBVEVNRU5UX0RJU0FMTE9XX0NPTU1JVBATEhwKGFNUQVRFTUVOVF9ESVNBTExPV19MSU1JVBAUEh8KG1NUQVRFTUVOVF9ESVNBTExPV19PUkRFUl9CWRAVEh8KG1NUQVRFTUVOVF9NRVJHRV9BTFRFUl9UQUJMRRAWEh4KGlNUQVRFTUVOVF9JTlNFUlRfUk9XX0xJTUlUEBcSKAokU1RBVEVNRU5UX0lOU0VSVF9NVVNUX1NQRUNJRllfQ09MVU1OEBgSKwonU1RBVEVNRU5UX0lOU0VSVF9ESVNBTExPV19PUkRFUl9CWV9SQU5EEBkSIAocU1RBVEVNRU5UX0FGRkVDVEVEX1JPV19MSU1JVBAaEhkKFVNUQVRFTUVOVF9ETUxfRFJZX1JVThAbEi4KKlNUQVRFTUVOVF9ESVNBTExPV19BRERfQ09MVU1OX1dJVEhfREVGQVVMVBAcEiEKHVNUQVRFTUVOVF9BRERfQ0hFQ0tfTk9UX1ZBTElEEB0SJwojU1RBVEVNRU5UX0FERF9GT1JFSUdOX0tFWV9OT1RfVkFMSUQQHhIjCh9TVEFURU1FTlRfRElTQUxMT1dfQUREX05PVF9OVUxMEB8SJAogU1RBVEVNRU5UX1NFTEVDVF9GVUxMX1RBQkxFX1NDQU4QIBIjCh9TVEFURU1FTlRfQ1JFQVRFX1NQRUNJRllfU0NIRU1BECESJQohU1RBVEVNRU5UX0NIRUNLX1NFVF9ST0xFX1ZBUklBQkxFECISJQohU1RBVEVNRU5UX0RJU0FMTE9XX1VTSU5HX0ZJTEVTT1JUECMSJgoiU1RBVEVNRU5UX0RJU0FMTE9XX1VTSU5HX1RFTVBPUkFSWRAkEiEKHVNUQVRFTUVOVF9XSEVSRV9OT19FUVVBTF9OVUxMECUSNwozU1RBVEVNRU5UX1dIRVJFX0RJU0FMTE9XX0ZVTkNUSU9OU19BTkRfQ0FMQ1VMQVRJT05TECYSJgoiU1RBVEVNRU5UX1FVRVJZX01JTklNVU1fUExBTl9MRVZFTBAnEjIKLlNUQVRFTUVOVF9XSEVSRV9NQVhJTVVNX0xPR0lDQUxfT1BFUkFUT1JfQ09VTlQQKBIhCh1TVEFURU1FTlRfTUFYSU1VTV9MSU1JVF9WQUxVRRApEiYKIlNUQVRFTUVOVF9NQVhJTVVNX0pPSU5fVEFCTEVfQ09VTlQQKhIvCitTVEFURU1FTlRfTUFYSU1VTV9TVEFURU1FTlRTX0lOX1RSQU5TQUNUSU9OECsSJgoiU1RBVEVNRU5UX0pPSU5fU1RSSUNUX0NPTFVNTl9BVFRSUxAsEh8KG1NUQVRFTUVOVF9OT05fVFJBTlNBQ1RJT05BTBAtEikKJVNUQVRFTUVOVF9BRERfQ09MVU1OX1dJVEhPVVRfUE9TSVRJT04QLhIiCh5TVEFURU1FTlRfRElTQUxMT1dfT0ZGTElORV9EREwQLxInCiNTVEFURU1FTlRfRElTQUxMT1dfQ1JPU1NfREJfUVVFUklFUxAwEiAKHFNUQVRFTUVOVF9NQVhfRVhFQ1VUSU9OX1RJTUUQMRImCiJTVEFURU1FTlRfUkVRVUlSRV9BTEdPUklUSE1fT1BUSU9OEDISIQodU1RBVEVNRU5UX1JFUVVJUkVfTE9DS19PUFRJT04QMxIgChxTVEFURU1FTlRfT0JKRUNUX09XTkVSX0NIRUNLEDQSFAoQVEFCTEVfUkVRVUlSRV9QSxA1EhgKFFRBQkxFX05PX0ZPUkVJR05fS0VZEDYSIAocVEFCTEVfRFJPUF9OQU1JTkdfQ09OVkVOVElPThA3EhEKDVRBQkxFX0NPTU1FTlQQOBIcChhUQUJMRV9ESVNBTExPV19QQVJUSVRJT04QORIaChZUQUJMRV9ESVNBTExPV19UUklHR0VSEDoSHAoYVEFCTEVfTk9fRFVQTElDQVRFX0lOREVYEDsSIgoeVEFCTEVfVEVYVF9GSUVMRFNfVE9UQUxfTEVOR1RIEDwSHgoaVEFCTEVfRElTQUxMT1dfU0VUX0NIQVJTRVQQPRIWChJUQUJMRV9ESVNBTExPV19EREwQPhIWChJUQUJMRV9ESVNBTExPV19ETUwQPxIUChBUQUJMRV9MSU1JVF9TSVpFEEASGQoVVEFCTEVfUkVRVUlSRV9DSEFSU0VUEEESGwoXVEFCTEVfUkVRVUlSRV9DT0xMQVRJT04QQhITCg9DT0xVTU5fUkVRVUlSRUQQQxISCg5DT0xVTU5fTk9fTlVMTBBEEh8KG0NPTFVNTl9ESVNBTExPV19DSEFOR0VfVFlQRRBFEiMKH0NPTFVNTl9TRVRfREVGQVVMVF9GT1JfTk9UX05VTEwQRhIaChZDT0xVTU5fRElTQUxMT1dfQ0hBTkdFEEcSIgoeQ09MVU1OX0RJU0FMTE9XX0NIQU5HSU5HX09SREVSEEgSGAoUQ09MVU1OX0RJU0FMTE9XX0RST1AQSRIhCh1DT0xVTU5fRElTQUxMT1dfRFJPUF9JTl9JTkRFWBBKEhIKDkNPTFVNTl9DT01NRU5UEEsSJgoiQ09MVU1OX0FVVE9fSU5DUkVNRU5UX01VU1RfSU5URUdFUhBMEh0KGUNPTFVNTl9UWVBFX0RJU0FMTE9XX0xJU1QQTRIfChtDT0xVTU5fRElTQUxMT1dfU0VUX0NIQVJTRVQQThIjCh9DT0xVTU5fTUFYSU1VTV9DSEFSQUNURVJfTEVOR1RIEE8SIQodQ09MVU1OX01BWElNVU1fVkFSQ0hBUl9MRU5HVEgQUBInCiNDT0xVTU5fQVVUT19JTkNSRU1FTlRfSU5JVElBTF9WQUxVRRBREicKI0NPTFVNTl9BVVRPX0lOQ1JFTUVOVF9NVVNUX1VOU0lHTkVEEFISIwofQ09MVU1OX0NVUlJFTlRfVElNRV9DT1VOVF9MSU1JVBBTEhoKFkNPTFVNTl9SRVFVSVJFX0RFRkFVTFQQVBIkCiBDT0xVTU5fREVGQVVMVF9ESVNBTExPV19WT0xBVElMRRBVEicKI0NPTFVNTl9BRERfTk9UX05VTExfUkVRVUlSRV9ERUZBVUxUEFYSGgoWQ09MVU1OX1JFUVVJUkVfQ0hBUlNFVBBXEhwKGENPTFVNTl9SRVFVSVJFX0NPTExBVElPThBYEiEKHVNDSEVNQV9CQUNLV0FSRF9DT01QQVRJQklMSVRZEFkSIAocREFUQUJBU0VfRFJPUF9FTVBUWV9EQVRBQkFTRRBaEh0KGUlOREVYX05PX0RVUExJQ0FURV9DT0xVTU4QWxIaChZJTkRFWF9LRVlfTlVNQkVSX0xJTUlUEFwSFwoTSU5ERVhfUEtfVFlQRV9MSU1JVBBdEhYKEklOREVYX1RZUEVfTk9fQkxPQhBeEhwKGElOREVYX1RPVEFMX05VTUJFUl9MSU1JVBBfEiQKIElOREVYX1BSSU1BUllfS0VZX1RZUEVfQUxMT1dMSVNUEGASHQoZSU5ERVhfQ1JFQVRFX0NPTkNVUlJFTlRMWRBhEhkKFUlOREVYX1RZUEVfQUxMT1dfTElTVBBiEhcKE0lOREVYX05PVF9SRURVTkRBTlQQYxIcChhTWVNURU1fQ0hBUlNFVF9BTExPV0xJU1QQZBIeChpTWVNURU1fQ09MTEFUSU9OX0FMTE9XTElTVBBlEhkKFVNZU1RFTV9DT01NRU5UX0xFTkdUSBBmEiQKIFNZU1RFTV9QUk9DRURVUkVfRElTQUxMT1dfQ1JFQVRFEGcSIAocU1lTVEVNX0VWRU5UX0RJU0FMTE9XX0NSRUFURRBoEh8KG1NZU1RFTV9WSUVXX0RJU0FMTE9XX0NSRUFURRBpEiMKH1NZU1RFTV9GVU5DVElPTl9ESVNBTExPV19DUkVBVEUQahIjCh9TWVNURU1fRlVOQ1RJT05fRElTQUxMT1dFRF9MSVNUEGsSGwoXQURWSUNFX09OTElORV9NSUdSQVRJT04QbBIeChpCVUlMVElOX1BSSU9SX0JBQ0tVUF9DSEVDSxBtMu0GChNSZXZpZXdDb25maWdTZXJ2aWNlEqMBChJDcmVhdGVSZXZpZXdDb25maWcSJi5ieXRlYmFzZS52MS5DcmVhdGVSZXZpZXdDb25maWdSZXF1ZXN0GhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIkraQQCK6jAXYmIucmV2aWV3Q29uZmlncy5jcmVhdGWQ6jABgtPkkwIiOg1yZXZpZXdfY29uZmlnIhEvdjEvcmV2aWV3Q29uZmlncxKdAQoRTGlzdFJldmlld0NvbmZpZ3MSJS5ieXRlYmFzZS52MS5MaXN0UmV2aWV3Q29uZmlnc1JlcXVlc3QaJi5ieXRlYmFzZS52MS5MaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlIjnaQQCK6jAVYmIucmV2aWV3Q29uZmlncy5saXN0kOowAYLT5JMCExIRL3YxL3Jldmlld0NvbmZpZ3MSmAEKD0dldFJldmlld0NvbmZpZxIjLmJ5dGViYXNlLnYxLkdldFJldmlld0NvbmZpZ1JlcXVlc3QaGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWciRdpBBG5hbWWK6jAUYmIucmV2aWV3Q29uZmlncy5nZXSQ6jABgtPkkwIcEhovdjEve25hbWU9cmV2aWV3Q29uZmlncy8qfRLTAQoSVXBkYXRlUmV2aWV3Q29uZmlnEiYuYnl0ZWJhc2UudjEuVXBkYXRlUmV2aWV3Q29uZmlnUmVxdWVzdBoZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZyJ62kEZcmV2aWV3X2NvbmZpZyx1cGRhdGVfbWFza4rqMBdiYi5yZXZpZXdDb25maWdzLnVwZGF0ZZDqMAGC0+STAjk6DXJldmlld19jb25maWcyKC92MS97cmV2aWV3X2NvbmZpZy5uYW1lPXJldmlld0NvbmZpZ3MvKn0SngEKEkRlbGV0ZVJldmlld0NvbmZpZxImLmJ5dGViYXNlLnYxLkRlbGV0ZVJldmlld0NvbmZpZ1JlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiSNpBBG5hbWWK6jAXYmIucmV2aWV3Q29uZmlncy5kZWxldGWQ6jABgtPkkwIcKhovdjEve25hbWU9cmV2aWV3Q29uZmlncy8qfUKuAQoPY29tLmJ5dGViYXNlLnYxQhhSZXZpZXdDb25maWdTZXJ2aWNlUHJvdG9QAVo0Z2l0aHViLmNvbS9ieXRlYmFzZS9ieXRlYmFzZS9iYWNrZW5kL2dlbmVyYXRlZC1nby92MaICA0JYWKoCC0J5dGViYXNlLlYxygILQnl0ZWJhc2VcVjHiAhdCeXRlYmFzZVxWMVxHUEJNZXRhZGF0YeoCDEJ5dGViYXNlOjpWMWIGcHJvdG8z", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation, file_v1_common]);
+ fileDesc("Ch52MS9yZXZpZXdfY29uZmlnX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhoKGExpc3RSZXZpZXdDb25maWdzUmVxdWVzdCJOChlMaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlEjEKDnJldmlld19jb25maWdzGAEgAygLMhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIlIKGUNyZWF0ZVJldmlld0NvbmZpZ1JlcXVlc3QSNQoNcmV2aWV3X2NvbmZpZxgBIAEoCzIZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZ0ID4EECIpoBChlVcGRhdGVSZXZpZXdDb25maWdSZXF1ZXN0EjUKDXJldmlld19jb25maWcYASABKAsyGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWdCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJJChZHZXRSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyJMChlEZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyLHAQoMUmV2aWV3Q29uZmlnEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESDwoHZW5hYmxlZBgDIAEoCBIpCgVydWxlcxgHIAMoCzIaLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUSEQoJcmVzb3VyY2VzGAggAygJOjzqQTkKGWJ5dGViYXNlLmNvbS9SZXZpZXdDb25maWcSHHJldmlld0NvbmZpZ3Mve3Jldmlld0NvbmZpZ30iiCUKDVNRTFJldmlld1J1bGUSLQoEdHlwZRgBIAEoDjIfLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuVHlwZRIvCgVsZXZlbBgCIAEoDjIgLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuTGV2ZWwSRgoObmFtaW5nX3BheWxvYWQYAyABKAsyLC5ieXRlYmFzZS52MS5TUUxSZXZpZXdSdWxlLk5hbWluZ1J1bGVQYXlsb2FkSAASRgoObnVtYmVyX3BheWxvYWQYBCABKAsyLC5ieXRlYmFzZS52MS5TUUxSZXZpZXdSdWxlLk51bWJlclJ1bGVQYXlsb2FkSAASUQoUc3RyaW5nX2FycmF5X3BheWxvYWQYBSABKAsyMS5ieXRlYmFzZS52MS5TUUxSZXZpZXdSdWxlLlN0cmluZ0FycmF5UnVsZVBheWxvYWRIABJdChpjb21tZW50X2NvbnZlbnRpb25fcGF5bG9hZBgGIAEoCzI3LmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuQ29tbWVudENvbnZlbnRpb25SdWxlUGF5bG9hZEgAElcKF3JlcXVpcmVkX2NvbHVtbl9wYXlsb2FkGAcgASgLMjQuYnl0ZWJhc2UudjEuU1FMUmV2aWV3UnVsZS5SZXF1aXJlZENvbHVtblJ1bGVQYXlsb2FkSAASRgoOc3RyaW5nX3BheWxvYWQYCCABKAsyLC5ieXRlYmFzZS52MS5TUUxSZXZpZXdSdWxlLlN0cmluZ1J1bGVQYXlsb2FkSAASTwoTbmFtaW5nX2Nhc2VfcGF5bG9hZBgJIAEoCzIwLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuTmFtaW5nQ2FzZVJ1bGVQYXlsb2FkSAASIwoGZW5naW5lGAogASgOMhMuYnl0ZWJhc2UudjEuRW5naW5lGjcKEU5hbWluZ1J1bGVQYXlsb2FkEhIKCm1heF9sZW5ndGgYASABKAUSDgoGZm9ybWF0GAIgASgJGiMKEU51bWJlclJ1bGVQYXlsb2FkEg4KBm51bWJlchgBIAEoBRomChZTdHJpbmdBcnJheVJ1bGVQYXlsb2FkEgwKBGxpc3QYASADKAkaRAocQ29tbWVudENvbnZlbnRpb25SdWxlUGF5bG9hZBIQCghyZXF1aXJlZBgBIAEoCBISCgptYXhfbGVuZ3RoGAIgASgFGjAKGVJlcXVpcmVkQ29sdW1uUnVsZVBheWxvYWQSEwoLY29sdW1uX2xpc3QYASADKAkaIgoRU3RyaW5nUnVsZVBheWxvYWQSDQoFdmFsdWUYASABKAkaJgoVTmFtaW5nQ2FzZVJ1bGVQYXlsb2FkEg0KBXVwcGVyGAEgASgIIjYKBUxldmVsEhUKEUxFVkVMX1VOU1BFQ0lGSUVEEAASCQoFRVJST1IQARILCgdXQVJOSU5HEAIisBwKBFR5cGUSFAoQVFlQRV9VTlNQRUNJRklFRBAAEhsKF0VOR0lORV9NWVNRTF9VU0VfSU5OT0RCEAESGgoWTkFNSU5HX0ZVTExZX1FVQUxJRklFRBACEhAKDE5BTUlOR19UQUJMRRADEhEKDU5BTUlOR19DT0xVTU4QBBITCg9OQU1JTkdfSU5ERVhfUEsQBRITCg9OQU1JTkdfSU5ERVhfVUsQBhITCg9OQU1JTkdfSU5ERVhfRksQBxIUChBOQU1JTkdfSU5ERVhfSURYEAgSIAocTkFNSU5HX0NPTFVNTl9BVVRPX0lOQ1JFTUVOVBAJEhsKF05BTUlOR19UQUJMRV9OT19LRVlXT1JEEAoSIAocTkFNSU5HX0lERU5USUZJRVJfTk9fS0VZV09SRBALEhoKFk5BTUlOR19JREVOVElGSUVSX0NBU0UQDBIiCh5TVEFURU1FTlRfU0VMRUNUX05PX1NFTEVDVF9BTEwQDRIiCh5TVEFURU1FTlRfV0hFUkVfUkVRVUlSRV9TRUxFQ1QQDhIpCiVTVEFURU1FTlRfV0hFUkVfUkVRVUlSRV9VUERBVEVfREVMRVRFEA8SLAooU1RBVEVNRU5UX1dIRVJFX05PX0xFQURJTkdfV0lMRENBUkRfTElLRRAQEiUKIVNUQVRFTUVOVF9ESVNBTExPV19PTl9ERUxfQ0FTQ0FERRAREiUKIVNUQVRFTUVOVF9ESVNBTExPV19STV9UQkxfQ0FTQ0FERRASEh0KGVNUQVRFTUVOVF9ESVNBTExPV19DT01NSVQQExIcChhTVEFURU1FTlRfRElTQUxMT1dfTElNSVQQFBIfChtTVEFURU1FTlRfRElTQUxMT1dfT1JERVJfQlkQFRIfChtTVEFURU1FTlRfTUVSR0VfQUxURVJfVEFCTEUQFhIeChpTVEFURU1FTlRfSU5TRVJUX1JPV19MSU1JVBAXEigKJFNUQVRFTUVOVF9JTlNFUlRfTVVTVF9TUEVDSUZZX0NPTFVNThAYEisKJ1NUQVRFTUVOVF9JTlNFUlRfRElTQUxMT1dfT1JERVJfQllfUkFORBAZEiAKHFNUQVRFTUVOVF9BRkZFQ1RFRF9ST1dfTElNSVQQGhIZChVTVEFURU1FTlRfRE1MX0RSWV9SVU4QGxIuCipTVEFURU1FTlRfRElTQUxMT1dfQUREX0NPTFVNTl9XSVRIX0RFRkFVTFQQHBIhCh1TVEFURU1FTlRfQUREX0NIRUNLX05PVF9WQUxJRBAdEicKI1NUQVRFTUVOVF9BRERfRk9SRUlHTl9LRVlfTk9UX1ZBTElEEB4SIwofU1RBVEVNRU5UX0RJU0FMTE9XX0FERF9OT1RfTlVMTBAfEiQKIFNUQVRFTUVOVF9TRUxFQ1RfRlVMTF9UQUJMRV9TQ0FOECASIwofU1RBVEVNRU5UX0NSRUFURV9TUEVDSUZZX1NDSEVNQRAhEiUKIVNUQVRFTUVOVF9DSEVDS19TRVRfUk9MRV9WQVJJQUJMRRAiEiUKIVNUQVRFTUVOVF9ESVNBTExPV19VU0lOR19GSUxFU09SVBAjEiYKIlNUQVRFTUVOVF9ESVNBTExPV19VU0lOR19URU1QT1JBUlkQJBIhCh1TVEFURU1FTlRfV0hFUkVfTk9fRVFVQUxfTlVMTBAlEjcKM1NUQVRFTUVOVF9XSEVSRV9ESVNBTExPV19GVU5DVElPTlNfQU5EX0NBTENVTEFUSU9OUxAmEiYKIlNUQVRFTUVOVF9RVUVSWV9NSU5JTVVNX1BMQU5fTEVWRUwQJxIyCi5TVEFURU1FTlRfV0hFUkVfTUFYSU1VTV9MT0dJQ0FMX09QRVJBVE9SX0NPVU5UECgSIQodU1RBVEVNRU5UX01BWElNVU1fTElNSVRfVkFMVUUQKRImCiJTVEFURU1FTlRfTUFYSU1VTV9KT0lOX1RBQkxFX0NPVU5UECoSLworU1RBVEVNRU5UX01BWElNVU1fU1RBVEVNRU5UU19JTl9UUkFOU0FDVElPThArEiYKIlNUQVRFTUVOVF9KT0lOX1NUUklDVF9DT0xVTU5fQVRUUlMQLBIfChtTVEFURU1FTlRfTk9OX1RSQU5TQUNUSU9OQUwQLRIpCiVTVEFURU1FTlRfQUREX0NPTFVNTl9XSVRIT1VUX1BPU0lUSU9OEC4SIgoeU1RBVEVNRU5UX0RJU0FMTE9XX09GRkxJTkVfRERMEC8SJwojU1RBVEVNRU5UX0RJU0FMTE9XX0NST1NTX0RCX1FVRVJJRVMQMBIgChxTVEFURU1FTlRfTUFYX0VYRUNVVElPTl9USU1FEDESJgoiU1RBVEVNRU5UX1JFUVVJUkVfQUxHT1JJVEhNX09QVElPThAyEiEKHVNUQVRFTUVOVF9SRVFVSVJFX0xPQ0tfT1BUSU9OEDMSIAocU1RBVEVNRU5UX09CSkVDVF9PV05FUl9DSEVDSxA0EhQKEFRBQkxFX1JFUVVJUkVfUEsQNRIYChRUQUJMRV9OT19GT1JFSUdOX0tFWRA2EiAKHFRBQkxFX0RST1BfTkFNSU5HX0NPTlZFTlRJT04QNxIRCg1UQUJMRV9DT01NRU5UEDgSHAoYVEFCTEVfRElTQUxMT1dfUEFSVElUSU9OEDkSGgoWVEFCTEVfRElTQUxMT1dfVFJJR0dFUhA6EhwKGFRBQkxFX05PX0RVUExJQ0FURV9JTkRFWBA7EiIKHlRBQkxFX1RFWFRfRklFTERTX1RPVEFMX0xFTkdUSBA8Eh4KGlRBQkxFX0RJU0FMTE9XX1NFVF9DSEFSU0VUED0SFgoSVEFCTEVfRElTQUxMT1dfRERMED4SFgoSVEFCTEVfRElTQUxMT1dfRE1MED8SFAoQVEFCTEVfTElNSVRfU0laRRBAEhkKFVRBQkxFX1JFUVVJUkVfQ0hBUlNFVBBBEhsKF1RBQkxFX1JFUVVJUkVfQ09MTEFUSU9OEEISEwoPQ09MVU1OX1JFUVVJUkVEEEMSEgoOQ09MVU1OX05PX05VTEwQRBIfChtDT0xVTU5fRElTQUxMT1dfQ0hBTkdFX1RZUEUQRRIjCh9DT0xVTU5fU0VUX0RFRkFVTFRfRk9SX05PVF9OVUxMEEYSGgoWQ09MVU1OX0RJU0FMTE9XX0NIQU5HRRBHEiIKHkNPTFVNTl9ESVNBTExPV19DSEFOR0lOR19PUkRFUhBIEhgKFENPTFVNTl9ESVNBTExPV19EUk9QEEkSIQodQ09MVU1OX0RJU0FMTE9XX0RST1BfSU5fSU5ERVgQShISCg5DT0xVTU5fQ09NTUVOVBBLEiYKIkNPTFVNTl9BVVRPX0lOQ1JFTUVOVF9NVVNUX0lOVEVHRVIQTBIdChlDT0xVTU5fVFlQRV9ESVNBTExPV19MSVNUEE0SHwobQ09MVU1OX0RJU0FMTE9XX1NFVF9DSEFSU0VUEE4SIwofQ09MVU1OX01BWElNVU1fQ0hBUkFDVEVSX0xFTkdUSBBPEiEKHUNPTFVNTl9NQVhJTVVNX1ZBUkNIQVJfTEVOR1RIEFASJwojQ09MVU1OX0FVVE9fSU5DUkVNRU5UX0lOSVRJQUxfVkFMVUUQURInCiNDT0xVTU5fQVVUT19JTkNSRU1FTlRfTVVTVF9VTlNJR05FRBBSEiMKH0NPTFVNTl9DVVJSRU5UX1RJTUVfQ09VTlRfTElNSVQQUxIaChZDT0xVTU5fUkVRVUlSRV9ERUZBVUxUEFQSJAogQ09MVU1OX0RFRkFVTFRfRElTQUxMT1dfVk9MQVRJTEUQVRInCiNDT0xVTU5fQUREX05PVF9OVUxMX1JFUVVJUkVfREVGQVVMVBBWEhoKFkNPTFVNTl9SRVFVSVJFX0NIQVJTRVQQVxIcChhDT0xVTU5fUkVRVUlSRV9DT0xMQVRJT04QWBIhCh1TQ0hFTUFfQkFDS1dBUkRfQ09NUEFUSUJJTElUWRBZEiAKHERBVEFCQVNFX0RST1BfRU1QVFlfREFUQUJBU0UQWhIdChlJTkRFWF9OT19EVVBMSUNBVEVfQ09MVU1OEFsSGgoWSU5ERVhfS0VZX05VTUJFUl9MSU1JVBBcEhcKE0lOREVYX1BLX1RZUEVfTElNSVQQXRIWChJJTkRFWF9UWVBFX05PX0JMT0IQXhIcChhJTkRFWF9UT1RBTF9OVU1CRVJfTElNSVQQXxIkCiBJTkRFWF9QUklNQVJZX0tFWV9UWVBFX0FMTE9XTElTVBBgEh0KGUlOREVYX0NSRUFURV9DT05DVVJSRU5UTFkQYRIZChVJTkRFWF9UWVBFX0FMTE9XX0xJU1QQYhIXChNJTkRFWF9OT1RfUkVEVU5EQU5UEGMSHAoYU1lTVEVNX0NIQVJTRVRfQUxMT1dMSVNUEGQSHgoaU1lTVEVNX0NPTExBVElPTl9BTExPV0xJU1QQZRIZChVTWVNURU1fQ09NTUVOVF9MRU5HVEgQZhIkCiBTWVNURU1fUFJPQ0VEVVJFX0RJU0FMTE9XX0NSRUFURRBnEiAKHFNZU1RFTV9FVkVOVF9ESVNBTExPV19DUkVBVEUQaBIfChtTWVNURU1fVklFV19ESVNBTExPV19DUkVBVEUQaRIjCh9TWVNURU1fRlVOQ1RJT05fRElTQUxMT1dfQ1JFQVRFEGoSIwofU1lTVEVNX0ZVTkNUSU9OX0RJU0FMTE9XRURfTElTVBBrEhsKF0FEVklDRV9PTkxJTkVfTUlHUkFUSU9OEGwSHgoaQlVJTFRJTl9QUklPUl9CQUNLVVBfQ0hFQ0sQbUIJCgdwYXlsb2FkMu0GChNSZXZpZXdDb25maWdTZXJ2aWNlEqMBChJDcmVhdGVSZXZpZXdDb25maWcSJi5ieXRlYmFzZS52MS5DcmVhdGVSZXZpZXdDb25maWdSZXF1ZXN0GhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIkraQQCK6jAXYmIucmV2aWV3Q29uZmlncy5jcmVhdGWQ6jABgtPkkwIiOg1yZXZpZXdfY29uZmlnIhEvdjEvcmV2aWV3Q29uZmlncxKdAQoRTGlzdFJldmlld0NvbmZpZ3MSJS5ieXRlYmFzZS52MS5MaXN0UmV2aWV3Q29uZmlnc1JlcXVlc3QaJi5ieXRlYmFzZS52MS5MaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlIjnaQQCK6jAVYmIucmV2aWV3Q29uZmlncy5saXN0kOowAYLT5JMCExIRL3YxL3Jldmlld0NvbmZpZ3MSmAEKD0dldFJldmlld0NvbmZpZxIjLmJ5dGViYXNlLnYxLkdldFJldmlld0NvbmZpZ1JlcXVlc3QaGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWciRdpBBG5hbWWK6jAUYmIucmV2aWV3Q29uZmlncy5nZXSQ6jABgtPkkwIcEhovdjEve25hbWU9cmV2aWV3Q29uZmlncy8qfRLTAQoSVXBkYXRlUmV2aWV3Q29uZmlnEiYuYnl0ZWJhc2UudjEuVXBkYXRlUmV2aWV3Q29uZmlnUmVxdWVzdBoZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZyJ62kEZcmV2aWV3X2NvbmZpZyx1cGRhdGVfbWFza4rqMBdiYi5yZXZpZXdDb25maWdzLnVwZGF0ZZDqMAGC0+STAjk6DXJldmlld19jb25maWcyKC92MS97cmV2aWV3X2NvbmZpZy5uYW1lPXJldmlld0NvbmZpZ3MvKn0SngEKEkRlbGV0ZVJldmlld0NvbmZpZxImLmJ5dGViYXNlLnYxLkRlbGV0ZVJldmlld0NvbmZpZ1JlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiSNpBBG5hbWWK6jAXYmIucmV2aWV3Q29uZmlncy5kZWxldGWQ6jABgtPkkwIcKhovdjEve25hbWU9cmV2aWV3Q29uZmlncy8qfUKuAQoPY29tLmJ5dGViYXNlLnYxQhhSZXZpZXdDb25maWdTZXJ2aWNlUHJvdG9QAVo0Z2l0aHViLmNvbS9ieXRlYmFzZS9ieXRlYmFzZS9iYWNrZW5kL2dlbmVyYXRlZC1nby92MaICA0JYWKoCC0J5dGViYXNlLlYxygILQnl0ZWJhc2VcVjHiAhdCeXRlYmFzZVxWMVxHUEJNZXRhZGF0YeoCDEJ5dGViYXNlOjpWMWIGcHJvdG8z", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation, file_v1_common]);
/**
* Describes the message bytebase.v1.ListReviewConfigsRequest.
@@ -74,6 +74,55 @@ export const ReviewConfigSchema = /*@__PURE__*/
export const SQLReviewRuleSchema = /*@__PURE__*/
messageDesc(file_v1_review_config_service, 7);
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NamingRulePayload.
+ * Use `create(SQLReviewRule_NamingRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_NamingRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 0);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NumberRulePayload.
+ * Use `create(SQLReviewRule_NumberRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_NumberRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 1);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.StringArrayRulePayload.
+ * Use `create(SQLReviewRule_StringArrayRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_StringArrayRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 2);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.CommentConventionRulePayload.
+ * Use `create(SQLReviewRule_CommentConventionRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_CommentConventionRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 3);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.RequiredColumnRulePayload.
+ * Use `create(SQLReviewRule_RequiredColumnRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_RequiredColumnRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 4);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.StringRulePayload.
+ * Use `create(SQLReviewRule_StringRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_StringRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 5);
+
+/**
+ * Describes the message bytebase.v1.SQLReviewRule.NamingCaseRulePayload.
+ * Use `create(SQLReviewRule_NamingCaseRulePayloadSchema)` to create a new message.
+ */
+export const SQLReviewRule_NamingCaseRulePayloadSchema = /*@__PURE__*/
+ messageDesc(file_v1_review_config_service, 7, 6);
+
/**
* Describes the enum bytebase.v1.SQLReviewRule.Level.
*/
diff --git a/frontend/src/types/sqlReview.ts b/frontend/src/types/sqlReview.ts
index da84893df6..f3ca31d7b8 100644
--- a/frontend/src/types/sqlReview.ts
+++ b/frontend/src/types/sqlReview.ts
@@ -1,8 +1,17 @@
+import { create } from "@bufbuild/protobuf";
import { t, te } from "@/plugins/i18n";
import { Engine } from "@/types/proto-es/v1/common_pb";
+import type { SQLReviewRule } from "@/types/proto-es/v1/review_config_service_pb";
import {
+ SQLReviewRule_CommentConventionRulePayloadSchema,
SQLReviewRule_Level,
+ SQLReviewRule_NamingCaseRulePayloadSchema,
+ SQLReviewRule_NamingRulePayloadSchema,
+ SQLReviewRule_NumberRulePayloadSchema,
+ SQLReviewRule_StringArrayRulePayloadSchema,
+ SQLReviewRule_StringRulePayloadSchema,
SQLReviewRule_Type,
+ SQLReviewRuleSchema,
} from "@/types/proto-es/v1/review_config_service_pb";
import sqlReviewDevTemplate from "./sql-review.dev.yaml";
import sqlReviewProdTemplate from "./sql-review.prod.yaml";
@@ -62,58 +71,9 @@ export interface RuleConfigComponent {
| BooleanPayload;
}
-// The naming format rule payload.
-// Used by the backend.
-interface NamingFormatPayload {
- format: string;
- maxLength?: number;
-}
-
-// The string array rule payload.
-// Used by the backend.
-interface StringArrayLimitPayload {
- list: string[];
-}
-
-// The comment format rule payload.
-// Used by the backend.
-interface CommentFormatPayload {
- required: boolean;
- maxLength: number;
-}
-
-// The number value rule payload.
-// Used by the backend.
-interface NumberValuePayload {
- number: number;
-}
-
-// The string value rule payload.
-// Used by the backend.
-interface StringValuePayload {
- string: string;
-}
-
-// The case rule payload.
-// Used by the backend.
-interface CasePayload {
- upper: boolean;
-}
-
-// The SchemaPolicyRule stores the rule configuration by users.
-// Used by the backend
-export interface SchemaPolicyRule {
- type: string;
- level: SQLReviewRule_Level;
- engine: Engine;
- payload?:
- | NamingFormatPayload
- | StringArrayLimitPayload
- | CommentFormatPayload
- | NumberValuePayload
- | StringValuePayload
- | CasePayload;
-}
+// SchemaPolicyRule is an alias for the proto SQLReviewRule type.
+// We use the proto type directly instead of maintaining a separate interface.
+export type SchemaPolicyRule = SQLReviewRule;
// The API for SQL review policy in backend.
export interface SQLReviewPolicy {
@@ -310,9 +270,9 @@ export const convertPolicyRuleToRuleTemplate = (
policyRule: SchemaPolicyRule,
ruleTemplate: RuleTemplateV2
): RuleTemplateV2 => {
- if (policyRule.type !== ruleTypeToString(ruleTemplate.type)) {
+ if (policyRule.type !== ruleTemplate.type) {
throw new Error(
- `The rule type is not same. policyRule:${policyRule.type}, ruleTemplate:${ruleTypeToString(ruleTemplate.type)}`
+ `The rule type is not same. policyRule:${policyRule.type}, ruleTemplate:${ruleTemplate.type}`
);
}
@@ -327,7 +287,11 @@ export const convertPolicyRuleToRuleTemplate = (
return res;
}
- const payload = policyRule?.payload ?? {};
+ // Extract payload value from proto oneof
+ let payload: any = {};
+ if (policyRule?.payload?.case) {
+ payload = policyRule.payload.value;
+ }
const stringComponent = componentList.find(
(c) => c.payload.type === "STRING"
@@ -358,7 +322,7 @@ export const convertPolicyRuleToRuleTemplate = (
...stringComponent,
payload: {
...stringComponent.payload,
- value: (payload as StringValuePayload).string,
+ value: payload.value, // proto field is 'value'
} as StringPayload,
},
],
@@ -376,7 +340,7 @@ export const convertPolicyRuleToRuleTemplate = (
...stringComponent,
payload: {
...stringComponent.payload,
- value: (payload as NamingFormatPayload).format,
+ value: payload.format,
} as StringPayload,
},
],
@@ -396,14 +360,14 @@ export const convertPolicyRuleToRuleTemplate = (
...stringComponent,
payload: {
...stringComponent.payload,
- value: (payload as NamingFormatPayload).format,
+ value: payload.format,
} as StringPayload,
},
{
...numberComponent,
payload: {
...numberComponent.payload,
- value: (payload as NamingFormatPayload).maxLength,
+ value: payload.maxLength,
} as NumberPayload,
},
],
@@ -421,7 +385,7 @@ export const convertPolicyRuleToRuleTemplate = (
...templateComponent,
payload: {
...templateComponent.payload,
- value: (payload as NamingFormatPayload).format,
+ value: payload.format,
} as TemplatePayload,
},
],
@@ -441,14 +405,14 @@ export const convertPolicyRuleToRuleTemplate = (
...templateComponent,
payload: {
...templateComponent.payload,
- value: (payload as NamingFormatPayload).format,
+ value: payload.format,
} as TemplatePayload,
},
{
...numberComponent,
payload: {
...numberComponent.payload,
- value: (payload as NamingFormatPayload).maxLength,
+ value: payload.maxLength,
} as NumberPayload,
},
],
@@ -469,12 +433,8 @@ export const convertPolicyRuleToRuleTemplate = (
};
case SQLReviewRule_Type.COLUMN_REQUIRED: {
const requiredColumnComponent = componentList[0];
- // The columnList payload is deprecated.
- // Just keep it to compatible with old data, we can remove this later.
- let value: string[] = (payload as any)["columnList"];
- if (!value) {
- value = (payload as StringArrayLimitPayload).list;
- }
+ // Proto uses stringArrayPayload with 'list' field
+ const value = payload.list || [];
const requiredColumnPayload = {
...requiredColumnComponent.payload,
value,
@@ -503,7 +463,7 @@ export const convertPolicyRuleToRuleTemplate = (
}
const stringArrayPayload = {
...stringArrayComponent.payload,
- value: (payload as StringArrayLimitPayload).list,
+ value: payload.list || [],
} as StringArrayPayload;
return {
...res,
@@ -531,14 +491,14 @@ export const convertPolicyRuleToRuleTemplate = (
...requireComponent,
payload: {
...requireComponent.payload,
- value: (payload as CommentFormatPayload).required,
+ value: payload.required,
} as BooleanPayload,
},
{
...numberComponent,
payload: {
...numberComponent.payload,
- value: (payload as CommentFormatPayload).maxLength,
+ value: payload.maxLength,
} as NumberPayload,
},
],
@@ -571,7 +531,7 @@ export const convertPolicyRuleToRuleTemplate = (
...numberComponent,
payload: {
...numberComponent.payload,
- value: (payload as NumberValuePayload).number,
+ value: payload.number,
} as NumberPayload,
},
],
@@ -608,7 +568,10 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- string: stringPayload.value ?? stringPayload.default,
+ case: "stringPayload",
+ value: create(SQLReviewRule_StringRulePayloadSchema, {
+ value: stringPayload.value ?? stringPayload.default,
+ }),
},
};
// Following rules require STRING component.
@@ -620,7 +583,11 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- format: stringPayload.value ?? stringPayload.default,
+ case: "namingPayload",
+ value: create(SQLReviewRule_NamingRulePayloadSchema, {
+ format: stringPayload.value ?? stringPayload.default,
+ maxLength: 0,
+ }),
},
};
// Following rules require STRING and NUMBER component.
@@ -634,8 +601,11 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- format: stringPayload.value ?? stringPayload.default,
- maxLength: numberPayload.value ?? numberPayload.default,
+ case: "namingPayload",
+ value: create(SQLReviewRule_NamingRulePayloadSchema, {
+ format: stringPayload.value ?? stringPayload.default,
+ maxLength: numberPayload.value ?? numberPayload.default,
+ }),
},
};
// Following rules require TEMPLATE component.
@@ -646,7 +616,11 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- format: templatePayload.value ?? templatePayload.default,
+ case: "namingPayload",
+ value: create(SQLReviewRule_NamingRulePayloadSchema, {
+ format: templatePayload.value ?? templatePayload.default,
+ maxLength: 0,
+ }),
},
};
// Following rules require TEMPLATE and NUMBER component.
@@ -659,8 +633,11 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- format: templatePayload.value ?? templatePayload.default,
- maxLength: numberPayload.value ?? numberPayload.default,
+ case: "namingPayload",
+ value: create(SQLReviewRule_NamingRulePayloadSchema, {
+ format: templatePayload.value ?? templatePayload.default,
+ maxLength: numberPayload.value ?? numberPayload.default,
+ }),
},
};
// Following rules require BOOLEAN component.
@@ -671,7 +648,10 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- upper: booleanPayload.value ?? booleanPayload.default,
+ case: "namingCasePayload",
+ value: create(SQLReviewRule_NamingCaseRulePayloadSchema, {
+ upper: booleanPayload.value ?? booleanPayload.default,
+ }),
},
};
// Following rules require STRING_ARRAY component.
@@ -690,7 +670,10 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- list: stringArrayPayload.value ?? stringArrayPayload.default,
+ case: "stringArrayPayload",
+ value: create(SQLReviewRule_StringArrayRulePayloadSchema, {
+ list: stringArrayPayload.value ?? stringArrayPayload.default,
+ }),
},
};
}
@@ -706,8 +689,11 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- required: requirePayload.value ?? requirePayload.default,
- maxLength: numberPayload.value ?? numberPayload.default,
+ case: "commentConventionPayload",
+ value: create(SQLReviewRule_CommentConventionRulePayloadSchema, {
+ required: requirePayload.value ?? requirePayload.default,
+ maxLength: numberPayload.value ?? numberPayload.default,
+ }),
},
};
}
@@ -733,7 +719,10 @@ const mergeIndividualConfigAsRule = (
return {
...base,
payload: {
- number: numberPayload.value ?? numberPayload.default,
+ case: "numberPayload",
+ value: create(SQLReviewRule_NumberRulePayloadSchema, {
+ number: numberPayload.value ?? numberPayload.default,
+ }),
},
};
}
@@ -760,11 +749,12 @@ export const convertRuleMapToPolicyRuleList = (
const convertRuleTemplateToPolicyRule = (
rule: RuleTemplateV2
): SchemaPolicyRule => {
- const base: SchemaPolicyRule = {
- type: ruleTypeToString(rule.type),
+ const base: SchemaPolicyRule = create(SQLReviewRuleSchema, {
+ type: rule.type,
level: rule.level,
engine: rule.engine,
- };
+ // payload will be set by mergeIndividualConfigAsRule if componentList is not empty
+ });
if ((rule.componentList?.length ?? 0) === 0) {
return base;
}
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 71b7e9d8ff..bcfa8c1a61 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -13489,9 +13489,20 @@ components:
type: string
description: The severity level of the rule.
format: enum
- payload:
- type: string
- description: The payload is a JSON string that varies by rule type.
+ namingPayload:
+ $ref: '#/components/schemas/SQLReviewRule_NamingRulePayload'
+ numberPayload:
+ $ref: '#/components/schemas/SQLReviewRule_NumberRulePayload'
+ stringArrayPayload:
+ $ref: '#/components/schemas/SQLReviewRule_StringArrayRulePayload'
+ commentConventionPayload:
+ $ref: '#/components/schemas/SQLReviewRule_CommentConventionRulePayload'
+ requiredColumnPayload:
+ $ref: '#/components/schemas/SQLReviewRule_RequiredColumnRulePayload'
+ stringPayload:
+ $ref: '#/components/schemas/SQLReviewRule_StringRulePayload'
+ namingCasePayload:
+ $ref: '#/components/schemas/SQLReviewRule_NamingCaseRulePayload'
engine:
enum:
- ENGINE_UNSPECIFIED
@@ -13524,6 +13535,53 @@ components:
description: The database engine this rule applies to.
format: enum
description: SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
+ SQLReviewRule_CommentConventionRulePayload:
+ type: object
+ properties:
+ required:
+ type: boolean
+ maxLength:
+ type: integer
+ format: int32
+ SQLReviewRule_NamingCaseRulePayload:
+ type: object
+ properties:
+ upper:
+ type: boolean
+ SQLReviewRule_NamingRulePayload:
+ type: object
+ properties:
+ maxLength:
+ type: integer
+ format: int32
+ format:
+ type: string
+ description: Payload message types for SQL review rules
+ SQLReviewRule_NumberRulePayload:
+ type: object
+ properties:
+ number:
+ type: integer
+ format: int32
+ SQLReviewRule_RequiredColumnRulePayload:
+ type: object
+ properties:
+ columnList:
+ type: array
+ items:
+ type: string
+ SQLReviewRule_StringArrayRulePayload:
+ type: object
+ properties:
+ list:
+ type: array
+ items:
+ type: string
+ SQLReviewRule_StringRulePayload:
+ type: object
+ properties:
+ value:
+ type: string
SchedulerInfo_WaitingCause:
type: object
properties:
diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.md
index 620240b515..07d6d89789 100644
--- a/proto/gen/grpc-doc/store/README.md
+++ b/proto/gen/grpc-doc/store/README.md
@@ -244,6 +244,13 @@
- [store/review_config.proto](#store_review_config-proto)
- [ReviewConfigPayload](#bytebase-store-ReviewConfigPayload)
- [SQLReviewRule](#bytebase-store-SQLReviewRule)
+ - [SQLReviewRule.CommentConventionRulePayload](#bytebase-store-SQLReviewRule-CommentConventionRulePayload)
+ - [SQLReviewRule.NamingCaseRulePayload](#bytebase-store-SQLReviewRule-NamingCaseRulePayload)
+ - [SQLReviewRule.NamingRulePayload](#bytebase-store-SQLReviewRule-NamingRulePayload)
+ - [SQLReviewRule.NumberRulePayload](#bytebase-store-SQLReviewRule-NumberRulePayload)
+ - [SQLReviewRule.RequiredColumnRulePayload](#bytebase-store-SQLReviewRule-RequiredColumnRulePayload)
+ - [SQLReviewRule.StringArrayRulePayload](#bytebase-store-SQLReviewRule-StringArrayRulePayload)
+ - [SQLReviewRule.StringRulePayload](#bytebase-store-SQLReviewRule-StringRulePayload)
- [SQLReviewRule.Level](#bytebase-store-SQLReviewRule-Level)
- [SQLReviewRule.Type](#bytebase-store-SQLReviewRule-Type)
@@ -4010,13 +4017,126 @@ ISSUE_CREATE represents creating an issue. |
| ----- | ---- | ----- | ----------- |
| type | [SQLReviewRule.Type](#bytebase-store-SQLReviewRule-Type) | | |
| level | [SQLReviewRule.Level](#bytebase-store-SQLReviewRule-Level) | | |
-| payload | [string](#string) | | |
+| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-store-SQLReviewRule-NamingRulePayload) | | |
+| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-store-SQLReviewRule-NumberRulePayload) | | |
+| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-store-SQLReviewRule-StringArrayRulePayload) | | |
+| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-store-SQLReviewRule-CommentConventionRulePayload) | | |
+| required_column_payload | [SQLReviewRule.RequiredColumnRulePayload](#bytebase-store-SQLReviewRule-RequiredColumnRulePayload) | | |
+| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-store-SQLReviewRule-StringRulePayload) | | |
+| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-store-SQLReviewRule-NamingCaseRulePayload) | | |
| engine | [Engine](#bytebase-store-Engine) | | |
+
+<a name="bytebase-store-SQLReviewRule-CommentConventionRulePayload"></a>
+
+### SQLReviewRule.CommentConventionRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| required | [bool](#bool) | | |
+| max_length | [int32](#int32) | | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-NamingCaseRulePayload"></a>
+
+### SQLReviewRule.NamingCaseRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| upper | [bool](#bool) | | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-NamingRulePayload"></a>
+
+### SQLReviewRule.NamingRulePayload
+Payload message types for SQL review rules
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| max_length | [int32](#int32) | | |
+| format | [string](#string) | | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-NumberRulePayload"></a>
+
+### SQLReviewRule.NumberRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| number | [int32](#int32) | | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-RequiredColumnRulePayload"></a>
+
+### SQLReviewRule.RequiredColumnRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| column_list | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-StringArrayRulePayload"></a>
+
+### SQLReviewRule.StringArrayRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| list | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-store-SQLReviewRule-StringRulePayload"></a>
+
+### SQLReviewRule.StringRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| value | [string](#string) | | |
+
+
+
+
+
diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.html
index 7fa5c34e1b..41f71b7b3c 100644
--- a/proto/gen/grpc-doc/store/index.html
+++ b/proto/gen/grpc-doc/store/index.html
@@ -1145,6 +1145,34 @@
<a href="#bytebase.store.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a>
</li>
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.NamingCaseRulePayload"><span class="badge">M</span>SQLReviewRule.NamingCaseRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.NamingRulePayload"><span class="badge">M</span>SQLReviewRule.NamingRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.NumberRulePayload"><span class="badge">M</span>SQLReviewRule.NumberRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.RequiredColumnRulePayload"><span class="badge">M</span>SQLReviewRule.RequiredColumnRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.StringArrayRulePayload"><span class="badge">M</span>SQLReviewRule.StringArrayRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.store.SQLReviewRule.StringRulePayload"><span class="badge">M</span>SQLReviewRule.StringRulePayload</a>
+ </li>
+
<li>
<a href="#bytebase.store.SQLReviewRule.Level"><span class="badge">E</span>SQLReviewRule.Level</a>
@@ -10839,8 +10867,50 @@ Format: projects/{project}/sheets/{sheet} </p></td>
</tr>
<tr>
- <td>payload</td>
- <td><a href="#string">string</a></td>
+ <td>naming_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>number_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>string_array_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>comment_convention_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>required_column_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.RequiredColumnRulePayload">SQLReviewRule.RequiredColumnRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>string_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>naming_case_payload</td>
+ <td><a href="#bytebase.store.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -10859,6 +10929,188 @@ Format: projects/{project}/sheets/{sheet} </p></td>
+ <h3 id="bytebase.store.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>required</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>upper</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
+ <p>Payload message types for SQL review rules</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>number</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.RequiredColumnRulePayload">SQLReviewRule.RequiredColumnRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>column_list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.store.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
<h3 id="bytebase.store.SQLReviewRule.Level">SQLReviewRule.Level</h3>
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index 135ca8e11e..fd8a4bb27f 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -547,6 +547,13 @@
- [ListReviewConfigsResponse](#bytebase-v1-ListReviewConfigsResponse)
- [ReviewConfig](#bytebase-v1-ReviewConfig)
- [SQLReviewRule](#bytebase-v1-SQLReviewRule)
+ - [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload)
+ - [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload)
+ - [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload)
+ - [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload)
+ - [SQLReviewRule.RequiredColumnRulePayload](#bytebase-v1-SQLReviewRule-RequiredColumnRulePayload)
+ - [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload)
+ - [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload)
- [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest)
- [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level)
@@ -9006,7 +9013,13 @@ SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for d
| ----- | ---- | ----- | ----------- |
| type | [SQLReviewRule.Type](#bytebase-v1-SQLReviewRule-Type) | | The type of SQL review rule. |
| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
-| payload | [string](#string) | | The payload is a JSON string that varies by rule type. |
+| naming_payload | [SQLReviewRule.NamingRulePayload](#bytebase-v1-SQLReviewRule-NamingRulePayload) | | |
+| number_payload | [SQLReviewRule.NumberRulePayload](#bytebase-v1-SQLReviewRule-NumberRulePayload) | | |
+| string_array_payload | [SQLReviewRule.StringArrayRulePayload](#bytebase-v1-SQLReviewRule-StringArrayRulePayload) | | |
+| comment_convention_payload | [SQLReviewRule.CommentConventionRulePayload](#bytebase-v1-SQLReviewRule-CommentConventionRulePayload) | | |
+| required_column_payload | [SQLReviewRule.RequiredColumnRulePayload](#bytebase-v1-SQLReviewRule-RequiredColumnRulePayload) | | |
+| string_payload | [SQLReviewRule.StringRulePayload](#bytebase-v1-SQLReviewRule-StringRulePayload) | | |
+| naming_case_payload | [SQLReviewRule.NamingCaseRulePayload](#bytebase-v1-SQLReviewRule-NamingCaseRulePayload) | | |
| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
@@ -9014,6 +9027,113 @@ SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for d
+<a name="bytebase-v1-SQLReviewRule-CommentConventionRulePayload"></a>
+
+### SQLReviewRule.CommentConventionRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| required | [bool](#bool) | | |
+| max_length | [int32](#int32) | | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-NamingCaseRulePayload"></a>
+
+### SQLReviewRule.NamingCaseRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| upper | [bool](#bool) | | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-NamingRulePayload"></a>
+
+### SQLReviewRule.NamingRulePayload
+Payload message types for SQL review rules
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| max_length | [int32](#int32) | | |
+| format | [string](#string) | | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-NumberRulePayload"></a>
+
+### SQLReviewRule.NumberRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| number | [int32](#int32) | | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-RequiredColumnRulePayload"></a>
+
+### SQLReviewRule.RequiredColumnRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| column_list | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-StringArrayRulePayload"></a>
+
+### SQLReviewRule.StringArrayRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| list | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-v1-SQLReviewRule-StringRulePayload"></a>
+
+### SQLReviewRule.StringRulePayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| value | [string](#string) | | |
+
+
+
+
+
+
<a name="bytebase-v1-UpdateReviewConfigRequest"></a>
### UpdateReviewConfigRequest
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 8e1e31c328..fb21a1f15f 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -2268,6 +2268,34 @@
<a href="#bytebase.v1.SQLReviewRule"><span class="badge">M</span>SQLReviewRule</a>
</li>
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload"><span class="badge">M</span>SQLReviewRule.CommentConventionRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload"><span class="badge">M</span>SQLReviewRule.NamingCaseRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.NamingRulePayload"><span class="badge">M</span>SQLReviewRule.NamingRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.NumberRulePayload"><span class="badge">M</span>SQLReviewRule.NumberRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.RequiredColumnRulePayload"><span class="badge">M</span>SQLReviewRule.RequiredColumnRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload"><span class="badge">M</span>SQLReviewRule.StringArrayRulePayload</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SQLReviewRule.StringRulePayload"><span class="badge">M</span>SQLReviewRule.StringRulePayload</a>
+ </li>
+
<li>
<a href="#bytebase.v1.UpdateReviewConfigRequest"><span class="badge">M</span>UpdateReviewConfigRequest</a>
</li>
@@ -25234,10 +25262,52 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
</tr>
<tr>
- <td>payload</td>
- <td><a href="#string">string</a></td>
+ <td>naming_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>number_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</a></td>
<td></td>
- <td><p>The payload is a JSON string that varies by rule type. </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>string_array_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>comment_convention_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>required_column_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.RequiredColumnRulePayload">SQLReviewRule.RequiredColumnRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>string_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>naming_case_payload</td>
+ <td><a href="#bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
<tr>
@@ -25254,6 +25324,188 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
+ <h3 id="bytebase.v1.SQLReviewRule.CommentConventionRulePayload">SQLReviewRule.CommentConventionRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>required</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.NamingCaseRulePayload">SQLReviewRule.NamingCaseRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>upper</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.NamingRulePayload">SQLReviewRule.NamingRulePayload</h3>
+ <p>Payload message types for SQL review rules</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>max_length</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>format</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.NumberRulePayload">SQLReviewRule.NumberRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>number</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.RequiredColumnRulePayload">SQLReviewRule.RequiredColumnRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>column_list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringArrayRulePayload">SQLReviewRule.StringArrayRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>list</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SQLReviewRule.StringRulePayload">SQLReviewRule.StringRulePayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
<h3 id="bytebase.v1.UpdateReviewConfigRequest">UpdateReviewConfigRequest</h3>
<p></p>
diff --git a/proto/store/store/review_config.proto b/proto/store/store/review_config.proto
index 58eac75774..488719c3cc 100644
--- a/proto/store/store/review_config.proto
+++ b/proto/store/store/review_config.proto
@@ -11,6 +11,37 @@ message ReviewConfigPayload {
}
message SQLReviewRule {
+ // Payload message types for SQL review rules
+ message NamingRulePayload {
+ int32 max_length = 1;
+ string format = 2;
+ }
+
+ message NumberRulePayload {
+ int32 number = 1;
+ }
+
+ message StringArrayRulePayload {
+ repeated string list = 1;
+ }
+
+ message CommentConventionRulePayload {
+ bool required = 1;
+ int32 max_length = 2;
+ }
+
+ message RequiredColumnRulePayload {
+ repeated string column_list = 1;
+ }
+
+ message StringRulePayload {
+ string value = 1;
+ }
+
+ message NamingCaseRulePayload {
+ bool upper = 1;
+ }
+
// The severity level for SQL review rules.
enum Level {
// Unspecified level.
@@ -136,6 +167,16 @@ message SQLReviewRule {
Type type = 1;
Level level = 2;
- string payload = 3;
- Engine engine = 4;
+
+ oneof payload {
+ NamingRulePayload naming_payload = 3;
+ NumberRulePayload number_payload = 4;
+ StringArrayRulePayload string_array_payload = 5;
+ CommentConventionRulePayload comment_convention_payload = 6;
+ RequiredColumnRulePayload required_column_payload = 7;
+ StringRulePayload string_payload = 8;
+ NamingCaseRulePayload naming_case_payload = 9;
+ }
+
+ Engine engine = 10;
}
diff --git a/proto/v1/v1/review_config_service.proto b/proto/v1/v1/review_config_service.proto
index bb3c6a8c82..e03a08a5a3 100644
--- a/proto/v1/v1/review_config_service.proto
+++ b/proto/v1/v1/review_config_service.proto
@@ -139,6 +139,37 @@ message ReviewConfig {
// SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
message SQLReviewRule {
+ // Payload message types for SQL review rules
+ message NamingRulePayload {
+ int32 max_length = 1;
+ string format = 2;
+ }
+
+ message NumberRulePayload {
+ int32 number = 1;
+ }
+
+ message StringArrayRulePayload {
+ repeated string list = 1;
+ }
+
+ message CommentConventionRulePayload {
+ bool required = 1;
+ int32 max_length = 2;
+ }
+
+ message RequiredColumnRulePayload {
+ repeated string column_list = 1;
+ }
+
+ message StringRulePayload {
+ string value = 1;
+ }
+
+ message NamingCaseRulePayload {
+ bool upper = 1;
+ }
+
// The severity level for SQL review rules.
enum Level {
// Unspecified level.
@@ -267,8 +298,17 @@ message SQLReviewRule {
// The severity level of the rule.
Level level = 2;
- // The payload is a JSON string that varies by rule type.
- string payload = 3;
+ // The payload is a typed message that varies by rule type.
+ oneof payload {
+ NamingRulePayload naming_payload = 3;
+ NumberRulePayload number_payload = 4;
+ StringArrayRulePayload string_array_payload = 5;
+ CommentConventionRulePayload comment_convention_payload = 6;
+ RequiredColumnRulePayload required_column_payload = 7;
+ StringRulePayload string_payload = 8;
+ NamingCaseRulePayload naming_case_payload = 9;
+ }
+
// The database engine this rule applies to.
- Engine engine = 4;
+ Engine engine = 10;
}