Skip to content

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

chore(mssql): use omni for result limit rewrite (#20543)

rebelice61a4c67690fa
diff --git a/backend/plugin/db/mssql/query.go b/backend/plugin/db/mssql/query.go
index 79e91b5679..b23074d404 100644
--- a/backend/plugin/db/mssql/query.go
+++ b/backend/plugin/db/mssql/query.go
@@ -4,22 +4,16 @@ import (
"database/sql"
"fmt"
"log/slog"
- "strconv"
- "strings"
"time"
- "github.com/antlr4-go/antlr/v4"
- "github.com/pkg/errors"
+ omnimssql "github.com/bytebase/omni/mssql"
"google.golang.org/protobuf/types/known/timestamppb"
- "github.com/bytebase/parser/tsql"
mssqldb "github.com/microsoft/go-mssqldb"
"github.com/bytebase/bytebase/backend/common/log"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
"github.com/bytebase/bytebase/backend/plugin/db/util"
- tsqlparser "github.com/bytebase/bytebase/backend/plugin/parser/tsql"
- "github.com/bytebase/bytebase/backend/utils"
)
func makeValueByTypeName(typeName string, _ *sql.ColumnType) any {
@@ -174,219 +168,5 @@ func getStatementWithResultLimit(statement string, limit int) string {
}
func getStatementWithResultLimitInline(singleStatement string, limitCount int) (string, error) {
- results, err := tsqlparser.ParseTSQL(singleStatement)
- if err != nil {
- return "", err
- }
-
- if len(results) != 1 {
- return "", errors.Errorf("expected exactly 1 statement, got %d", len(results))
- }
-
- result := results[0]
-
- listener := &tsqlRewriter{
- limitCount: limitCount,
- hasFetch: false,
- hasTop: false,
- }
-
- listener.rewriter = *antlr.NewTokenStreamRewriter(result.Tokens)
- antlr.ParseTreeWalkerDefault.Walk(listener, result.Tree)
- if listener.err != nil {
- return "", errors.Wrapf(listener.err, "statement: %s", singleStatement)
- }
-
- res := listener.rewriter.GetTextDefault()
- res = strings.TrimRightFunc(res, utils.IsSpaceOrSemicolon) + ";"
-
- return res, nil
-}
-
-type tsqlRewriter struct {
- *tsql.BaseTSqlParserListener
-
- rewriter antlr.TokenStreamRewriter
- err error
- limitCount int
- hasFetch bool
- hasTop bool
-}
-
-// EnterSelect_statement_standalone is called when production select_statement_standalone is entered.
-func (r *tsqlRewriter) EnterSelect_statement_standalone(ctx *tsql.Select_statement_standaloneContext) {
- r.handleSelectStatementDryRun(ctx.Select_statement())
- r.handleSelectStatement(ctx.Select_statement())
-}
-
-func (r *tsqlRewriter) handleSelectStatementDryRun(ctx tsql.ISelect_statementContext) {
- if ctx.Select_order_by_clause() != nil {
- r.handleSelectOrderByDryRun(ctx.Select_order_by_clause())
- }
-
- if ctx.Query_expression() != nil {
- if len(ctx.Query_expression().AllSql_union()) > 0 {
- r.handleSqlunionDryRun(ctx.Query_expression())
- }
- if ctx.Query_expression().Select_order_by_clause() != nil {
- r.handleSelectOrderByDryRun(ctx.Query_expression().Select_order_by_clause())
- }
- r.handleQuerySpecificationDryRun(ctx.Query_expression().Query_specification())
- }
-}
-
-func (r *tsqlRewriter) handleSqlunionDryRun(ctx tsql.IQuery_expressionContext) {
- if len(ctx.AllSql_union()) == 0 {
- // non-union
- return
- }
- // handle union left side
- r.handleQuerySpecificationDryRun(ctx.Query_specification())
- // handle union right side
- r.handleQuerySpecificationDryRun(ctx.Get_sql_union().Query_specification())
-}
-
-func (r *tsqlRewriter) handleSelectOrderByDryRun(ctx tsql.ISelect_order_by_clauseContext) {
- if ctx.GetFetch_rows() != nil {
- r.hasFetch = true
-
- r.overrideFetchRows(ctx)
- }
-}
-
-func (r *tsqlRewriter) handleQuerySpecificationDryRun(ctx tsql.IQuery_specificationContext) {
- if ctx.Top_clause() != nil {
- r.hasTop = true
-
- r.overrideTopClause(ctx.Top_clause())
- }
-}
-
-func (r *tsqlRewriter) handleSelectStatement(ctx tsql.ISelect_statementContext) {
- // check outermost order by clause.
- if ctx.Select_order_by_clause() != nil {
- r.handleSelectOrderBy(ctx.Select_order_by_clause())
- }
- if r.hasFetch {
- return
- }
-
- if ctx.Query_expression() != nil {
- // check union, except, intersect.
- if ctx.Query_expression().AllSql_union() != nil && len(ctx.Query_expression().AllSql_union()) > 0 {
- r.handleSqlunion(ctx.Query_expression())
- return
- }
-
- // process orderby in outermost query_expression.
- if ctx.Query_expression().Select_order_by_clause() != nil {
- r.handleSelectOrderBy(ctx.Query_expression().Select_order_by_clause())
- }
- if r.hasFetch {
- return
- }
- r.handleQuerySpecification(ctx.Query_expression().Query_specification())
-
- if r.hasTop {
- return
- }
- }
-}
-
-func (r *tsqlRewriter) handleSqlunion(ctx tsql.IQuery_expressionContext) {
- if r.hasTop {
- return
- }
- if ctx.AllSql_union() == nil || len(ctx.AllSql_union()) == 0 {
- // non-union
- return
- }
- // handle union left side
- querySpecification := ctx.Query_specification()
- if querySpecification.GetAllOrDistinct() != nil {
- r.hasTop = true
- r.rewriter.InsertAfterDefault(querySpecification.GetAllOrDistinct().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
- return
- }
- r.rewriter.InsertAfterDefault(querySpecification.SELECT().GetSymbol().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
-
- // handle union right side
- querySpecification = ctx.Get_sql_union().Query_specification()
- if querySpecification.GetAllOrDistinct() != nil {
- r.hasTop = true
- r.rewriter.InsertAfterDefault(querySpecification.GetAllOrDistinct().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
- return
- }
- r.rewriter.InsertAfterDefault(querySpecification.SELECT().GetSymbol().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
-}
-
-func (r *tsqlRewriter) handleQuerySpecification(ctx tsql.IQuery_specificationContext) {
- if r.hasFetch {
- return
- }
- if ctx.Top_clause() != nil {
- r.hasTop = true
-
- r.overrideTopClause(ctx.Top_clause())
- return
- }
-
- // append after select_optional_clauses
- if ctx.GetAllOrDistinct() != nil {
- r.hasTop = true
- r.rewriter.InsertAfterDefault(ctx.GetAllOrDistinct().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
- return
- }
- // append after select keyword.
- r.rewriter.InsertAfterDefault(ctx.SELECT().GetSymbol().GetTokenIndex(), fmt.Sprintf(" TOP %d", r.limitCount))
- r.hasTop = true
-}
-
-func (r *tsqlRewriter) handleSelectOrderBy(ctx tsql.ISelect_order_by_clauseContext) {
- if r.hasTop {
- return
- }
-
- r.hasFetch = true
- if ctx.GetFetch_rows() != nil {
- r.overrideFetchRows(ctx)
- return
- }
-
- // OFFSET is required.
- if ctx.GetOffset_rows() == nil {
- r.rewriter.InsertAfterDefault(ctx.Order_by_clause().GetStop().GetTokenIndex(), fmt.Sprintf(" OFFSET 0 ROWS FETCH NEXT %d ROWS ONLY", r.limitCount))
- } else {
- r.rewriter.InsertAfterDefault(ctx.GetOffset_rows().GetTokenIndex(), fmt.Sprintf(" FETCH NEXT %d ROWS ONLY", r.limitCount))
- }
-}
-
-func (r *tsqlRewriter) overrideTopClause(topClause tsql.ITop_clauseContext) {
- var limit int
- topCount := topClause.Top_count()
- if topCount != nil {
- userLimitText := topCount.GetText()
- limit, _ = strconv.Atoi(userLimitText)
- }
- if limit == 0 || r.limitCount < limit {
- limit = r.limitCount
- }
-
- r.rewriter.ReplaceDefault(topClause.GetStart().GetTokenIndex(), topClause.GetStop().GetTokenIndex(), fmt.Sprintf("TOP %d", limit))
-}
-
-func (r *tsqlRewriter) overrideFetchRows(ctx tsql.ISelect_order_by_clauseContext) {
- // SQL Server 2012 or later support OFFSET-FETCH clause to limit the number of rows returned by a query.
- // Offset must exists.
- if len(ctx.AllExpression()) > 1 {
- expression := ctx.Expression(1)
- if expression != nil {
- userLimitText := expression.GetText()
- limit, _ := strconv.Atoi(userLimitText)
- if limit == 0 || r.limitCount < limit {
- limit = r.limitCount
- }
- r.rewriter.ReplaceDefault(expression.GetStart().GetTokenIndex(), expression.GetStop().GetTokenIndex(), fmt.Sprintf("%d", limit))
- }
- }
+ return omnimssql.StatementWithResultLimit(singleStatement, limitCount)
}
diff --git a/backend/plugin/db/mssql/test-data/test_limit.yaml b/backend/plugin/db/mssql/test-data/test_limit.yaml
index 350152e066..c1600e1a3c 100644
--- a/backend/plugin/db/mssql/test-data/test_limit.yaml
+++ b/backend/plugin/db/mssql/test-data/test_limit.yaml
@@ -17,6 +17,14 @@
SELECT TOP 123 id FROM t1;
limit: 10
want: SELECT TOP 10 id FROM t1;
+- stmt: |
+ SELECT TOP (3) PERCENT id FROM t1;
+ limit: 10
+ want: SELECT TOP 10 id FROM t1;
+- stmt: |
+ SELECT TOP (3) WITH TIES id FROM t1 ORDER BY id;
+ limit: 10
+ want: SELECT TOP 10 id FROM t1 ORDER BY id;
- stmt: |
SELECT id FROM t1 ORDER BY price;
limit: 10
diff --git a/go.mod b/go.mod
index 63d5c58e34..adf4e6fa83 100644
--- a/go.mod
+++ b/go.mod
@@ -34,7 +34,7 @@ require (
github.com/bmatcuk/doublestar/v4 v4.10.0
github.com/bytebase/gomongo v0.0.0-20260510192859-8526a440b352
github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0
- github.com/bytebase/omni v0.0.0-20260608071738-731478feee32
+ github.com/bytebase/omni v0.0.0-20260608094457-c8e5a034d279
github.com/caarlos0/env/v11 v11.4.1
github.com/cenkalti/backoff/v5 v5.0.3
github.com/cockroachdb/cockroachdb-parser v0.25.2
diff --git a/go.sum b/go.sum
index 7be59585df..5f2193c8f8 100644
--- a/go.sum
+++ b/go.sum
@@ -250,8 +250,8 @@ github.com/bytebase/gomongo v0.0.0-20260510192859-8526a440b352 h1:3sC5pdvJ7bNAhR
github.com/bytebase/gomongo v0.0.0-20260510192859-8526a440b352/go.mod h1:eyWrxE51HCbjGIChvty/mYaNcAroXshnIiR6SIqlxfY=
github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0 h1:bJ8NSf2K+pccl5m/wuu97fiYjDwpJH6IzURAq/3XA2U=
github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0/go.mod h1:BEWMfiZtqshdmulKJcIsWb45MUaEvDO4CROcgi8dfFg=
-github.com/bytebase/omni v0.0.0-20260608071738-731478feee32 h1:Ws8/0AvaLfN19AADsQJMuq0mxWW9fLno72HAEdP/R+k=
-github.com/bytebase/omni v0.0.0-20260608071738-731478feee32/go.mod h1:EVG8nQbNPUnUBGKn6J0niSGOs3jgfKo3TciY22R4bfo=
+github.com/bytebase/omni v0.0.0-20260608094457-c8e5a034d279 h1:+e9sMU4STu/Vw2rvSSNL3lUaWCGUkWe7aftrNAz9Sbs=
+github.com/bytebase/omni v0.0.0-20260608094457-c8e5a034d279/go.mod h1:EVG8nQbNPUnUBGKn6J0niSGOs3jgfKo3TciY22R4bfo=
github.com/bytebase/parser v0.0.0-20260417075056-57b6ef7a2640 h1:g4Jed1/Jv/DHBiQmEgN5ILOQDDBjFlG4N4Lp+3B4aYE=
github.com/bytebase/parser v0.0.0-20260417075056-57b6ef7a2640/go.mod h1:jeak/EfutSOAuWKvrFIT2IZunhWprM7oTFBRgZ9RCxo=
github.com/bytebase/pgx/v5 v5.0.0-20250212161523-96ff8aed8767 h1:YuR5G3LcxpO5ScSTA+Kdirxg9RW4TRc/v1t7N2Hfmbw=