Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
feat: support doris show statements (#17729)
rebelice90fcdc431594
diff --git a/backend/plugin/db/starrocks/query.go b/backend/plugin/db/starrocks/query.goindex 9846314949..7812d78b05 100644--- a/backend/plugin/db/starrocks/query.go+++ b/backend/plugin/db/starrocks/query.go@@ -5,6 +5,7 @@ import ("fmt""log/slog""strconv"+ "strings""time""github.com/antlr4-go/antlr/v4"@@ -99,6 +100,13 @@ func convertValue(typeName string, columnType *sql.ColumnType, value any) *v1pb.}func getStatementWithResultLimit(statement string, limit int) string {+ // SHOW statements don't need LIMIT clause wrapping as they typically return small result sets+ // and wrapping them in SELECT * FROM (...) causes syntax errors+ trimmedStatement := strings.TrimSpace(statement)+ if strings.HasPrefix(strings.ToUpper(trimmedStatement), "SHOW") {+ return statement+ }+stmt, err := getStatementWithResultLimitForMySQL(statement, limit)if err != nil {slog.Error("fail to add limit clause", slog.String("statement", statement), log.BBError(err))diff --git a/backend/plugin/db/starrocks/query_test.go b/backend/plugin/db/starrocks/query_test.goindex a551a7abed..f6a387f058 100644--- a/backend/plugin/db/starrocks/query_test.go+++ b/backend/plugin/db/starrocks/query_test.go@@ -95,6 +95,37 @@ func TestGetStatementWithResultLimit(t *testing.T) {count: 10,want: "SELECT * FROM t LIMIT 123,10;",},+ // SHOW statements should not be wrapped+ {+ stmt: "SHOW DATA",+ count: 10,+ want: "SHOW DATA",+ },+ {+ stmt: "SHOW DATA FROM db1",+ count: 10,+ want: "SHOW DATA FROM db1",+ },+ {+ stmt: "SHOW DATABASES",+ count: 10,+ want: "SHOW DATABASES",+ },+ {+ stmt: "SHOW TABLES",+ count: 10,+ want: "SHOW TABLES",+ },+ {+ stmt: "show data",+ count: 10,+ want: "show data",+ },+ {+ stmt: " SHOW DATA ",+ count: 10,+ want: " SHOW DATA ",+ },}for _, tc := range testCases {diff --git a/backend/plugin/parser/doris/query.go b/backend/plugin/parser/doris/query.goindex c7d1d3ec2d..7a549300ee 100644--- a/backend/plugin/parser/doris/query.go+++ b/backend/plugin/parser/doris/query.go@@ -40,11 +40,100 @@ func (l *queryValidateListener) EnterSingleStatement(ctx *parser.SingleStatementreturn}- if ctx.Statement() == nil {+ stmt := ctx.Statement()+ if stmt == nil {return}- if ctx.Statement().QueryStatement() == nil {- l.valid = false+ // Allow SELECT queries and SHOW statements+ if stmt.QueryStatement() != nil {+ return}++ // Check for SHOW statements+ if stmt.ShowAlterStatement() != nil ||+ stmt.ShowAnalyzeStatement() != nil ||+ stmt.ShowAuthenticationStatement() != nil ||+ stmt.ShowAuthorStatement() != nil ||+ stmt.ShowBackendBlackListStatement() != nil ||+ stmt.ShowBackendsStatement() != nil ||+ stmt.ShowBackupStatement() != nil ||+ stmt.ShowBaselinePlanStatement() != nil ||+ stmt.ShowBrokerStatement() != nil ||+ stmt.ShowCatalogsStatement() != nil ||+ stmt.ShowCharsetStatement() != nil ||+ stmt.ShowClustersStatement() != nil ||+ stmt.ShowCollationStatement() != nil ||+ stmt.ShowColumnStatement() != nil ||+ stmt.ShowComputeNodesStatement() != nil ||+ stmt.ShowCreateDbStatement() != nil ||+ stmt.ShowCreateExternalCatalogStatement() != nil ||+ stmt.ShowCreateGroupProviderStatement() != nil ||+ stmt.ShowCreateRoutineLoadStatement() != nil ||+ stmt.ShowCreateSecurityIntegrationStatement() != nil ||+ stmt.ShowCreateTableStatement() != nil ||+ stmt.ShowDataCacheRulesStatement() != nil ||+ stmt.ShowDataDistributionStmt() != nil ||+ stmt.ShowDataStmt() != nil ||+ stmt.ShowDatabasesStatement() != nil ||+ stmt.ShowDeleteStatement() != nil ||+ stmt.ShowDictionaryStatement() != nil ||+ stmt.ShowDynamicPartitionStatement() != nil ||+ stmt.ShowEnginesStatement() != nil ||+ stmt.ShowEventsStatement() != nil ||+ stmt.ShowExportStatement() != nil ||+ stmt.ShowFailPointStatement() != nil ||+ stmt.ShowFrontendsStatement() != nil ||+ stmt.ShowFunctionsStatement() != nil ||+ stmt.ShowGrantsStatement() != nil ||+ stmt.ShowGroupProvidersStatement() != nil ||+ stmt.ShowHistogramMetaStatement() != nil ||+ stmt.ShowIndexStatement() != nil ||+ stmt.ShowLoadStatement() != nil ||+ stmt.ShowLoadWarningsStatement() != nil ||+ stmt.ShowMaterializedViewsStatement() != nil ||+ stmt.ShowNodesStatement() != nil ||+ stmt.ShowOpenTableStatement() != nil ||+ stmt.ShowPartitionsStatement() != nil ||+ stmt.ShowPipeStatement() != nil ||+ stmt.ShowPlanAdvisorStatement() != nil ||+ stmt.ShowPluginsStatement() != nil ||+ stmt.ShowPrivilegesStatement() != nil ||+ stmt.ShowProcStatement() != nil ||+ stmt.ShowProcedureStatement() != nil ||+ stmt.ShowProcesslistStatement() != nil ||+ stmt.ShowProfilelistStatement() != nil ||+ stmt.ShowRepositoriesStatement() != nil ||+ stmt.ShowResourceGroupStatement() != nil ||+ stmt.ShowResourceGroupUsageStatement() != nil ||+ stmt.ShowResourceStatement() != nil ||+ stmt.ShowRestoreStatement() != nil ||+ stmt.ShowRolesStatement() != nil ||+ stmt.ShowRoutineLoadStatement() != nil ||+ stmt.ShowRoutineLoadTaskStatement() != nil ||+ stmt.ShowRunningQueriesStatement() != nil ||+ stmt.ShowSecurityIntegrationStatement() != nil ||+ stmt.ShowSmallFilesStatement() != nil ||+ stmt.ShowSnapshotStatement() != nil ||+ stmt.ShowSqlBlackListStatement() != nil ||+ stmt.ShowStatsMetaStatement() != nil ||+ stmt.ShowStatusStatement() != nil ||+ stmt.ShowStorageVolumesStatement() != nil ||+ stmt.ShowStreamLoadStatement() != nil ||+ stmt.ShowTableStatement() != nil ||+ stmt.ShowTableStatusStatement() != nil ||+ stmt.ShowTabletStatement() != nil ||+ stmt.ShowTemporaryTablesStatement() != nil ||+ stmt.ShowTransactionStatement() != nil ||+ stmt.ShowTriggersStatement() != nil ||+ stmt.ShowUserPropertyStatement() != nil ||+ stmt.ShowUserStatement() != nil ||+ stmt.ShowVariablesStatement() != nil ||+ stmt.ShowWarehousesStatement() != nil ||+ stmt.ShowWarningStatement() != nil ||+ stmt.ShowWhiteListStatement() != nil {+ return+ }++ l.valid = false}diff --git a/backend/plugin/parser/doris/query_test.go b/backend/plugin/parser/doris/query_test.gonew file mode 100644index 0000000000..d0b096d272--- /dev/null+++ b/backend/plugin/parser/doris/query_test.go@@ -0,0 +1,100 @@+package doris++import (+ "testing"++ "github.com/stretchr/testify/require"+)++func TestValidateQuery(t *testing.T) {+ tests := []struct {+ statement string+ valid bool+ description string+ }{+ {+ statement: "SELECT * FROM users",+ valid: true,+ description: "Basic SELECT query",+ },+ {+ statement: "SELECT * FROM users WHERE id = 1",+ valid: true,+ description: "SELECT with WHERE clause",+ },+ {+ statement: "SHOW DATA",+ valid: true,+ description: "SHOW DATA statement",+ },+ {+ statement: "SHOW DATA FROM db1",+ valid: true,+ description: "SHOW DATA with FROM clause",+ },+ {+ statement: "SHOW DATABASES",+ valid: true,+ description: "SHOW DATABASES statement",+ },+ {+ statement: "SHOW TABLES",+ valid: true,+ description: "SHOW TABLES statement",+ },+ {+ statement: "SHOW TABLETS FROM table1",+ valid: true,+ description: "SHOW TABLETS statement",+ },+ {+ statement: "SHOW VARIABLES",+ valid: true,+ description: "SHOW VARIABLES statement",+ },+ {+ statement: "SHOW CREATE TABLE users",+ valid: true,+ description: "SHOW CREATE TABLE statement",+ },+ {+ statement: "SHOW CREATE DATABASE db1",+ valid: true,+ description: "SHOW CREATE DATABASE statement",+ },+ {+ statement: "INSERT INTO users (id, name) VALUES (1, 'test')",+ valid: false,+ description: "INSERT statement should be invalid",+ },+ {+ statement: "UPDATE users SET name = 'test' WHERE id = 1",+ valid: false,+ description: "UPDATE statement should be invalid",+ },+ {+ statement: "DELETE FROM users WHERE id = 1",+ valid: false,+ description: "DELETE statement should be invalid",+ },+ {+ statement: "CREATE TABLE test (id INT)",+ valid: false,+ description: "CREATE TABLE should be invalid",+ },+ {+ statement: "DROP TABLE users",+ valid: false,+ description: "DROP TABLE should be invalid",+ },+ }++ for _, tc := range tests {+ t.Run(tc.description, func(t *testing.T) {+ a := require.New(t)+ valid, _, err := validateQuery(tc.statement)+ a.NoError(err)+ a.Equal(tc.valid, valid, "statement: %s", tc.statement)+ })+ }+}diff --git a/backend/plugin/parser/doris/query_type.go b/backend/plugin/parser/doris/query_type.goindex a2a8c6a9cd..d3d31f313c 100644--- a/backend/plugin/parser/doris/query_type.go+++ b/backend/plugin/parser/doris/query_type.go@@ -38,23 +38,82 @@ func (l *queryTypeListener) EnterSingleStatement(ctx *parser.SingleStatementConts.ShowAuthenticationStatement() != nil,s.ShowAuthorStatement() != nil,s.ShowBackendBlackListStatement() != nil,+ s.ShowBackendsStatement() != nil,+ s.ShowBackupStatement() != nil,+ s.ShowBaselinePlanStatement() != nil,+ s.ShowBrokerStatement() != nil,s.ShowCatalogsStatement() != nil,+ s.ShowCharsetStatement() != nil,+ s.ShowClustersStatement() != nil,+ s.ShowCollationStatement() != nil,+ s.ShowColumnStatement() != nil,+ s.ShowComputeNodesStatement() != nil,+ s.ShowCreateDbStatement() != nil,+ s.ShowCreateExternalCatalogStatement() != nil,+ s.ShowCreateGroupProviderStatement() != nil,+ s.ShowCreateRoutineLoadStatement() != nil,+ s.ShowCreateSecurityIntegrationStatement() != nil,+ s.ShowCreateTableStatement() != nil,+ s.ShowDataCacheRulesStatement() != nil,+ s.ShowDataDistributionStmt() != nil,+ s.ShowDataStmt() != nil,s.ShowDatabasesStatement() != nil,+ s.ShowDeleteStatement() != nil,+ s.ShowDictionaryStatement() != nil,+ s.ShowDynamicPartitionStatement() != nil,s.ShowEnginesStatement() != nil,+ s.ShowEventsStatement() != nil,+ s.ShowExportStatement() != nil,+ s.ShowFailPointStatement() != nil,+ s.ShowFrontendsStatement() != nil,s.ShowFunctionsStatement() != nil,s.ShowGrantsStatement() != nil,+ s.ShowGroupProvidersStatement() != nil,+ s.ShowHistogramMetaStatement() != nil,s.ShowIndexStatement() != nil,+ s.ShowLoadStatement() != nil,+ s.ShowLoadWarningsStatement() != nil,+ s.ShowMaterializedViewsStatement() != nil,+ s.ShowNodesStatement() != nil,+ s.ShowOpenTableStatement() != nil,s.ShowPartitionsStatement() != nil,+ s.ShowPipeStatement() != nil,+ s.ShowPlanAdvisorStatement() != nil,+ s.ShowPluginsStatement() != nil,+ s.ShowPrivilegesStatement() != nil,+ s.ShowProcStatement() != nil,+ s.ShowProcedureStatement() != nil,s.ShowProcesslistStatement() != nil,+ s.ShowProfilelistStatement() != nil,+ s.ShowRepositoriesStatement() != nil,+ s.ShowResourceGroupStatement() != nil,+ s.ShowResourceGroupUsageStatement() != nil,+ s.ShowResourceStatement() != nil,+ s.ShowRestoreStatement() != nil,s.ShowRolesStatement() != nil,+ s.ShowRoutineLoadStatement() != nil,+ s.ShowRoutineLoadTaskStatement() != nil,+ s.ShowRunningQueriesStatement() != nil,+ s.ShowSecurityIntegrationStatement() != nil,+ s.ShowSmallFilesStatement() != nil,+ s.ShowSnapshotStatement() != nil,+ s.ShowSqlBlackListStatement() != nil,+ s.ShowStatsMetaStatement() != nil,+ s.ShowStatusStatement() != nil,+ s.ShowStorageVolumesStatement() != nil,+ s.ShowStreamLoadStatement() != nil,+ s.ShowTableStatement() != nil,+ s.ShowTableStatusStatement() != nil,+ s.ShowTabletStatement() != nil,+ s.ShowTemporaryTablesStatement() != nil,s.ShowTransactionStatement() != nil,s.ShowTriggersStatement() != nil,+ s.ShowUserPropertyStatement() != nil,s.ShowUserStatement() != nil,s.ShowVariablesStatement() != nil,- s.ShowTableStatement() != nil,- s.ShowTableStatusStatement() != nil,- s.ShowCreateDbStatement() != nil,- s.ShowCreateTableStatement() != nil:+ s.ShowWarehousesStatement() != nil,+ s.ShowWarningStatement() != nil,+ s.ShowWhiteListStatement() != nil:l.result = base.SelectInfoSchemadefault:l.result = base.DDLdiff --git a/backend/plugin/parser/doris/query_type_test.go b/backend/plugin/parser/doris/query_type_test.gonew file mode 100644index 0000000000..191683242f--- /dev/null+++ b/backend/plugin/parser/doris/query_type_test.go@@ -0,0 +1,76 @@+package doris++import (+ "context"+ "testing"++ "github.com/stretchr/testify/require"++ "github.com/bytebase/bytebase/backend/plugin/parser/base"+)++func TestGetQueryType(t *testing.T) {+ tests := []struct {+ statement string+ want base.QueryType+ }{+ {+ statement: "SELECT * FROM users",+ want: base.Select,+ },+ {+ statement: "INSERT INTO users (id, name) VALUES (1, 'test')",+ want: base.DML,+ },+ {+ statement: "UPDATE users SET name = 'test' WHERE id = 1",+ want: base.DML,+ },+ {+ statement: "DELETE FROM users WHERE id = 1",+ want: base.DML,+ },+ {+ statement: "CREATE TABLE test (id INT)",+ want: base.DDL,+ },+ {+ statement: "SHOW DATABASES",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW TABLES",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW DATA",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW DATA FROM db1",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW TABLETS FROM table1",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW VARIABLES",+ want: base.SelectInfoSchema,+ },+ {+ statement: "SHOW CREATE TABLE users",+ want: base.SelectInfoSchema,+ },+ }++ for _, tc := range tests {+ t.Run(tc.statement, func(t *testing.T) {+ a := require.New(t)+ extractor := newQuerySpanExtractor("testdb", base.GetQuerySpanContext{}, false)+ result, err := extractor.getQuerySpan(context.Background(), tc.statement)+ a.NoError(err)+ a.Equal(tc.want, result.Type, "statement: %s", tc.statement)+ })+ }+}