Skip to content

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

fix(advisor): correct line position and refactor statement text architecture (#18529)

h3n4l59959b1c9444
diff --git a/backend/plugin/advisor/mssql/rule_table_no_foreign_key.go b/backend/plugin/advisor/mssql/rule_table_no_foreign_key.go
index b9d9a58cf7..6ff0833511 100644
--- a/backend/plugin/advisor/mssql/rule_table_no_foreign_key.go
+++ b/backend/plugin/advisor/mssql/rule_table_no_foreign_key.go
@@ -128,7 +128,8 @@ func (r *TableNoForeignKeyRule) enterCreateTable(ctx *parser.Create_tableContext
r.tableHasForeignKey[normalizedTableName] = false
r.tableOriginalName[normalizedTableName] = tableName.GetText()
- r.tableLine[normalizedTableName] = tableName.GetStart().GetLine()
+ // Store absolute line number (with baseLine offset) so generateFinalAdvice can use it directly
+ r.tableLine[normalizedTableName] = tableName.GetStart().GetLine() + r.baseLine
r.currentNormalizedTableName = normalizedTableName
r.currentConstraintAction = currentConstraintActionAdd
@@ -153,7 +154,8 @@ func (r *TableNoForeignKeyRule) enterColumnDefTableConstraints(ctx *parser.Colum
if v.Foreign_key_options() != nil {
if r.currentConstraintAction == currentConstraintActionAdd {
r.tableHasForeignKey[r.currentNormalizedTableName] = true
- r.tableLine[r.currentNormalizedTableName] = v.Foreign_key_options().GetStart().GetLine()
+ // Store absolute line number (with baseLine offset)
+ r.tableLine[r.currentNormalizedTableName] = v.Foreign_key_options().GetStart().GetLine() + r.baseLine
}
return
}
@@ -163,7 +165,8 @@ func (r *TableNoForeignKeyRule) enterColumnDefTableConstraints(ctx *parser.Colum
if v.Foreign_key_options() != nil {
if r.currentConstraintAction == currentConstraintActionAdd {
r.tableHasForeignKey[r.currentNormalizedTableName] = true
- r.tableLine[r.currentNormalizedTableName] = v.Foreign_key_options().GetStart().GetLine()
+ // Store absolute line number (with baseLine offset)
+ r.tableLine[r.currentNormalizedTableName] = v.Foreign_key_options().GetStart().GetLine() + r.baseLine
}
return
}
@@ -194,7 +197,9 @@ func (r *TableNoForeignKeyRule) exitAlterTable(*parser.Alter_tableContext) {
func (r *TableNoForeignKeyRule) generateFinalAdvice() {
for tableName, hasForeignKey := range r.tableHasForeignKey {
if hasForeignKey {
- r.AddAdvice(&storepb.Advice{
+ // Directly append to adviceList instead of using AddAdvice,
+ // because tableLine already contains the absolute line number
+ r.adviceList = append(r.adviceList, &storepb.Advice{
Status: r.level,
Code: code.TableHasFK.Int32(),
Title: r.title,
diff --git a/backend/plugin/advisor/mssql/rule_table_require_pk.go b/backend/plugin/advisor/mssql/rule_table_require_pk.go
index 74b5c6588e..5e4553ddea 100644
--- a/backend/plugin/advisor/mssql/rule_table_require_pk.go
+++ b/backend/plugin/advisor/mssql/rule_table_require_pk.go
@@ -126,7 +126,8 @@ func (r *TableRequirePkRule) enterCreateTable(ctx *parser.Create_tableContext) {
r.tableHasPrimaryKey[normalizedTableName] = false
r.tableOriginalName[normalizedTableName] = tableName.GetText()
- r.tableLine[normalizedTableName] = tableName.GetStart().GetLine()
+ // Store absolute line number (with baseLine offset) so generateFinalAdvice can use it directly
+ r.tableLine[normalizedTableName] = tableName.GetStart().GetLine() + r.baseLine
r.currentNormalizedTableName = normalizedTableName
r.currentConstraintAction = currentConstraintActionAdd
@@ -190,7 +191,9 @@ func (r *TableRequirePkRule) exitAlterTable(*parser.Alter_tableContext) {
func (r *TableRequirePkRule) generateFinalAdvice() {
for tableName, hasPK := range r.tableHasPrimaryKey {
if !hasPK {
- r.AddAdvice(&storepb.Advice{
+ // Directly append to adviceList instead of using AddAdvice,
+ // because tableLine already contains the absolute line number
+ r.adviceList = append(r.adviceList, &storepb.Advice{
Status: r.level,
Code: code.TableNoPK.Int32(),
Title: r.title,
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 809a31b954..86ed5c52e5 100644
--- a/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
+++ b/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
@@ -139,7 +139,10 @@ func (r *indexTotalNumberLimitRule) generateAdvice() {
continue
}
if len(tableInfo.GetProto().Indexes) > r.max {
- r.AddAdvice(&storepb.Advice{
+ // Directly append to adviceList instead of using AddAdvice because
+ // table.line already stores absolute line numbers (baseLine + line at time of encounter).
+ // Using AddAdvice would incorrectly add the current baseLine again.
+ r.adviceList = append(r.adviceList, &storepb.Advice{
Status: r.level,
Code: code.IndexCountExceedsLimit.Int32(),
Title: r.title,
@@ -178,14 +181,14 @@ func (r *indexTotalNumberLimitRule) handleCreatestmt(ctx *parser.CreatestmtConte
// Check column-level constraints
if elem.ColumnDef() != nil {
if hasIndexConstraint(elem.ColumnDef()) {
- r.tableLine.set(schemaName, tableName, ctx.GetStop().GetLine())
+ r.tableLine.set(schemaName, tableName, r.baseLine+ctx.GetStop().GetLine())
return
}
}
// Check table-level constraints
if elem.Tableconstraint() != nil && hasTableIndexConstraint(elem.Tableconstraint()) {
- r.tableLine.set(schemaName, tableName, ctx.GetStop().GetLine())
+ r.tableLine.set(schemaName, tableName, r.baseLine+ctx.GetStop().GetLine())
return
}
}
@@ -215,7 +218,7 @@ func (r *indexTotalNumberLimitRule) handleAltertablestmt(ctx *parser.Altertables
// ADD COLUMN with PRIMARY KEY or UNIQUE
if cmd.ADD_P() != nil && cmd.ColumnDef() != nil {
if hasIndexConstraint(cmd.ColumnDef()) {
- r.tableLine.set(schemaName, tableName, ctx.GetStop().GetLine())
+ r.tableLine.set(schemaName, tableName, r.baseLine+ctx.GetStop().GetLine())
return
}
}
@@ -223,7 +226,7 @@ func (r *indexTotalNumberLimitRule) handleAltertablestmt(ctx *parser.Altertables
// ADD CONSTRAINT (PRIMARY KEY or UNIQUE)
if cmd.ADD_P() != nil && cmd.Tableconstraint() != nil {
if hasTableIndexConstraint(cmd.Tableconstraint()) {
- r.tableLine.set(schemaName, tableName, ctx.GetStop().GetLine())
+ r.tableLine.set(schemaName, tableName, r.baseLine+ctx.GetStop().GetLine())
return
}
}
@@ -246,7 +249,7 @@ func (r *indexTotalNumberLimitRule) handleIndexstmt(ctx *parser.IndexstmtContext
}
schemaName := extractSchemaName(ctx.Relation_expr().Qualified_name())
- r.tableLine.set(schemaName, tableName, ctx.GetStop().GetLine())
+ r.tableLine.set(schemaName, tableName, r.baseLine+ctx.GetStop().GetLine())
}
// hasIndexConstraint checks if a column definition has PRIMARY KEY or UNIQUE constraint
diff --git a/backend/plugin/advisor/pg/advisor_table_require_pk.go b/backend/plugin/advisor/pg/advisor_table_require_pk.go
index d71ec0b884..936f1de51e 100644
--- a/backend/plugin/advisor/pg/advisor_table_require_pk.go
+++ b/backend/plugin/advisor/pg/advisor_table_require_pk.go
@@ -207,15 +207,15 @@ func (r *tableRequirePKRule) validateFinalState() {
content = fmt.Sprintf("%s, related statement: %q", content, mention.text)
}
- // Note: We already added baseLine offset when storing the line number,
- // but AddAdvice will add it again, so we need to subtract it first
- r.AddAdvice(&storepb.Advice{
+ // Directly append to adviceList instead of using AddAdvice,
+ // because mention.startLine already contains the absolute line number
+ r.adviceList = append(r.adviceList, &storepb.Advice{
Status: r.level,
Code: code.TableNoPK.Int32(),
Title: r.title,
Content: content,
StartPosition: &storepb.Position{
- Line: int32(mention.startLine - r.baseLine),
+ Line: int32(mention.startLine),
Column: 0,
},
})
diff --git a/backend/plugin/advisor/pg/test/index_total_number_limit.yaml b/backend/plugin/advisor/pg/test/index_total_number_limit.yaml
index 2e997b9f3c..f5ecaa9234 100644
--- a/backend/plugin/advisor/pg/test/index_total_number_limit.yaml
+++ b/backend/plugin/advisor/pg/test/index_total_number_limit.yaml
@@ -55,3 +55,37 @@
line: 9
column: 0
endposition: null
+# Test case to verify correct line positions for multi-table scenarios.
+# Each table should report the line where its index was created,
+# not the line of the last statement.
+- statement: |-
+ CREATE TABLE t1(a int PRIMARY KEY, b int, c int);
+ CREATE INDEX idx_t1_1 on t1(a, b);
+ CREATE INDEX idx_t1_2 on t1(a, b);
+ CREATE INDEX idx_t1_3 on t1(a, b);
+ CREATE INDEX idx_t1_4 on t1(a, b);
+ CREATE INDEX idx_t1_5 on t1(a, b);
+ CREATE TABLE t2(a int PRIMARY KEY, b int, c int);
+ CREATE INDEX idx_t2_1 on t2(a, b);
+ CREATE INDEX idx_t2_2 on t2(a, b);
+ CREATE INDEX idx_t2_3 on t2(a, b);
+ CREATE INDEX idx_t2_4 on t2(a, b);
+ CREATE INDEX idx_t2_5 on t2(a, b);
+ changeType: 1
+ want:
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table "public"."t1" should be no more than 5, but found 6
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table "public"."t2" should be no more than 5, but found 6
+ startposition:
+ line: 12
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/snowflake/rule_table_require_pk.go b/backend/plugin/advisor/snowflake/rule_table_require_pk.go
index e771a3fbb5..e64152429d 100644
--- a/backend/plugin/advisor/snowflake/rule_table_require_pk.go
+++ b/backend/plugin/advisor/snowflake/rule_table_require_pk.go
@@ -128,12 +128,15 @@ func (r *TableRequirePkRule) OnExit(_ antlr.ParserRuleContext, nodeType string)
func (r *TableRequirePkRule) GetAdviceList() []*storepb.Advice {
for tableName, has := range r.tableHasPrimaryKey {
if !has {
- r.AddAdvice(&storepb.Advice{
+ // Directly append to adviceList instead of using AddAdvice because
+ // tableLine already stores absolute line numbers (baseLine + line at time of encounter).
+ // Using AddAdvice would incorrectly add the current baseLine again.
+ r.adviceList = append(r.adviceList, &storepb.Advice{
Status: r.level,
Code: code.TableNoPK.Int32(),
Title: r.title,
Content: fmt.Sprintf("Table %s requires PRIMARY KEY.", r.tableOriginalName[tableName]),
- StartPosition: common.ConvertANTLRLineToPosition(r.baseLine + r.tableLine[tableName]),
+ StartPosition: common.ConvertANTLRLineToPosition(r.tableLine[tableName]),
})
}
}
@@ -146,7 +149,7 @@ func (r *TableRequirePkRule) enterCreateTable(ctx *parser.Create_tableContext) {
r.tableHasPrimaryKey[normalizedTableName] = false
r.tableOriginalName[normalizedTableName] = originalTableName.GetText()
- r.tableLine[normalizedTableName] = ctx.GetStart().GetLine()
+ r.tableLine[normalizedTableName] = r.baseLine + ctx.GetStart().GetLine()
r.currentNormalizedTableName = normalizedTableName
r.currentConstraintAction = currentConstraintActionAdd
}
@@ -181,7 +184,7 @@ func (r *TableRequirePkRule) enterOutOfLineConstraint(ctx *parser.Out_of_line_co
r.tableHasPrimaryKey[r.currentNormalizedTableName] = true
case currentConstraintActionDrop:
r.tableHasPrimaryKey[r.currentNormalizedTableName] = false
- r.tableLine[r.currentNormalizedTableName] = ctx.GetStart().GetLine()
+ r.tableLine[r.currentNormalizedTableName] = r.baseLine + ctx.GetStart().GetLine()
default:
// No action for other constraint actions
}
@@ -194,7 +197,7 @@ func (r *TableRequirePkRule) enterConstraintAction(ctx *parser.Constraint_action
if ctx.DROP() != nil && ctx.PRIMARY() != nil {
if _, ok := r.tableHasPrimaryKey[r.currentNormalizedTableName]; ok {
r.tableHasPrimaryKey[r.currentNormalizedTableName] = false
- r.tableLine[r.currentNormalizedTableName] = ctx.GetStart().GetLine()
+ r.tableLine[r.currentNormalizedTableName] = r.baseLine + ctx.GetStart().GetLine()
}
return
}
diff --git a/backend/plugin/advisor/snowflake/test/table_require_pk.yaml b/backend/plugin/advisor/snowflake/test/table_require_pk.yaml
index 8b75d61e23..ffbe15d9ba 100644
--- a/backend/plugin/advisor/snowflake/test/table_require_pk.yaml
+++ b/backend/plugin/advisor/snowflake/test/table_require_pk.yaml
@@ -126,7 +126,7 @@
title: TABLE_REQUIRE_PK
content: Table CUSTOMER requires PRIMARY KEY.
startposition:
- line: 25
+ line: 24
column: 0
endposition: null
- status: 2
@@ -137,3 +137,29 @@
line: 25
column: 0
endposition: null
+# Test case to verify correct line positions for multi-statement scenarios.
+# Each table should report the line where its PRIMARY KEY was dropped,
+# not the line of the last statement.
+- statement: |-
+ CREATE TABLE t1 (id INT PRIMARY KEY);
+ ALTER TABLE t1 DROP PRIMARY KEY(id);
+ CREATE TABLE t2 (id INT PRIMARY KEY);
+ ALTER TABLE t2 DROP PRIMARY KEY(id);
+ changeType: 1
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table t1 requires PRIMARY KEY.
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table t2 requires PRIMARY KEY.
+ startposition:
+ line: 4
+ column: 0
+ endposition: null