Skip to content

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

refactor(oceanbase): give OceanBase its own parser, advisor, and driver (#21715)

Danny Xuc872cacaf728
diff --git a/backend/api/v1/mcp_sql_clamp_test.go b/backend/api/v1/mcp_sql_clamp_test.go
index 391bbdc4fe..36e428630d 100644
--- a/backend/api/v1/mcp_sql_clamp_test.go
+++ b/backend/api/v1/mcp_sql_clamp_test.go
@@ -27,6 +27,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/parser/mariadb"
_ "github.com/bytebase/bytebase/backend/plugin/parser/mongodb"
_ "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
_ "github.com/bytebase/bytebase/backend/plugin/parser/partiql"
_ "github.com/bytebase/bytebase/backend/plugin/parser/pg"
_ "github.com/bytebase/bytebase/backend/plugin/parser/plsql"
diff --git a/backend/api/v1/release_service_check_mysql_test.go b/backend/api/v1/release_service_check_mysql_test.go
index 298eb1bc2f..09886f7684 100644
--- a/backend/api/v1/release_service_check_mysql_test.go
+++ b/backend/api/v1/release_service_check_mysql_test.go
@@ -10,6 +10,7 @@ import (
// Blank import registers the MySQL ParseStatements func used by base.ParseStatements.
_ "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
// TestEngineSupportsDeclarativeRelease asserts MySQL is admitted into the declarative
diff --git a/backend/plugin/advisor/contains_ddl_test.go b/backend/plugin/advisor/contains_ddl_test.go
index d639e39f9b..f104f615c8 100644
--- a/backend/plugin/advisor/contains_ddl_test.go
+++ b/backend/plugin/advisor/contains_ddl_test.go
@@ -11,6 +11,7 @@ import (
// Register parsers and statement type getters via init().
_ "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
_ "github.com/bytebase/bytebase/backend/plugin/parser/pg"
_ "github.com/bytebase/bytebase/backend/plugin/parser/plsql"
_ "github.com/bytebase/bytebase/backend/plugin/parser/tidb"
diff --git a/backend/plugin/advisor/mysql/advisor_builtin_walk_through_check.go b/backend/plugin/advisor/mysql/advisor_builtin_walk_through_check.go
index b45aecc8f0..d450ca51a7 100644
--- a/backend/plugin/advisor/mysql/advisor_builtin_walk_through_check.go
+++ b/backend/plugin/advisor/mysql/advisor_builtin_walk_through_check.go
@@ -8,5 +8,4 @@ import (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_BUILTIN_WALK_THROUGH_CHECK, &advisor.BuiltinWalkThroughCheckAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_BUILTIN_WALK_THROUGH_CHECK, &advisor.BuiltinWalkThroughCheckAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_BUILTIN_WALK_THROUGH_CHECK, &advisor.BuiltinWalkThroughCheckAdvisor{})
}
diff --git a/backend/plugin/advisor/mysql/rule_charset_allowlist.go b/backend/plugin/advisor/mysql/rule_charset_allowlist.go
index fdef1f73b5..8bd09d09f5 100644
--- a/backend/plugin/advisor/mysql/rule_charset_allowlist.go
+++ b/backend/plugin/advisor/mysql/rule_charset_allowlist.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, &CharsetAllowlistAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, &CharsetAllowlistAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, &CharsetAllowlistAdvisor{})
}
// CharsetAllowlistAdvisor is the advisor checking for charset allowlist.
diff --git a/backend/plugin/advisor/mysql/rule_collation_allowlist.go b/backend/plugin/advisor/mysql/rule_collation_allowlist.go
index 79bf20ea79..323b3c1b6b 100644
--- a/backend/plugin/advisor/mysql/rule_collation_allowlist.go
+++ b/backend/plugin/advisor/mysql/rule_collation_allowlist.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, &CollationAllowlistAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, &CollationAllowlistAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, &CollationAllowlistAdvisor{})
}
// CollationAllowlistAdvisor is the advisor checking for collation allowlist.
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 38a6d6f791..49383789a5 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
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, &ColumnAutoIncrementInitialValueAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, &ColumnAutoIncrementInitialValueAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, &ColumnAutoIncrementInitialValueAdvisor{})
}
// ColumnAutoIncrementInitialValueAdvisor is the advisor checking for auto-increment column initial value.
diff --git a/backend/plugin/advisor/mysql/rule_column_auto_increment_must_integer.go b/backend/plugin/advisor/mysql/rule_column_auto_increment_must_integer.go
index 49ea3c1746..18dfdaa34f 100644
--- a/backend/plugin/advisor/mysql/rule_column_auto_increment_must_integer.go
+++ b/backend/plugin/advisor/mysql/rule_column_auto_increment_must_integer.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, &ColumnAutoIncrementMustIntegerAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, &ColumnAutoIncrementMustIntegerAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, &ColumnAutoIncrementMustIntegerAdvisor{})
}
// ColumnAutoIncrementMustIntegerAdvisor is the advisor checking for auto-increment column type.
diff --git a/backend/plugin/advisor/mysql/rule_column_auto_increment_must_unsigned.go b/backend/plugin/advisor/mysql/rule_column_auto_increment_must_unsigned.go
index 6029ca06ab..2f165568c3 100644
--- a/backend/plugin/advisor/mysql/rule_column_auto_increment_must_unsigned.go
+++ b/backend/plugin/advisor/mysql/rule_column_auto_increment_must_unsigned.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, &ColumnAutoIncrementMustUnsignedAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, &ColumnAutoIncrementMustUnsignedAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, &ColumnAutoIncrementMustUnsignedAdvisor{})
}
// ColumnAutoIncrementMustUnsignedAdvisor is the advisor checking for unsigned auto-increment column.
diff --git a/backend/plugin/advisor/mysql/rule_column_comment_convention.go b/backend/plugin/advisor/mysql/rule_column_comment_convention.go
index d219633b7b..c0be6685b5 100644
--- a/backend/plugin/advisor/mysql/rule_column_comment_convention.go
+++ b/backend/plugin/advisor/mysql/rule_column_comment_convention.go
@@ -18,7 +18,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_COMMENT, &ColumnCommentConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_COMMENT, &ColumnCommentConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_COMMENT, &ColumnCommentConventionAdvisor{})
}
// ColumnCommentConventionAdvisor is the advisor checking for column comment convention.
diff --git a/backend/plugin/advisor/mysql/rule_column_current_time_count_limit.go b/backend/plugin/advisor/mysql/rule_column_current_time_count_limit.go
index d9c3549e6f..09b40ed130 100644
--- a/backend/plugin/advisor/mysql/rule_column_current_time_count_limit.go
+++ b/backend/plugin/advisor/mysql/rule_column_current_time_count_limit.go
@@ -25,7 +25,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, &ColumnCurrentTimeCountLimitAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, &ColumnCurrentTimeCountLimitAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, &ColumnCurrentTimeCountLimitAdvisor{})
}
// ColumnCurrentTimeCountLimitAdvisor is the advisor checking for current time column count limit.
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_changing.go b/backend/plugin/advisor/mysql/rule_column_disallow_changing.go
index 06395013e5..dc6bb8bf30 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_changing.go
+++ b/backend/plugin/advisor/mysql/rule_column_disallow_changing.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, &ColumnDisallowChangingAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, &ColumnDisallowChangingAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, &ColumnDisallowChangingAdvisor{})
}
// ColumnDisallowChangingAdvisor is the advisor checking for disallow CHANGE COLUMN statement.
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_changing_order.go b/backend/plugin/advisor/mysql/rule_column_disallow_changing_order.go
index 5516bd2710..4f3120f593 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_changing_order.go
+++ b/backend/plugin/advisor/mysql/rule_column_disallow_changing_order.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, &ColumnDisallowChangingOrderAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, &ColumnDisallowChangingOrderAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, &ColumnDisallowChangingOrderAdvisor{})
}
// ColumnDisallowChangingOrderAdvisor is the advisor checking for disallow changing column order.
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_changing_type.go b/backend/plugin/advisor/mysql/rule_column_disallow_changing_type.go
index d8c17c0f8f..f80f2f2b37 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_changing_type.go
+++ b/backend/plugin/advisor/mysql/rule_column_disallow_changing_type.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, &ColumnDisallowChangingTypeAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, &ColumnDisallowChangingTypeAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, &ColumnDisallowChangingTypeAdvisor{})
}
// ColumnDisallowChangingTypeAdvisor is the advisor checking for disallow changing column type.
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_drop_in_index.go b/backend/plugin/advisor/mysql/rule_column_disallow_drop_in_index.go
index 45d4b964ac..45407fd1f0 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_drop_in_index.go
+++ b/backend/plugin/advisor/mysql/rule_column_disallow_drop_in_index.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, &ColumnDisallowDropInIndexAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, &ColumnDisallowDropInIndexAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, &ColumnDisallowDropInIndexAdvisor{})
}
// ColumnDisallowDropInIndexAdvisor is the advisor checking for disallow DROP COLUMN in index.
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_set_charset.go b/backend/plugin/advisor/mysql/rule_column_disallow_set_charset.go
index 721b6ce8d7..827a78127a 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_set_charset.go
+++ b/backend/plugin/advisor/mysql/rule_column_disallow_set_charset.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, &ColumnDisallowSetCharsetAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, &ColumnDisallowSetCharsetAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, &ColumnDisallowSetCharsetAdvisor{})
}
// ColumnDisallowSetCharsetAdvisor is the advisor checking for disallow set column charset.
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 d0fec6b20b..6c9960acbc 100644
--- a/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go
+++ b/backend/plugin/advisor/mysql/rule_column_maximum_character_length.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, &ColumnMaximumCharacterLengthAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, &ColumnMaximumCharacterLengthAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, &ColumnMaximumCharacterLengthAdvisor{})
}
// ColumnMaximumCharacterLengthAdvisor is the advisor checking for max character length.
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 ddd5b0a55c..b39a85ea91 100644
--- a/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go
+++ b/backend/plugin/advisor/mysql/rule_column_maximum_varchar_length.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, &ColumnMaximumVarcharLengthAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, &ColumnMaximumVarcharLengthAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, &ColumnMaximumVarcharLengthAdvisor{})
}
// ColumnMaximumVarcharLengthAdvisor is the advisor checking for max varchar length.
diff --git a/backend/plugin/advisor/mysql/rule_column_no_null.go b/backend/plugin/advisor/mysql/rule_column_no_null.go
index 89e42dd9e9..cf9efddb8a 100644
--- a/backend/plugin/advisor/mysql/rule_column_no_null.go
+++ b/backend/plugin/advisor/mysql/rule_column_no_null.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_NO_NULL, &ColumnNoNullAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_NO_NULL, &ColumnNoNullAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_NO_NULL, &ColumnNoNullAdvisor{})
}
// ColumnNoNullAdvisor is the advisor checking for column no NULL value.
diff --git a/backend/plugin/advisor/mysql/rule_column_require_default.go b/backend/plugin/advisor/mysql/rule_column_require_default.go
index b3dcfbf2f2..cf17739a6f 100644
--- a/backend/plugin/advisor/mysql/rule_column_require_default.go
+++ b/backend/plugin/advisor/mysql/rule_column_require_default.go
@@ -18,7 +18,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, &ColumnRequireDefaultAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, &ColumnRequireDefaultAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, &ColumnRequireDefaultAdvisor{})
}
// ColumnRequireDefaultAdvisor is the advisor checking for column default requirement.
diff --git a/backend/plugin/advisor/mysql/rule_column_required.go b/backend/plugin/advisor/mysql/rule_column_required.go
index bb27172bb5..c206437b3f 100644
--- a/backend/plugin/advisor/mysql/rule_column_required.go
+++ b/backend/plugin/advisor/mysql/rule_column_required.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_REQUIRED, &ColumnRequirementAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_REQUIRED, &ColumnRequirementAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_REQUIRED, &ColumnRequirementAdvisor{})
}
// ColumnRequirementAdvisor is the advisor checking for column requirement.
diff --git a/backend/plugin/advisor/mysql/rule_column_set_default_for_not_null.go b/backend/plugin/advisor/mysql/rule_column_set_default_for_not_null.go
index 8cae5a8726..083e329a5b 100644
--- a/backend/plugin/advisor/mysql/rule_column_set_default_for_not_null.go
+++ b/backend/plugin/advisor/mysql/rule_column_set_default_for_not_null.go
@@ -18,7 +18,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, &ColumnSetDefaultForNotNullAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, &ColumnSetDefaultForNotNullAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, &ColumnSetDefaultForNotNullAdvisor{})
}
// ColumnSetDefaultForNotNullAdvisor is the advisor checking for set default value for not null column.
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 5780efa904..6b84733be4 100644
--- a/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go
+++ b/backend/plugin/advisor/mysql/rule_column_type_disallow_list.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, &ColumnTypeDisallowListAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, &ColumnTypeDisallowListAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, &ColumnTypeDisallowListAdvisor{})
}
// ColumnTypeDisallowListAdvisor is the advisor checking for column type restriction.
diff --git a/backend/plugin/advisor/mysql/rule_database_drop_empty_db.go b/backend/plugin/advisor/mysql/rule_database_drop_empty_db.go
index 179a07d891..e4f405a885 100644
--- a/backend/plugin/advisor/mysql/rule_database_drop_empty_db.go
+++ b/backend/plugin/advisor/mysql/rule_database_drop_empty_db.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, &DatabaseAllowDropIfEmptyAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, &DatabaseAllowDropIfEmptyAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, &DatabaseAllowDropIfEmptyAdvisor{})
}
// DatabaseAllowDropIfEmptyAdvisor is the advisor checking the MySQLDatabaseAllowDropIfEmpty rule.
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 115bbb045a..286a868d39 100644
--- a/backend/plugin/advisor/mysql/rule_index_key_number_limit.go
+++ b/backend/plugin/advisor/mysql/rule_index_key_number_limit.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, &IndexKeyNumberLimitAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, &IndexKeyNumberLimitAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, &IndexKeyNumberLimitAdvisor{})
}
// IndexKeyNumberLimitAdvisor is the advisor checking for index key number limit.
diff --git a/backend/plugin/advisor/mysql/rule_index_no_duplicate_column.go b/backend/plugin/advisor/mysql/rule_index_no_duplicate_column.go
index bf4b2500e7..21d380832d 100644
--- a/backend/plugin/advisor/mysql/rule_index_no_duplicate_column.go
+++ b/backend/plugin/advisor/mysql/rule_index_no_duplicate_column.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, &IndexNoDuplicateColumnAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, &IndexNoDuplicateColumnAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, &IndexNoDuplicateColumnAdvisor{})
}
// IndexNoDuplicateColumnAdvisor is the advisor checking for no duplicate columns in index.
diff --git a/backend/plugin/advisor/mysql/rule_index_pk_type.go b/backend/plugin/advisor/mysql/rule_index_pk_type.go
index 5012a50e65..becbbf7e9c 100644
--- a/backend/plugin/advisor/mysql/rule_index_pk_type.go
+++ b/backend/plugin/advisor/mysql/rule_index_pk_type.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, &IndexPkTypeAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, &IndexPkTypeAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, &IndexPkTypeAdvisor{})
}
// IndexPkTypeAdvisor is the advisor checking for correct type of PK.
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 60711ba1a2..0518e97b74 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
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, &IndexPrimaryKeyTypeAllowlistAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, &IndexPrimaryKeyTypeAllowlistAdvisor{})
}
// IndexPrimaryKeyTypeAllowlistAdvisor is the advisor checking for primary key type allowlist.
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 7707d3d541..995247af39 100644
--- a/backend/plugin/advisor/mysql/rule_index_total_number_limit.go
+++ b/backend/plugin/advisor/mysql/rule_index_total_number_limit.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, &IndexTotalNumberLimitAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, &IndexTotalNumberLimitAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, &IndexTotalNumberLimitAdvisor{})
}
// IndexTotalNumberLimitAdvisor is the advisor checking for index total number limit.
diff --git a/backend/plugin/advisor/mysql/rule_index_type_no_blob.go b/backend/plugin/advisor/mysql/rule_index_type_no_blob.go
index 8c87cf70d6..3cd4cb174b 100644
--- a/backend/plugin/advisor/mysql/rule_index_type_no_blob.go
+++ b/backend/plugin/advisor/mysql/rule_index_type_no_blob.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, &IndexTypeNoBlobAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, &IndexTypeNoBlobAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, &IndexTypeNoBlobAdvisor{})
}
// IndexTypeNoBlobAdvisor is the advisor checking for index type no blob.
diff --git a/backend/plugin/advisor/mysql/rule_insert_disallow_order_by_rand.go b/backend/plugin/advisor/mysql/rule_insert_disallow_order_by_rand.go
index 22949eedae..24d6d75320 100644
--- a/backend/plugin/advisor/mysql/rule_insert_disallow_order_by_rand.go
+++ b/backend/plugin/advisor/mysql/rule_insert_disallow_order_by_rand.go
@@ -22,7 +22,6 @@ const RandFn = "rand()"
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, &InsertDisallowOrderByRandAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, &InsertDisallowOrderByRandAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, &InsertDisallowOrderByRandAdvisor{})
}
// InsertDisallowOrderByRandAdvisor is the advisor checking for to disallow order by rand in INSERT statements.
diff --git a/backend/plugin/advisor/mysql/rule_insert_must_specify_column.go b/backend/plugin/advisor/mysql/rule_insert_must_specify_column.go
index b32b77881f..a86f8a5b54 100644
--- a/backend/plugin/advisor/mysql/rule_insert_must_specify_column.go
+++ b/backend/plugin/advisor/mysql/rule_insert_must_specify_column.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, &InsertMustSpecifyColumnAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, &InsertMustSpecifyColumnAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, &InsertMustSpecifyColumnAdvisor{})
}
// InsertMustSpecifyColumnAdvisor is the advisor checking for to enforce column specified.
diff --git a/backend/plugin/advisor/mysql/rule_migration_compatibility.go b/backend/plugin/advisor/mysql/rule_migration_compatibility.go
index c2e3c47376..8e4eb9dd4c 100644
--- a/backend/plugin/advisor/mysql/rule_migration_compatibility.go
+++ b/backend/plugin/advisor/mysql/rule_migration_compatibility.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, &CompatibilityAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, &CompatibilityAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, &CompatibilityAdvisor{})
}
// CompatibilityAdvisor is the advisor checking for schema backward compatibility.
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 ad40ba8f9e..142cb4437a 100644
--- a/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go
+++ b/backend/plugin/advisor/mysql/rule_naming_auto_increment_column.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, &NamingAutoIncrementColumnAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, &NamingAutoIncrementColumnAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, &NamingAutoIncrementColumnAdvisor{})
}
// NamingAutoIncrementColumnAdvisor is the advisor checking for auto-increment naming convention.
diff --git a/backend/plugin/advisor/mysql/rule_naming_column.go b/backend/plugin/advisor/mysql/rule_naming_column.go
index a0bfd4dd2a..b3fcf5509d 100644
--- a/backend/plugin/advisor/mysql/rule_naming_column.go
+++ b/backend/plugin/advisor/mysql/rule_naming_column.go
@@ -19,7 +19,6 @@ var _ advisor.Advisor = (*NamingColumnConventionAdvisor)(nil)
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_COLUMN, &NamingColumnConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_COLUMN, &NamingColumnConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_COLUMN, &NamingColumnConventionAdvisor{})
}
// NamingColumnConventionAdvisor is the advisor checking for column naming convention.
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 b42b38abff..8ccc99153f 100644
--- a/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_foreign_key_convention.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_INDEX_FK, &NamingFKConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_INDEX_FK, &NamingFKConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_FK, &NamingFKConventionAdvisor{})
}
// NamingFKConventionAdvisor is the advisor checking for foreign key naming convention.
diff --git a/backend/plugin/advisor/mysql/rule_naming_index_convention.go b/backend/plugin/advisor/mysql/rule_naming_index_convention.go
index 741e245378..acf862156c 100644
--- a/backend/plugin/advisor/mysql/rule_naming_index_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_index_convention.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_INDEX_IDX, &NamingIndexConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_INDEX_IDX, &NamingIndexConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_IDX, &NamingIndexConventionAdvisor{})
}
// indexMetaData is the metadata for index.
diff --git a/backend/plugin/advisor/mysql/rule_naming_table.go b/backend/plugin/advisor/mysql/rule_naming_table.go
index 197631a639..216235f330 100644
--- a/backend/plugin/advisor/mysql/rule_naming_table.go
+++ b/backend/plugin/advisor/mysql/rule_naming_table.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_TABLE, &NamingTableConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_TABLE, &NamingTableConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_TABLE, &NamingTableConventionAdvisor{})
}
// NamingTableConventionAdvisor is the advisor checking for table naming convention.
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 dfc18e08c5..595bec1b43 100644
--- a/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go
+++ b/backend/plugin/advisor/mysql/rule_naming_unique_key_convention.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_NAMING_INDEX_UK, &NamingUKConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_NAMING_INDEX_UK, &NamingUKConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_UK, &NamingUKConventionAdvisor{})
}
// NamingUKConventionAdvisor is the advisor checking for unique key naming convention.
diff --git a/backend/plugin/advisor/mysql/rule_statement_disallow_truncate.go b/backend/plugin/advisor/mysql/rule_statement_disallow_truncate.go
index 93a94aa11b..778b7c00a2 100644
--- a/backend/plugin/advisor/mysql/rule_statement_disallow_truncate.go
+++ b/backend/plugin/advisor/mysql/rule_statement_disallow_truncate.go
@@ -17,7 +17,6 @@ var _ advisor.Advisor = (*StatementDisallowTruncateAdvisor)(nil)
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_DISALLOW_TRUNCATE, &StatementDisallowTruncateAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_DISALLOW_TRUNCATE, &StatementDisallowTruncateAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_TRUNCATE, &StatementDisallowTruncateAdvisor{})
}
type StatementDisallowTruncateAdvisor struct{}
diff --git a/backend/plugin/advisor/mysql/rule_statement_dml_dry_run.go b/backend/plugin/advisor/mysql/rule_statement_dml_dry_run.go
index 32b9b42730..cb4650324b 100644
--- a/backend/plugin/advisor/mysql/rule_statement_dml_dry_run.go
+++ b/backend/plugin/advisor/mysql/rule_statement_dml_dry_run.go
@@ -22,7 +22,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, &StatementDmlDryRunAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, &StatementDmlDryRunAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, &StatementDmlDryRunAdvisor{})
}
// StatementDmlDryRunAdvisor is the advisor checking for DML dry run.
diff --git a/backend/plugin/advisor/mysql/rule_statement_merge_alter_table.go b/backend/plugin/advisor/mysql/rule_statement_merge_alter_table.go
index 8f20c031ed..23b2b9be90 100644
--- a/backend/plugin/advisor/mysql/rule_statement_merge_alter_table.go
+++ b/backend/plugin/advisor/mysql/rule_statement_merge_alter_table.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, &StatementMergeAlterTableAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, &StatementMergeAlterTableAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, &StatementMergeAlterTableAdvisor{})
}
// StatementMergeAlterTableAdvisor is the advisor checking for merging ALTER TABLE statements.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_disallow_commit.go b/backend/plugin/advisor/mysql/rule_stmt_disallow_commit.go
index 7f22df5b3c..2a4667032b 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_disallow_commit.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_disallow_commit.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, &StatementDisallowCommitAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, &StatementDisallowCommitAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, &StatementDisallowCommitAdvisor{})
}
// StatementDisallowCommitAdvisor is the advisor checking for disallowing commit.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_disallow_limit.go b/backend/plugin/advisor/mysql/rule_stmt_disallow_limit.go
index ac4dd5e274..8d4b1ad7a3 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_disallow_limit.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_disallow_limit.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, &StatementDisallowLimitAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, &StatementDisallowLimitAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, &StatementDisallowLimitAdvisor{})
}
// StatementDisallowLimitAdvisor is the advisor checking for no LIMIT clause in INSERT/UPDATE/DELETE statement.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_disallow_order_by.go b/backend/plugin/advisor/mysql/rule_stmt_disallow_order_by.go
index 76fcbfbfff..ec506aad52 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_disallow_order_by.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_disallow_order_by.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, &DisallowOrderByAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, &DisallowOrderByAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, &DisallowOrderByAdvisor{})
}
// DisallowOrderByAdvisor is the advisor checking for no ORDER BY clause in DELETE/UPDATE statements.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_no_leading_wildcard_like.go b/backend/plugin/advisor/mysql/rule_stmt_no_leading_wildcard_like.go
index ea39c98df1..1b5d0205ab 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_no_leading_wildcard_like.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_no_leading_wildcard_like.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, &NoLeadingWildcardLikeAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, &NoLeadingWildcardLikeAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, &NoLeadingWildcardLikeAdvisor{})
}
// NoLeadingWildcardLikeAdvisor is the advisor checking for no leading wildcard LIKE.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_no_select_all.go b/backend/plugin/advisor/mysql/rule_stmt_no_select_all.go
index dfc6f999e9..08b61d7311 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_no_select_all.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_no_select_all.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, &NoSelectAllAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, &NoSelectAllAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, &NoSelectAllAdvisor{})
}
// NoSelectAllAdvisor is the advisor checking for no "select *".
diff --git a/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_select.go b/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_select.go
index ef8a00cb96..8bfc9d17f2 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_select.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_select.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, &WhereRequirementForSelectAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, &WhereRequirementForSelectAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, &WhereRequirementForSelectAdvisor{})
}
// WhereRequirementForSelectAdvisor is the advisor checking for the WHERE clause requirement for SELECT statements.
diff --git a/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_update_delete.go b/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_update_delete.go
index 7b0cb12e6d..ec548b7cbd 100644
--- a/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_update_delete.go
+++ b/backend/plugin/advisor/mysql/rule_stmt_where_requirement_for_update_delete.go
@@ -20,7 +20,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, &WhereRequirementForUpdateDeleteAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, &WhereRequirementForUpdateDeleteAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, &WhereRequirementForUpdateDeleteAdvisor{})
}
// WhereRequirementForUpdateDeleteAdvisor is the advisor checking for the WHERE clause requirement for UPDATE/DELETE statements.
diff --git a/backend/plugin/advisor/mysql/rule_table_comment_convention.go b/backend/plugin/advisor/mysql/rule_table_comment_convention.go
index e0c0d938f7..551e70449c 100644
--- a/backend/plugin/advisor/mysql/rule_table_comment_convention.go
+++ b/backend/plugin/advisor/mysql/rule_table_comment_convention.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_TABLE_COMMENT, &TableCommentConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_TABLE_COMMENT, &TableCommentConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_COMMENT, &TableCommentConventionAdvisor{})
}
// TableCommentConventionAdvisor is the advisor checking for table comment convention.
diff --git a/backend/plugin/advisor/mysql/rule_table_disallow_partition.go b/backend/plugin/advisor/mysql/rule_table_disallow_partition.go
index 64810889ff..3fe18dac20 100644
--- a/backend/plugin/advisor/mysql/rule_table_disallow_partition.go
+++ b/backend/plugin/advisor/mysql/rule_table_disallow_partition.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, &TableDisallowPartitionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, &TableDisallowPartitionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, &TableDisallowPartitionAdvisor{})
}
// TableDisallowPartitionAdvisor is the advisor checking for disallow table partition.
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 46265a2c4e..763e00a903 100644
--- a/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go
+++ b/backend/plugin/advisor/mysql/rule_table_drop_naming_convention.go
@@ -21,7 +21,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, &TableDropNamingConventionAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, &TableDropNamingConventionAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, &TableDropNamingConventionAdvisor{})
}
// TableDropNamingConventionAdvisor is the advisor checking the MySQLTableDropNamingConvention rule.
diff --git a/backend/plugin/advisor/mysql/rule_table_no_fk.go b/backend/plugin/advisor/mysql/rule_table_no_fk.go
index 060b11258c..71fa2c1019 100644
--- a/backend/plugin/advisor/mysql/rule_table_no_fk.go
+++ b/backend/plugin/advisor/mysql/rule_table_no_fk.go
@@ -19,7 +19,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, &TableNoFKAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, &TableNoFKAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, &TableNoFKAdvisor{})
}
// TableNoFKAdvisor is the advisor checking table disallow foreign key.
diff --git a/backend/plugin/advisor/mysql/rule_table_require_pk.go b/backend/plugin/advisor/mysql/rule_table_require_pk.go
index 7933a9bd22..4cf2b2ddca 100644
--- a/backend/plugin/advisor/mysql/rule_table_require_pk.go
+++ b/backend/plugin/advisor/mysql/rule_table_require_pk.go
@@ -25,7 +25,6 @@ var (
func init() {
advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_TABLE_REQUIRE_PK, &TableRequirePKAdvisor{})
advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_TABLE_REQUIRE_PK, &TableRequirePKAdvisor{})
- advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_REQUIRE_PK, &TableRequirePKAdvisor{})
}
// TableRequirePKAdvisor is the advisor checking table requires PK.
diff --git a/backend/plugin/advisor/oceanbase/advisor_builtin_walk_through_check.go b/backend/plugin/advisor/oceanbase/advisor_builtin_walk_through_check.go
new file mode 100644
index 0000000000..a237f122ae
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/advisor_builtin_walk_through_check.go
@@ -0,0 +1,10 @@
+package oceanbase
+
+import (
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_BUILTIN_WALK_THROUGH_CHECK, &advisor.BuiltinWalkThroughCheckAdvisor{})
+}
diff --git a/backend/plugin/advisor/oceanbase/advisor_disallow_offline_ddl.go b/backend/plugin/advisor/oceanbase/advisor_disallow_offline_ddl.go
index 410c6064a9..fc162cc6d5 100644
--- a/backend/plugin/advisor/oceanbase/advisor_disallow_offline_ddl.go
+++ b/backend/plugin/advisor/oceanbase/advisor_disallow_offline_ddl.go
@@ -8,13 +8,13 @@ import (
"fmt"
"strings"
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
- mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
var (
@@ -47,7 +47,7 @@ func (*DisallowOfflineDdlAdvisor) Check(_ context.Context, checkCtx advisor.Cont
if stmt.AST == nil {
continue
}
- node, ok := mysqlparser.GetOmniNode(stmt.AST)
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
if !ok {
continue
}
@@ -78,7 +78,7 @@ func (checker *disallowOfflineDdlChecker) checkStatement(text string, baseLine i
}
func (checker *disallowOfflineDdlChecker) checkAlterTable(text string, baseLine int, stmt *ast.AlterTableStmt) {
- databaseName, tableName := omniTableName(stmt.Table)
+ databaseName, tableName := omniTableSchemaAndName(stmt.Table)
if databaseName == "" {
databaseName = checker.currentDB
}
diff --git a/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go b/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
index 3ee1228cfb..19a71ca714 100644
--- a/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
+++ b/backend/plugin/advisor/oceanbase/advisor_insert_row_limit.go
@@ -7,13 +7,13 @@ import (
"github.com/pkg/errors"
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
- mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
var (
@@ -52,7 +52,7 @@ func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Contex
if stmt.AST == nil {
continue
}
- node, ok := mysqlparser.GetOmniNode(stmt.AST)
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
if !ok {
continue
}
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 ed84155822..3ca30aa16a 100644
--- a/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go
+++ b/backend/plugin/advisor/oceanbase/advisor_statement_affected_row_limit.go
@@ -7,13 +7,13 @@ import (
"github.com/pkg/errors"
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
- mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
var (
@@ -51,7 +51,7 @@ func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx adv
if stmt.AST == nil {
continue
}
- node, ok := mysqlparser.GetOmniNode(stmt.AST)
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
if !ok {
continue
}
diff --git a/backend/plugin/advisor/oceanbase/common.go b/backend/plugin/advisor/oceanbase/common.go
index 360018e48a..9e92bb9daf 100644
--- a/backend/plugin/advisor/oceanbase/common.go
+++ b/backend/plugin/advisor/oceanbase/common.go
@@ -5,7 +5,7 @@ import (
"github.com/pkg/errors"
- mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
// getEstimatedRowsFromJSON extracts the estimated row count from an OceanBase
@@ -32,5 +32,5 @@ func getEstimatedRowsFromJSON(res []any) (int64, error) {
}
}
}
- return mysqlparser.EstimateAffectedRowsFromOceanBaseExplainJSON(plan.String())
+ return oceanbaseparser.EstimateAffectedRowsFromExplainJSON(plan.String())
}
diff --git a/backend/plugin/advisor/oceanbase/generic_checker.go b/backend/plugin/advisor/oceanbase/generic_checker.go
new file mode 100644
index 0000000000..e884a7c347
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/generic_checker.go
@@ -0,0 +1,153 @@
+package oceanbase
+
+import (
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+// OmniRule defines the interface for omni-based SQL validation rules.
+type OmniRule interface {
+ // OnStatement is called for each top-level statement AST node.
+ OnStatement(node ast.Node)
+
+ // Name returns the rule name for logging/debugging.
+ Name() string
+
+ // GetAdviceList returns the accumulated advice from this rule.
+ GetAdviceList() []*storepb.Advice
+}
+
+// OmniBaseRule provides common functionality for omni-based rules.
+type OmniBaseRule struct {
+ Level storepb.Advice_Status
+ Title string
+ Advice []*storepb.Advice
+ BaseLine int
+ StmtText string
+}
+
+// SetStatement sets the statement context for position calculations.
+func (r *OmniBaseRule) SetStatement(baseLine int, stmtText string) {
+ r.BaseLine = baseLine
+ r.StmtText = stmtText
+}
+
+// GetAdviceList returns the accumulated advice.
+func (r *OmniBaseRule) GetAdviceList() []*storepb.Advice {
+ return r.Advice
+}
+
+// AddAdvice adds advice. The BaseLine offset is added automatically to StartPosition.Line.
+func (r *OmniBaseRule) AddAdvice(advice *storepb.Advice) {
+ if advice.StartPosition != nil {
+ advice.StartPosition.Line += int32(r.BaseLine)
+ }
+ r.Advice = append(r.Advice, advice)
+}
+
+// AddAdviceAbsolute adds advice with an already-absolute line number.
+func (r *OmniBaseRule) AddAdviceAbsolute(advice *storepb.Advice) {
+ r.Advice = append(r.Advice, advice)
+}
+
+// LocToLine converts an omni Loc byte offset to a 1-based line number
+// within the current statement text. The returned value includes any leading
+// newlines in StmtText, matching ANTLR's GetStart().GetLine() behavior when
+// ANTLR parses the same text. Suitable for: BaseLine + LocToLine(loc).
+func (r *OmniBaseRule) LocToLine(loc ast.Loc) int32 {
+ if loc.Start < 0 || r.StmtText == "" {
+ return r.ContentStartLine()
+ }
+ pos := oceanbaseparser.ByteOffsetToRunePosition(r.StmtText, loc.Start)
+ return pos.Line
+}
+
+// QueryText returns the statement text with leading/trailing whitespace trimmed.
+func (r *OmniBaseRule) QueryText() string {
+ return strings.TrimSpace(r.StmtText)
+}
+
+// TrimmedStmtText returns the statement text with leading/trailing whitespace
+// and trailing semicolons removed.
+func (r *OmniBaseRule) TrimmedStmtText() string {
+ return strings.TrimRight(strings.TrimSpace(r.StmtText), ";")
+}
+
+// ContentStartLine returns the 1-based line number of the first non-whitespace
+// character in StmtText. Returns 1 if the text is empty or has no leading newlines.
+func (r *OmniBaseRule) ContentStartLine() int32 {
+ idx := strings.IndexFunc(r.StmtText, func(c rune) bool {
+ return c != ' ' && c != '\t' && c != '\n' && c != '\r'
+ })
+ if idx <= 0 {
+ return 1
+ }
+ pos := oceanbaseparser.ByteOffsetToRunePosition(r.StmtText, idx)
+ return pos.Line
+}
+
+// ContentEndLine returns the 1-based line number of the last non-whitespace
+// character in StmtText.
+func (r *OmniBaseRule) ContentEndLine() int32 {
+ if r.StmtText == "" {
+ return 1
+ }
+ idx := -1
+ for i := len(r.StmtText) - 1; i >= 0; i-- {
+ c := r.StmtText[i]
+ if c != ' ' && c != '\t' && c != '\n' && c != '\r' && c != ';' {
+ idx = i
+ break
+ }
+ }
+ if idx <= 0 {
+ return 1
+ }
+ pos := oceanbaseparser.ByteOffsetToRunePosition(r.StmtText, idx)
+ return pos.Line
+}
+
+// FindLineByName searches for an identifier name in the statement text and returns
+// its 1-based line number. Falls back to ContentStartLine() if not found.
+func (r *OmniBaseRule) FindLineByName(name string) int32 {
+ if name == "" || r.StmtText == "" {
+ return r.ContentStartLine()
+ }
+ idx := strings.Index(r.StmtText, name)
+ if idx < 0 {
+ return r.ContentStartLine()
+ }
+ pos := oceanbaseparser.ByteOffsetToRunePosition(r.StmtText, idx)
+ return pos.Line
+}
+
+// RunRules iterates over parsed statements and dispatches each omni AST node to all rules.
+// Returns combined advice from all rules. Skips statements without omni AST.
+func RunRules(stmts []base.ParsedStatement, rules []OmniRule) []*storepb.Advice {
+ for _, stmt := range stmts {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ baseLine := stmt.BaseLine()
+ for _, rule := range rules {
+ if br, ok := rule.(interface{ SetStatement(int, string) }); ok {
+ br.SetStatement(baseLine, stmt.Text)
+ }
+ rule.OnStatement(node)
+ }
+ }
+ var allAdvice []*storepb.Advice
+ for _, rule := range rules {
+ allAdvice = append(allAdvice, rule.GetAdviceList()...)
+ }
+ return allAdvice
+}
diff --git a/backend/plugin/advisor/oceanbase/oceanbase_rules_test.go b/backend/plugin/advisor/oceanbase/oceanbase_rules_test.go
new file mode 100644
index 0000000000..096700ca86
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/oceanbase_rules_test.go
@@ -0,0 +1,80 @@
+package oceanbase
+
+import (
+ "testing"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+)
+
+// TestOceanBaseRules runs the rules this package registers for OceanBase over the
+// fixtures in test/, so a rule that stops firing on OceanBase's own AST is caught
+// here rather than letting an OceanBase review pass silently.
+//
+// Three registered rules are not here: COLUMN_DISALLOW_DROP and
+// STATEMENT_ADD_COLUMN_WITHOUT_POSITION have no fixtures anywhere, and
+// STATEMENT_DISALLOW_OFFLINE_DDL is covered by its own test in this package.
+//
+// The fixtures are advisor/mysql's, which the rules share, but for
+// statement_insert_row_limit: OceanBase has its own advisor, which quotes the
+// statement without trimming the leading newline MySQL's trims.
+func TestOceanBaseRules(t *testing.T) {
+ rules := []*storepb.SQLReviewRule{
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 20}}},
+ {Type: storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 2560}}},
+ {Type: storepb.SQLReviewRule_COLUMN_NO_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRED, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"id", "created_ts", "updated_ts", "creator_id", "updater_id"}}}},
+ {Type: storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"JSON", "BINARY_FLOAT"}}}},
+ {Type: storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"serial", "bigserial", "int", "bigint"}}}},
+ {Type: storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^id$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_FK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^fk_{{referencing_table}}_{{referencing_column}}_{{referenced_table}}_{{referenced_column}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_IDX, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^idx_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_INDEX_UK, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^$|^uk_{{table}}_{{column_list}}$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_NAMING_TABLE, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "^[a-z]+(_[a-z]+)*$", MaxLength: 64}}},
+ {Type: storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_AFFECTED_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DISALLOW_TRUNCATE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_INSERT_ROW_LIMIT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NumberPayload{NumberPayload: &storepb.SQLReviewRule_NumberRulePayload{Number: 5}}},
+ {Type: storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4", "UTF8"}}}},
+ {Type: storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_StringArrayPayload{StringArrayPayload: &storepb.SQLReviewRule_StringArrayRulePayload{List: []string{"utf8mb4_0900_ai_ci"}}}},
+ {Type: storepb.SQLReviewRule_TABLE_COMMENT, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_CommentConventionPayload{CommentConventionPayload: &storepb.SQLReviewRule_CommentConventionRulePayload{Required: true, MaxLength: 10}}},
+ {Type: storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, Level: storepb.SQLReviewRule_WARNING, Payload: &storepb.SQLReviewRule_NamingPayload{NamingPayload: &storepb.SQLReviewRule_NamingRulePayload{Format: "_delete$"}}},
+ {Type: storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, Level: storepb.SQLReviewRule_WARNING},
+ {Type: storepb.SQLReviewRule_TABLE_REQUIRE_PK, Level: storepb.SQLReviewRule_WARNING},
+ }
+
+ for _, rule := range rules {
+ advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_OCEANBASE, false /* record */)
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/omni_helpers.go b/backend/plugin/advisor/oceanbase/omni_helpers.go
index 12544a2b90..43df60ce17 100644
--- a/backend/plugin/advisor/oceanbase/omni_helpers.go
+++ b/backend/plugin/advisor/oceanbase/omni_helpers.go
@@ -1,19 +1,19 @@
package oceanbase
import (
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
- mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
)
func omniLine(baseLine int, text string, loc ast.Loc) int {
if loc.Start < 0 {
return baseLine + 1
}
- return baseLine + int(mysqlparser.ByteOffsetToRunePosition(text, loc.Start).Line)
+ return baseLine + int(oceanbaseparser.ByteOffsetToRunePosition(text, loc.Start).Line)
}
-func omniTableName(table *ast.TableRef) (string, string) {
+func omniTableSchemaAndName(table *ast.TableRef) (string, string) {
if table == nil {
return "", ""
}
diff --git a/backend/plugin/advisor/oceanbase/rule_charset_allowlist.go b/backend/plugin/advisor/oceanbase/rule_charset_allowlist.go
new file mode 100644
index 0000000000..630cc4cf24
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_charset_allowlist.go
@@ -0,0 +1,154 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*CharsetAllowlistAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SYSTEM_CHARSET_ALLOWLIST, &CharsetAllowlistAdvisor{})
+}
+
+// CharsetAllowlistAdvisor is the advisor checking for charset allowlist.
+type CharsetAllowlistAdvisor struct {
+}
+
+// Check checks for charset allowlist.
+func (*CharsetAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+
+ allowList := make(map[string]bool)
+ for _, charset := range stringArrayPayload.List {
+ allowList[strings.ToLower(charset)] = true
+ }
+
+ rule := &charsetAllowlistOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ allowList: allowList,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type charsetAllowlistOmniRule struct {
+ OmniBaseRule
+ allowList map[string]bool
+}
+
+func (*charsetAllowlistOmniRule) Name() string {
+ return "CharsetAllowlistRule"
+}
+
+func (r *charsetAllowlistOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateDatabaseStmt:
+ r.checkCreateDatabase(n)
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterDatabaseStmt:
+ r.checkAlterDatabase(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *charsetAllowlistOmniRule) checkCharset(charset string, line int) {
+ charset = strings.ToLower(charset)
+ if charset != "" && !r.allowList[charset] {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DisabledCharset.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" used disabled charset '%s'", r.QueryText(), charset),
+ StartPosition: base.ConvertANTLRLineToPosition(line),
+ })
+ }
+}
+
+func (r *charsetAllowlistOmniRule) checkCreateDatabase(n *ast.CreateDatabaseStmt) {
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "CHARACTER SET") || strings.EqualFold(opt.Name, "CHARSET") {
+ r.checkCharset(opt.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ break
+ }
+ }
+}
+
+func (r *charsetAllowlistOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ // Check table-level charset option.
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "CHARACTER SET") || strings.EqualFold(opt.Name, "CHARSET") || strings.EqualFold(opt.Name, "DEFAULT CHARSET") {
+ r.checkCharset(opt.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ break
+ }
+ }
+ // Check column-level charset.
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ if col.TypeName.Charset != "" {
+ r.checkCharset(col.TypeName.Charset, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+}
+
+func (r *charsetAllowlistOmniRule) checkAlterDatabase(n *ast.AlterDatabaseStmt) {
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "CHARACTER SET") || strings.EqualFold(opt.Name, "CHARSET") {
+ r.checkCharset(opt.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+}
+
+func (r *charsetAllowlistOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn, ast.ATModifyColumn, ast.ATChangeColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ if col.TypeName.Charset != "" {
+ r.checkCharset(col.TypeName.Charset, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ case ast.ATTableOption:
+ if cmd.Option != nil {
+ if strings.EqualFold(cmd.Option.Name, "CHARACTER SET") || strings.EqualFold(cmd.Option.Name, "CHARSET") || strings.EqualFold(cmd.Option.Name, "DEFAULT CHARSET") {
+ r.checkCharset(cmd.Option.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ case ast.ATConvertCharset:
+ if cmd.Option != nil {
+ if strings.EqualFold(cmd.Option.Name, "CHARACTER SET") || strings.EqualFold(cmd.Option.Name, "CHARSET") {
+ r.checkCharset(cmd.Option.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ default:
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_collation_allowlist.go b/backend/plugin/advisor/oceanbase/rule_collation_allowlist.go
new file mode 100644
index 0000000000..1fac4ca9d1
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_collation_allowlist.go
@@ -0,0 +1,155 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*CollationAllowlistAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SYSTEM_COLLATION_ALLOWLIST, &CollationAllowlistAdvisor{})
+}
+
+// CollationAllowlistAdvisor is the advisor checking for collation allowlist.
+type CollationAllowlistAdvisor struct {
+}
+
+// Check checks for collation allowlist.
+func (*CollationAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+
+ allowList := make(map[string]bool)
+ for _, collation := range stringArrayPayload.List {
+ allowList[strings.ToLower(collation)] = true
+ }
+
+ rule := &collationAllowlistOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ allowList: allowList,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type collationAllowlistOmniRule struct {
+ OmniBaseRule
+ allowList map[string]bool
+}
+
+func (*collationAllowlistOmniRule) Name() string {
+ return "CollationAllowlistRule"
+}
+
+func (r *collationAllowlistOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateDatabaseStmt:
+ r.checkCreateDatabase(n)
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterDatabaseStmt:
+ r.checkAlterDatabase(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *collationAllowlistOmniRule) checkCollation(collation string, line int) {
+ collation = strings.ToLower(collation)
+ if collation != "" && !r.allowList[collation] {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DisabledCollation.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" used disabled collation '%s'", r.QueryText(), collation),
+ StartPosition: base.ConvertANTLRLineToPosition(line),
+ })
+ }
+}
+
+func (r *collationAllowlistOmniRule) checkCreateDatabase(n *ast.CreateDatabaseStmt) {
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "COLLATE") {
+ r.checkCollation(opt.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+}
+
+func (r *collationAllowlistOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ // Check table-level collation option.
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "COLLATE") {
+ r.checkCollation(opt.Value, r.BaseLine+int(r.LocToLine(opt.Loc)))
+ }
+ }
+ // Check column-level collation.
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ if col.TypeName.Collate != "" {
+ r.checkCollation(col.TypeName.Collate, r.BaseLine+int(r.LocToLine(col.Loc)))
+ }
+ // Also check column constraints for COLLATE.
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrCollate && c.Name != "" {
+ r.checkCollation(c.Name, r.BaseLine+int(r.LocToLine(col.Loc)))
+ }
+ }
+ }
+}
+
+func (r *collationAllowlistOmniRule) checkAlterDatabase(n *ast.AlterDatabaseStmt) {
+ for _, opt := range n.Options {
+ if strings.EqualFold(opt.Name, "COLLATE") {
+ r.checkCollation(opt.Value, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+}
+
+func (r *collationAllowlistOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn, ast.ATModifyColumn, ast.ATChangeColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ if col.TypeName.Collate != "" {
+ r.checkCollation(col.TypeName.Collate, r.BaseLine+int(r.LocToLine(cmd.Loc)))
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrCollate && c.Name != "" {
+ r.checkCollation(c.Name, r.BaseLine+int(r.LocToLine(cmd.Loc)))
+ }
+ }
+ }
+ case ast.ATTableOption:
+ if cmd.Option != nil && strings.EqualFold(cmd.Option.Name, "COLLATE") {
+ r.checkCollation(cmd.Option.Value, r.BaseLine+int(r.LocToLine(cmd.Option.Loc)))
+ }
+ default:
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_auto_increment_initial_value.go b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_initial_value.go
new file mode 100644
index 0000000000..063e6da7cf
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_initial_value.go
@@ -0,0 +1,127 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strconv"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnAutoIncrementInitialValueAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_INITIAL_VALUE, &ColumnAutoIncrementInitialValueAdvisor{})
+}
+
+// ColumnAutoIncrementInitialValueAdvisor is the advisor checking for auto-increment column initial value.
+type ColumnAutoIncrementInitialValueAdvisor struct {
+}
+
+// Check checks for auto-increment column initial value.
+func (*ColumnAutoIncrementInitialValueAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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")
+ }
+
+ rule := &columnAutoIncrementInitialValueOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ value: int(numberPayload.Number),
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnAutoIncrementInitialValueOmniRule struct {
+ OmniBaseRule
+ value int
+}
+
+func (*columnAutoIncrementInitialValueOmniRule) Name() string {
+ return "ColumnAutoIncrementInitialValueRule"
+}
+
+func (r *columnAutoIncrementInitialValueOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnAutoIncrementInitialValueOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ r.checkOptions(tableName, n.Options, r.LocToLine(n.Loc))
+}
+
+func (r *columnAutoIncrementInitialValueOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ if cmd.Type == ast.ATTableOption && cmd.Option != nil && strings.EqualFold(cmd.Option.Name, "AUTO_INCREMENT") {
+ r.checkOptionValue(tableName, cmd.Option.Value, r.LocToLine(n.Loc))
+ }
+ }
+}
+
+func (r *columnAutoIncrementInitialValueOmniRule) checkOptions(tableName string, opts []*ast.TableOption, line int32) {
+ for _, opt := range opts {
+ if strings.EqualFold(opt.Name, "AUTO_INCREMENT") {
+ r.checkOptionValue(tableName, opt.Value, line)
+ }
+ }
+}
+
+func (r *columnAutoIncrementInitialValueOmniRule) checkOptionValue(tableName, valueStr string, line int32) {
+ value, err := strconv.ParseUint(valueStr, 10, 0)
+ if err != nil {
+ return
+ }
+ if value != uint64(r.value) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.AutoIncrementColumnInitialValueNotMatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The initial auto-increment value in table `%s` is %v, which doesn't equal %v", tableName, value, r.value),
+ StartPosition: &storepb.Position{
+ Line: line,
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_integer.go b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_integer.go
new file mode 100644
index 0000000000..a4aa754eed
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_integer.go
@@ -0,0 +1,111 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnAutoIncrementMustIntegerAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_INTEGER, &ColumnAutoIncrementMustIntegerAdvisor{})
+}
+
+// ColumnAutoIncrementMustIntegerAdvisor is the advisor checking for auto-increment column type.
+type ColumnAutoIncrementMustIntegerAdvisor struct {
+}
+
+// Check checks for auto-increment column type.
+func (*ColumnAutoIncrementMustIntegerAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnAutoIncrementMustIntegerOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnAutoIncrementMustIntegerOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnAutoIncrementMustIntegerOmniRule) Name() string {
+ return "ColumnAutoIncrementMustIntegerRule"
+}
+
+func (r *columnAutoIncrementMustIntegerOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnAutoIncrementMustIntegerOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ r.checkColumn(tableName, col)
+ }
+}
+
+func (r *columnAutoIncrementMustIntegerOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ r.checkColumn(tableName, col)
+ }
+ }
+}
+
+func (r *columnAutoIncrementMustIntegerOmniRule) checkColumn(tableName string, col *ast.ColumnDef) {
+ if !omniIsAutoIncrement(col) {
+ return
+ }
+ if !omniIsIntegerType(col.TypeName) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.AutoIncrementColumnNotInteger.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Auto-increment column `%s`.`%s` requires integer type", tableName, col.Name),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_unsigned.go b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_unsigned.go
new file mode 100644
index 0000000000..8149f112dd
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_auto_increment_must_unsigned.go
@@ -0,0 +1,111 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnAutoIncrementMustUnsignedAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_AUTO_INCREMENT_MUST_UNSIGNED, &ColumnAutoIncrementMustUnsignedAdvisor{})
+}
+
+// ColumnAutoIncrementMustUnsignedAdvisor is the advisor checking for unsigned auto-increment column.
+type ColumnAutoIncrementMustUnsignedAdvisor struct {
+}
+
+// Check checks for unsigned auto-increment column.
+func (*ColumnAutoIncrementMustUnsignedAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnAutoIncrementMustUnsignedOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnAutoIncrementMustUnsignedOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnAutoIncrementMustUnsignedOmniRule) Name() string {
+ return "ColumnAutoIncrementMustUnsignedRule"
+}
+
+func (r *columnAutoIncrementMustUnsignedOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnAutoIncrementMustUnsignedOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ r.checkColumn(tableName, col)
+ }
+}
+
+func (r *columnAutoIncrementMustUnsignedOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ r.checkColumn(tableName, col)
+ }
+ }
+}
+
+func (r *columnAutoIncrementMustUnsignedOmniRule) checkColumn(tableName string, col *ast.ColumnDef) {
+ if !omniIsAutoIncrement(col) {
+ return
+ }
+ if col.TypeName == nil || (!col.TypeName.Unsigned && !col.TypeName.Zerofill) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.AutoIncrementColumnSigned.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Auto-increment column `%s`.`%s` is not UNSIGNED type", tableName, col.Name),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_comment_convention.go b/backend/plugin/advisor/oceanbase/rule_column_comment_convention.go
new file mode 100644
index 0000000000..83714f8fab
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_comment_convention.go
@@ -0,0 +1,127 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnCommentConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_COMMENT, &ColumnCommentConventionAdvisor{})
+}
+
+// ColumnCommentConventionAdvisor is the advisor checking for column comment convention.
+type ColumnCommentConventionAdvisor struct {
+}
+
+// Check checks for column comment convention.
+func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
+
+ rule := &columnCommentConventionOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ payload: commentPayload,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnCommentConventionOmniRule struct {
+ OmniBaseRule
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
+}
+
+func (*columnCommentConventionOmniRule) Name() string {
+ return "ColumnCommentConventionRule"
+}
+
+func (r *columnCommentConventionOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnCommentConventionOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ for _, col := range n.Columns {
+ r.checkColumn(tableName, col)
+ }
+}
+
+func (r *columnCommentConventionOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ for _, col := range cmd.Columns {
+ r.checkColumn(tableName, col)
+ }
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ default:
+ }
+ }
+}
+
+func (r *columnCommentConventionOmniRule) checkColumn(tableName string, col *ast.ColumnDef) {
+ comment := omniColumnComment(col)
+
+ if comment != "" && r.payload.MaxLength >= 0 && int32(len(comment)) > r.payload.MaxLength {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CommentTooLong.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of column `%s`.`%s` comment should be within %d characters", tableName, col.Name, r.payload.MaxLength),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ Column: 0,
+ },
+ })
+ }
+
+ if comment == "" && r.payload.Required {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CommentEmpty.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Column `%s`.`%s` requires comments", tableName, col.Name),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ Column: 0,
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_current_time_count_limit.go b/backend/plugin/advisor/oceanbase/rule_column_current_time_count_limit.go
new file mode 100644
index 0000000000..5231394508
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_current_time_count_limit.go
@@ -0,0 +1,178 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+const (
+ maxDefaultCurrentTimeColumCount = 2
+ maxOnUpdateCurrentTimeColumnCount = 1
+)
+
+var (
+ _ advisor.Advisor = (*ColumnCurrentTimeCountLimitAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_CURRENT_TIME_COUNT_LIMIT, &ColumnCurrentTimeCountLimitAdvisor{})
+}
+
+// ColumnCurrentTimeCountLimitAdvisor is the advisor checking for current time column count limit.
+type ColumnCurrentTimeCountLimitAdvisor struct {
+}
+
+// Check checks for current time column count limit.
+func (*ColumnCurrentTimeCountLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnCurrentTimeCountLimitOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ tableSet: make(map[string]currentTimeTableData),
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ rule.generateAdvice()
+
+ return rule.GetAdviceList(), nil
+}
+
+type currentTimeTableData struct {
+ tableName string
+ defaultCurrentTimeCount int
+ onUpdateCurrentTimeCount int
+ line int
+}
+
+type columnCurrentTimeCountLimitOmniRule struct {
+ OmniBaseRule
+ tableSet map[string]currentTimeTableData
+}
+
+func (*columnCurrentTimeCountLimitOmniRule) Name() string {
+ return "ColumnCurrentTimeCountLimitRule"
+}
+
+func (r *columnCurrentTimeCountLimitOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnCurrentTimeCountLimitOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ if col.TypeName == nil || !omniIsTimeType(col.TypeName) {
+ continue
+ }
+ r.checkTimeColumn(tableName, col)
+ }
+}
+
+func (r *columnCurrentTimeCountLimitOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col.TypeName == nil || !omniIsTimeType(col.TypeName) {
+ continue
+ }
+ r.checkTimeColumn(tableName, col)
+ }
+ }
+}
+
+func (r *columnCurrentTimeCountLimitOmniRule) checkTimeColumn(tableName string, col *ast.ColumnDef) {
+ if omniIsDefaultCurrentTime(col) {
+ table, exists := r.tableSet[tableName]
+ if !exists {
+ table = currentTimeTableData{tableName: tableName}
+ }
+ table.defaultCurrentTimeCount++
+ table.line = r.BaseLine + int(r.LocToLine(col.Loc))
+ r.tableSet[tableName] = table
+ }
+ if omniIsOnUpdateCurrentTime(col) {
+ table, exists := r.tableSet[tableName]
+ if !exists {
+ table = currentTimeTableData{tableName: tableName}
+ }
+ table.onUpdateCurrentTimeCount++
+ table.line = r.BaseLine + int(r.LocToLine(col.Loc))
+ r.tableSet[tableName] = table
+ }
+}
+
+func (r *columnCurrentTimeCountLimitOmniRule) generateAdvice() {
+ var tableList []currentTimeTableData
+ for _, table := range r.tableSet {
+ tableList = append(tableList, table)
+ }
+ slices.SortFunc(tableList, func(a, b currentTimeTableData) int {
+ if a.line < b.line {
+ return -1
+ }
+ if a.line > b.line {
+ return 1
+ }
+ return 0
+ })
+ for _, table := range tableList {
+ if table.defaultCurrentTimeCount > maxDefaultCurrentTimeColumCount {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DefaultCurrentTimeColumnCountExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table `%s` has %d DEFAULT CURRENT_TIMESTAMP() columns. The count greater than %d.", table.tableName, table.defaultCurrentTimeCount, maxDefaultCurrentTimeColumCount),
+ StartPosition: &storepb.Position{
+ Line: int32(table.line),
+ },
+ })
+ }
+ if table.onUpdateCurrentTimeCount > maxOnUpdateCurrentTimeColumnCount {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.OnUpdateCurrentTimeColumnCountExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table `%s` has %d ON UPDATE CURRENT_TIMESTAMP() columns. The count greater than %d.", table.tableName, table.onUpdateCurrentTimeCount, maxOnUpdateCurrentTimeColumnCount),
+ StartPosition: &storepb.Position{
+ Line: int32(table.line),
+ },
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_disallow_changing.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing.go
new file mode 100644
index 0000000000..1b95b18381
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing.go
@@ -0,0 +1,72 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnDisallowChangingAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE, &ColumnDisallowChangingAdvisor{})
+}
+
+// ColumnDisallowChangingAdvisor is the advisor checking for disallow CHANGE COLUMN statement.
+type ColumnDisallowChangingAdvisor struct {
+}
+
+// Check checks for disallow CHANGE COLUMN statement.
+func (*ColumnDisallowChangingAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnDisallowChangingOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnDisallowChangingOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnDisallowChangingOmniRule) Name() string {
+ return "ColumnDisallowChangingRule"
+}
+
+func (r *columnDisallowChangingOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.AlterTableStmt)
+ if !ok {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ if cmd.Type == ast.ATChangeColumn {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.UseChangeColumnStatement.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" contains CHANGE COLUMN statement", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_order.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_order.go
new file mode 100644
index 0000000000..2e509360a1
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_order.go
@@ -0,0 +1,77 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnDisallowChangingOrderAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGING_ORDER, &ColumnDisallowChangingOrderAdvisor{})
+}
+
+// ColumnDisallowChangingOrderAdvisor is the advisor checking for disallow changing column order.
+type ColumnDisallowChangingOrderAdvisor struct {
+}
+
+// Check checks for disallow changing column order.
+func (*ColumnDisallowChangingOrderAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnDisallowChangingOrderOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnDisallowChangingOrderOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnDisallowChangingOrderOmniRule) Name() string {
+ return "ColumnDisallowChangingOrderRule"
+}
+
+func (r *columnDisallowChangingOrderOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.AlterTableStmt)
+ if !ok {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ // Check if FIRST or AFTER is specified (column reordering).
+ if cmd.First || cmd.After != "" {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.ChangeColumnOrder.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" changes column order", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+ default:
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_type.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_type.go
new file mode 100644
index 0000000000..7d02704f65
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_changing_type.go
@@ -0,0 +1,144 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnDisallowChangingTypeAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_CHANGE_TYPE, &ColumnDisallowChangingTypeAdvisor{})
+}
+
+// ColumnDisallowChangingTypeAdvisor is the advisor checking for disallow changing column type.
+type ColumnDisallowChangingTypeAdvisor struct {
+}
+
+// Check checks for disallow changing column type.
+func (*ColumnDisallowChangingTypeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnDisallowChangingTypeOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ originalMetadata: checkCtx.OriginalMetadata,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnDisallowChangingTypeOmniRule struct {
+ OmniBaseRule
+ originalMetadata *model.DatabaseMetadata
+}
+
+func (*columnDisallowChangingTypeOmniRule) Name() string {
+ return "ColumnDisallowChangingTypeRule"
+}
+
+func (r *columnDisallowChangingTypeOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.AlterTableStmt)
+ if !ok || n.Table == nil {
+ return
+ }
+
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+
+ var columnName string
+ switch cmd.Type {
+ case ast.ATChangeColumn:
+ // For CHANGE, Name is the old column name.
+ columnName = cmd.Name
+ case ast.ATModifyColumn:
+ // For MODIFY, the column name comes from the column def or Name.
+ if cmd.Column != nil {
+ columnName = cmd.Column.Name
+ } else {
+ columnName = cmd.Name
+ }
+ default:
+ continue
+ }
+
+ if cmd.Column == nil || cmd.Column.TypeName == nil {
+ continue
+ }
+ r.checkColumnType(tableName, columnName, cmd.Column.TypeName, cmd.Loc)
+ }
+}
+
+func normalizeColumnType(tp string) string {
+ switch strings.ToLower(tp) {
+ case "tinyint":
+ return "tinyint(4)"
+ case "tinyint unsigned":
+ return "tinyint(4) unsigned"
+ case "smallint":
+ return "smallint(6)"
+ case "smallint unsigned":
+ return "smallint(6) unsigned"
+ case "mediumint":
+ return "mediumint(9)"
+ case "mediumint unsigned":
+ return "mediumint(9) unsigned"
+ case "int":
+ return "int(11)"
+ case "int unsigned":
+ return "int(11) unsigned"
+ case "bigint":
+ return "bigint(20)"
+ case "bigint unsigned":
+ return "bigint(20) unsigned"
+ default:
+ return strings.ToLower(tp)
+ }
+}
+
+func (r *columnDisallowChangingTypeOmniRule) checkColumnType(tableName, columnName string, dt *ast.DataType, loc ast.Loc) {
+ column := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetColumn(columnName)
+ if column == nil {
+ return
+ }
+
+ // Build the type string from the omni DataType.
+ tp := strings.ToLower(dt.Name)
+ if dt.Length > 0 && dt.Scale > 0 {
+ tp = fmt.Sprintf("%s(%d,%d)", tp, dt.Length, dt.Scale)
+ } else if dt.Length > 0 {
+ tp = fmt.Sprintf("%s(%d)", tp, dt.Length)
+ }
+ if dt.Unsigned {
+ tp += " unsigned"
+ }
+
+ if normalizeColumnType(column.GetProto().Type) != normalizeColumnType(tp) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.ChangeColumnType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" changes column type", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.LocToLine(loc))),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/mysql/rule_column_disallow_drop.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_drop.go
similarity index 96%
rename from backend/plugin/advisor/mysql/rule_column_disallow_drop.go
rename to backend/plugin/advisor/oceanbase/rule_column_disallow_drop.go
index 23e29e3b86..b7aeb9dc00 100644
--- a/backend/plugin/advisor/mysql/rule_column_disallow_drop.go
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_drop.go
@@ -1,10 +1,10 @@
-package mysql
+package oceanbase
import (
"context"
"fmt"
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
diff --git a/backend/plugin/advisor/oceanbase/rule_column_disallow_drop_in_index.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_drop_in_index.go
new file mode 100644
index 0000000000..68342fcaa1
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_drop_in_index.go
@@ -0,0 +1,124 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnDisallowDropInIndexAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_DROP_IN_INDEX, &ColumnDisallowDropInIndexAdvisor{})
+}
+
+// ColumnDisallowDropInIndexAdvisor is the advisor checking for disallow DROP COLUMN in index.
+type ColumnDisallowDropInIndexAdvisor struct {
+}
+
+// Check checks for disallow Drop COLUMN in index statement.
+func (*ColumnDisallowDropInIndexAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnDisallowDropInIndexOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ tables: make(tableState),
+ originalMetadata: checkCtx.OriginalMetadata,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnDisallowDropInIndexOmniRule struct {
+ OmniBaseRule
+ tables tableState
+ originalMetadata *model.DatabaseMetadata
+}
+
+func (*columnDisallowDropInIndexOmniRule) Name() string {
+ return "ColumnDisallowDropInIndexRule"
+}
+
+func (r *columnDisallowDropInIndexOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnDisallowDropInIndexOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ if constraint.Type != ast.ConstrIndex {
+ continue
+ }
+ for _, col := range constraint.Columns {
+ if r.tables[tableName] == nil {
+ r.tables[tableName] = make(columnSet)
+ }
+ r.tables[tableName][col] = true
+ }
+ }
+}
+
+func (r *columnDisallowDropInIndexOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+
+ for _, cmd := range n.Commands {
+ if cmd == nil || cmd.Type != ast.ATDropColumn {
+ continue
+ }
+
+ // Load index columns from metadata.
+ table := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName)
+ if table != nil {
+ if r.tables[tableName] == nil {
+ r.tables[tableName] = make(columnSet)
+ }
+ for _, indexColumn := range table.ListIndexes() {
+ for _, column := range indexColumn.GetProto().GetExpressions() {
+ r.tables[tableName][column] = true
+ }
+ }
+ }
+
+ columnName := cmd.Name
+ if _, exists := r.tables[tableName][columnName]; exists {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DropIndexColumn.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` cannot drop index column", tableName, columnName),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.LocToLine(cmd.Loc))),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_disallow_set_charset.go b/backend/plugin/advisor/oceanbase/rule_column_disallow_set_charset.go
new file mode 100644
index 0000000000..259f7f2e2d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_disallow_set_charset.go
@@ -0,0 +1,136 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnDisallowSetCharsetAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_DISALLOW_SET_CHARSET, &ColumnDisallowSetCharsetAdvisor{})
+}
+
+// ColumnDisallowSetCharsetAdvisor is the advisor checking for disallow set column charset.
+type ColumnDisallowSetCharsetAdvisor struct {
+}
+
+// Check checks for disallow set column charset.
+func (*ColumnDisallowSetCharsetAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnDisallowSetCharsetOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnDisallowSetCharsetOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnDisallowSetCharsetOmniRule) Name() string {
+ return "ColumnDisallowSetCharsetRule"
+}
+
+func (r *columnDisallowSetCharsetOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnDisallowSetCharsetOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ if !checkCharsetAllowed(col.TypeName.Charset) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.SetColumnCharset.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Disallow set column charset but \"%s\" does", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+ }
+}
+
+func (r *columnDisallowSetCharsetOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+
+ var charsetList []string
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ charsetList = append(charsetList, cmd.Column.TypeName.Charset)
+ }
+ for _, col := range cmd.Columns {
+ if col != nil && col.TypeName != nil {
+ charsetList = append(charsetList, col.TypeName.Charset)
+ }
+ }
+ case ast.ATChangeColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ charsetList = append(charsetList, cmd.Column.TypeName.Charset)
+ }
+ case ast.ATModifyColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ charsetList = append(charsetList, cmd.Column.TypeName.Charset)
+ }
+ default:
+ continue
+ }
+
+ for _, charset := range charsetList {
+ if !checkCharsetAllowed(charset) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.SetColumnCharset.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Disallow set column charset but \"%s\" does", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+ }
+ }
+}
+
+func checkCharsetAllowed(charset string) bool {
+ switch charset {
+ case "", "binary":
+ return true
+ default:
+ return false
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_maximum_character_length.go b/backend/plugin/advisor/oceanbase/rule_column_maximum_character_length.go
new file mode 100644
index 0000000000..1a55544453
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_maximum_character_length.go
@@ -0,0 +1,139 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnMaximumCharacterLengthAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_MAXIMUM_CHARACTER_LENGTH, &ColumnMaximumCharacterLengthAdvisor{})
+}
+
+// ColumnMaximumCharacterLengthAdvisor is the advisor checking for max character length.
+type ColumnMaximumCharacterLengthAdvisor struct {
+}
+
+// Check checks for maximum character length.
+func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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")
+ }
+
+ rule := &columnMaximumCharacterLengthOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ maximum: int(numberPayload.Number),
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnMaximumCharacterLengthOmniRule struct {
+ OmniBaseRule
+ maximum int
+}
+
+func (*columnMaximumCharacterLengthOmniRule) Name() string {
+ return "ColumnMaximumCharacterLengthRule"
+}
+
+func (r *columnMaximumCharacterLengthOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnMaximumCharacterLengthOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ charLength := getCharLengthFromOmni(col.TypeName)
+ if r.maximum > 0 && charLength > r.maximum {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CharLengthExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of the CHAR column `%s.%s` is bigger than %d, please use VARCHAR instead", tableName, col.Name, r.maximum),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+ }
+}
+
+func (r *columnMaximumCharacterLengthOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ cols := omniGetColumnsFromCmd(cmd)
+ for _, col := range cols {
+ charLength := getCharLengthFromOmni(col.TypeName)
+ if r.maximum > 0 && charLength > r.maximum {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CharLengthExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of the CHAR column `%s.%s` is bigger than %d, please use VARCHAR instead", tableName, col.Name, r.maximum),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+ }
+ }
+}
+
+func getCharLengthFromOmni(dt *ast.DataType) int {
+ if dt == nil {
+ return 0
+ }
+ if !strings.EqualFold(dt.Name, "CHAR") {
+ return 0
+ }
+ // MySQL default: CHAR without length = CHAR(1)
+ if dt.Length == 0 {
+ return 1
+ }
+ return dt.Length
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_maximum_varchar_length.go b/backend/plugin/advisor/oceanbase/rule_column_maximum_varchar_length.go
new file mode 100644
index 0000000000..1eeb26ca65
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_maximum_varchar_length.go
@@ -0,0 +1,139 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnMaximumVarcharLengthAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_MAXIMUM_VARCHAR_LENGTH, &ColumnMaximumVarcharLengthAdvisor{})
+}
+
+// ColumnMaximumVarcharLengthAdvisor is the advisor checking for max varchar length.
+type ColumnMaximumVarcharLengthAdvisor struct {
+}
+
+// Check checks for maximum varchar length.
+func (*ColumnMaximumVarcharLengthAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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")
+ }
+
+ rule := &columnMaximumVarcharLengthOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ maximum: int(numberPayload.Number),
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnMaximumVarcharLengthOmniRule struct {
+ OmniBaseRule
+ maximum int
+}
+
+func (*columnMaximumVarcharLengthOmniRule) Name() string {
+ return "VarcharLengthRule"
+}
+
+func (r *columnMaximumVarcharLengthOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnMaximumVarcharLengthOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ length := getVarcharLengthFromOmni(col.TypeName)
+ if r.maximum > 0 && length > r.maximum {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.VarcharLengthExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of the VARCHAR column `%s.%s` is bigger than %d", tableName, col.Name, r.maximum),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+ }
+}
+
+func (r *columnMaximumVarcharLengthOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ cols := omniGetColumnsFromCmd(cmd)
+ for _, col := range cols {
+ length := getVarcharLengthFromOmni(col.TypeName)
+ if r.maximum > 0 && length > r.maximum {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.VarcharLengthExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of the VARCHAR column `%s.%s` is bigger than %d", tableName, col.Name, r.maximum),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ },
+ })
+ }
+ }
+ }
+}
+
+func getVarcharLengthFromOmni(dt *ast.DataType) int {
+ if dt == nil {
+ return 0
+ }
+ if !strings.EqualFold(dt.Name, "VARCHAR") {
+ return 0
+ }
+ // MySQL default: VARCHAR without length = VARCHAR(1)
+ if dt.Length == 0 {
+ return 1
+ }
+ return dt.Length
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_no_null.go b/backend/plugin/advisor/oceanbase/rule_column_no_null.go
new file mode 100644
index 0000000000..ba56fb7f25
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_no_null.go
@@ -0,0 +1,183 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnNoNullAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_NO_NULL, &ColumnNoNullAdvisor{})
+}
+
+// ColumnNoNullAdvisor is the advisor checking for column no NULL value.
+type ColumnNoNullAdvisor struct {
+}
+
+// Check checks for column no NULL value.
+func (*ColumnNoNullAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnNoNullOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ columnSet: make(map[string]columnName),
+ finalMetadata: checkCtx.FinalMetadata,
+ }
+
+ // Walk all statements to collect columns.
+ RunRules(checkCtx.ParsedStatements, []OmniRule{rule})
+
+ // Generate advice after walking all statements.
+ rule.generateAdvice()
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnName struct {
+ tableName string
+ columnName string
+ line int
+}
+
+func (c columnName) name() string {
+ return fmt.Sprintf("%s.%s", c.tableName, c.columnName)
+}
+
+type columnNoNullOmniRule struct {
+ OmniBaseRule
+ columnSet map[string]columnName
+ finalMetadata *model.DatabaseMetadata
+}
+
+func (*columnNoNullOmniRule) Name() string {
+ return "ColumnNoNullRule"
+}
+
+func (r *columnNoNullOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnNoNullOmniRule) generateAdvice() {
+ var columnList []columnName
+ for _, column := range r.columnSet {
+ columnList = append(columnList, column)
+ }
+ slices.SortFunc(columnList, func(a, b columnName) int {
+ if a.line != b.line {
+ if a.line < b.line {
+ return -1
+ }
+ return 1
+ }
+ if a.columnName < b.columnName {
+ return -1
+ }
+ if a.columnName > b.columnName {
+ return 1
+ }
+ return 0
+ })
+
+ for _, column := range columnList {
+ schema := r.finalMetadata.GetSchemaMetadata("")
+ if schema == nil {
+ continue
+ }
+ table := schema.GetTable(column.tableName)
+ if table == nil {
+ continue
+ }
+ col := table.GetColumn(column.columnName)
+ if col != nil && col.GetProto().Nullable {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.ColumnCannotNull.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` cannot have NULL value", column.tableName, column.columnName),
+ StartPosition: base.ConvertANTLRLineToPosition(column.line),
+ })
+ }
+ }
+}
+
+func (r *columnNoNullOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil {
+ continue
+ }
+ c := columnName{
+ tableName: tableName,
+ columnName: col.Name,
+ line: r.BaseLine + int(r.LocToLine(col.Loc)),
+ }
+ if _, exists := r.columnSet[c.name()]; !exists {
+ r.columnSet[c.name()] = c
+ }
+ }
+}
+
+func (r *columnNoNullOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ var columns []string
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ columns = append(columns, cmd.Column.Name)
+ }
+ for _, col := range cmd.Columns {
+ columns = append(columns, col.Name)
+ }
+ case ast.ATChangeColumn:
+ // Only care about the new column name.
+ if cmd.Column != nil {
+ columns = append(columns, cmd.Column.Name)
+ }
+ default:
+ }
+ for _, column := range columns {
+ c := columnName{
+ tableName: tableName,
+ columnName: column,
+ line: r.BaseLine + int(r.LocToLine(cmd.Loc)),
+ }
+ if _, exists := r.columnSet[c.name()]; !exists {
+ r.columnSet[c.name()] = c
+ }
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_require_default.go b/backend/plugin/advisor/oceanbase/rule_column_require_default.go
new file mode 100644
index 0000000000..a9be0fc38a
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_require_default.go
@@ -0,0 +1,114 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnRequireDefaultAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_REQUIRE_DEFAULT, &ColumnRequireDefaultAdvisor{})
+}
+
+// ColumnRequireDefaultAdvisor is the advisor checking for column default requirement.
+type ColumnRequireDefaultAdvisor struct {
+}
+
+// Check checks for column default requirement.
+func (*ColumnRequireDefaultAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnRequireDefaultOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnRequireDefaultOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnRequireDefaultOmniRule) Name() string {
+ return "ColumnRequireDefaultRule"
+}
+
+func (r *columnRequireDefaultOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnRequireDefaultOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ pkCols := omniPKColumnNames(n.Columns, n.Constraints)
+
+ for _, col := range n.Columns {
+ if pkCols[col.Name] {
+ continue
+ }
+ r.checkColumn(tableName, col)
+ }
+}
+
+func (r *columnRequireDefaultOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ for _, col := range cmd.Columns {
+ r.checkColumn(tableName, col)
+ }
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ default:
+ }
+ }
+}
+
+func (r *columnRequireDefaultOmniRule) checkColumn(tableName string, col *ast.ColumnDef) {
+ if !omniHasDefault(col) && !omniIsDefaultExemptType(col) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NoDefault.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Column `%s`.`%s` doesn't have DEFAULT.", tableName, col.Name),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ Column: 0,
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_required.go b/backend/plugin/advisor/oceanbase/rule_column_required.go
new file mode 100644
index 0000000000..1e240fd89b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_required.go
@@ -0,0 +1,219 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnRequirementAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_REQUIRED, &ColumnRequirementAdvisor{})
+}
+
+// ColumnRequirementAdvisor is the advisor checking for column requirement.
+type ColumnRequirementAdvisor struct {
+}
+
+// Check checks for the column requirement.
+func (*ColumnRequirementAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 stringArrayPayload.List {
+ requiredColumns[column] = true
+ }
+
+ rule := &columnRequiredOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ requiredColumns: requiredColumns,
+ tables: make(tableState),
+ line: make(map[string]int),
+ }
+
+ adviceList := RunRules(checkCtx.ParsedStatements, []OmniRule{rule})
+ adviceList = append(adviceList, rule.generateAdviceList()...)
+ return adviceList, nil
+}
+
+type columnRequiredOmniRule struct {
+ OmniBaseRule
+ requiredColumns columnSet
+ tables tableState
+ line map[string]int
+}
+
+func (*columnRequiredOmniRule) Name() string {
+ return "ColumnRequiredRule"
+}
+
+func (r *columnRequiredOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.DropTableStmt:
+ r.checkDropTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnRequiredOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ r.line[tableName] = int(r.LocToLine(n.Loc)) + r.BaseLine
+ r.initEmptyTable(tableName)
+
+ for _, col := range n.Columns {
+ r.addColumn(tableName, col.Name)
+ }
+}
+
+func (r *columnRequiredOmniRule) checkDropTable(n *ast.DropTableStmt) {
+ for _, ref := range n.Tables {
+ tableName := omniTableName(ref)
+ delete(r.tables, tableName)
+ }
+}
+
+func (r *columnRequiredOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ lineNumber := int(r.LocToLine(cmd.Loc)) + r.BaseLine
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ r.addColumn(tableName, cmd.Column.Name)
+ }
+ for _, col := range cmd.Columns {
+ r.addColumn(tableName, col.Name)
+ }
+ case ast.ATDropColumn:
+ if r.dropColumn(tableName, cmd.Name) {
+ r.line[tableName] = lineNumber
+ }
+ case ast.ATRenameColumn:
+ if r.renameColumn(tableName, cmd.Name, cmd.NewName) {
+ r.line[tableName] = lineNumber
+ }
+ case ast.ATChangeColumn:
+ if r.renameColumn(tableName, cmd.Name, cmd.NewName) {
+ r.line[tableName] = lineNumber
+ }
+ default:
+ }
+ }
+}
+
+func (r *columnRequiredOmniRule) generateAdviceList() []*storepb.Advice {
+ var adviceList []*storepb.Advice
+ tableList := r.tables.tableList()
+ for _, tableName := range tableList {
+ table := r.tables[tableName]
+ var missingColumns []string
+ for columnName := range r.requiredColumns {
+ if exists, ok := table[columnName]; !ok || !exists {
+ missingColumns = append(missingColumns, columnName)
+ }
+ }
+
+ if len(missingColumns) > 0 {
+ slices.Sort(missingColumns)
+ adviceList = append(adviceList, &storepb.Advice{
+ Status: r.Level,
+ Code: code.NoRequiredColumn.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table `%s` requires columns: %s", tableName, strings.Join(missingColumns, ", ")),
+ StartPosition: &storepb.Position{
+ Line: int32(r.line[tableName]),
+ Column: 0,
+ },
+ })
+ }
+ }
+ return adviceList
+}
+
+func (r *columnRequiredOmniRule) initEmptyTable(tableName string) columnSet {
+ r.tables[tableName] = make(columnSet)
+ return r.tables[tableName]
+}
+
+func (r *columnRequiredOmniRule) addColumn(tableName string, columnName string) {
+ if _, ok := r.requiredColumns[columnName]; !ok {
+ return
+ }
+
+ if table, ok := r.tables[tableName]; !ok {
+ r.initFullTable(tableName)
+ } else {
+ table[columnName] = true
+ }
+}
+
+func (r *columnRequiredOmniRule) dropColumn(tableName string, columnName string) bool {
+ if _, ok := r.requiredColumns[columnName]; !ok {
+ return false
+ }
+ table, ok := r.tables[tableName]
+ if !ok {
+ table = r.initFullTable(tableName)
+ }
+ table[columnName] = false
+ return true
+}
+
+func (r *columnRequiredOmniRule) renameColumn(tableName string, oldColumn string, newColumn string) bool {
+ _, oldNeed := r.requiredColumns[oldColumn]
+ _, newNeed := r.requiredColumns[newColumn]
+ if !oldNeed && !newNeed {
+ return false
+ }
+ table, ok := r.tables[tableName]
+ if !ok {
+ table = r.initFullTable(tableName)
+ }
+ if oldNeed {
+ table[oldColumn] = false
+ }
+ if newNeed {
+ table[newColumn] = true
+ }
+ return oldNeed
+}
+
+func (r *columnRequiredOmniRule) initFullTable(tableName string) columnSet {
+ table := r.initEmptyTable(tableName)
+ for column := range r.requiredColumns {
+ table[column] = true
+ }
+ return table
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_set_default_for_not_null.go b/backend/plugin/advisor/oceanbase/rule_column_set_default_for_not_null.go
new file mode 100644
index 0000000000..bee29a6263
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_set_default_for_not_null.go
@@ -0,0 +1,114 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnSetDefaultForNotNullAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_SET_DEFAULT_FOR_NOT_NULL, &ColumnSetDefaultForNotNullAdvisor{})
+}
+
+// ColumnSetDefaultForNotNullAdvisor is the advisor checking for set default value for not null column.
+type ColumnSetDefaultForNotNullAdvisor struct {
+}
+
+// Check checks for set default value for not null column.
+func (*ColumnSetDefaultForNotNullAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &columnSetDefaultForNotNullOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type columnSetDefaultForNotNullOmniRule struct {
+ OmniBaseRule
+}
+
+func (*columnSetDefaultForNotNullOmniRule) Name() string {
+ return "ColumnSetDefaultForNotNullRule"
+}
+
+func (r *columnSetDefaultForNotNullOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnSetDefaultForNotNullOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ pkCols := omniPKColumnNames(n.Columns, n.Constraints)
+
+ for _, col := range n.Columns {
+ if pkCols[col.Name] {
+ continue
+ }
+ r.checkColumn(tableName, col)
+ }
+}
+
+func (r *columnSetDefaultForNotNullOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ for _, col := range cmd.Columns {
+ r.checkColumn(tableName, col)
+ }
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ if cmd.Column != nil {
+ r.checkColumn(tableName, cmd.Column)
+ }
+ default:
+ }
+ }
+}
+
+func (r *columnSetDefaultForNotNullOmniRule) checkColumn(tableName string, col *ast.ColumnDef) {
+ if !omniIsNullable(col) && !omniHasDefault(col) && omniColumnNeedDefaultNotNull(col) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NotNullColumnWithNoDefault.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Column `%s`.`%s` is NOT NULL but doesn't have DEFAULT", tableName, col.Name),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(col.Loc),
+ Column: 0,
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_column_type_disallow_list.go b/backend/plugin/advisor/oceanbase/rule_column_type_disallow_list.go
new file mode 100644
index 0000000000..e3bd1544b6
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_column_type_disallow_list.go
@@ -0,0 +1,121 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*ColumnTypeDisallowListAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_COLUMN_TYPE_DISALLOW_LIST, &ColumnTypeDisallowListAdvisor{})
+}
+
+// ColumnTypeDisallowListAdvisor is the advisor checking for column type restriction.
+type ColumnTypeDisallowListAdvisor struct {
+}
+
+// Check checks for column type restriction.
+func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+
+ typeRestriction := make(map[string]bool)
+ for _, tp := range stringArrayPayload.List {
+ typeRestriction[strings.ToUpper(tp)] = true
+ }
+
+ rule := &columnTypeDisallowListOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ typeRestriction: typeRestriction,
+ }
+
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+ rule.SetStatement(stmt.BaseLine(), stmt.Text)
+ rule.OnStatement(node)
+ }
+
+ return rule.GetAdviceList(), nil
+}
+
+type columnTypeDisallowListOmniRule struct {
+ OmniBaseRule
+ typeRestriction map[string]bool
+}
+
+func (*columnTypeDisallowListOmniRule) Name() string {
+ return "ColumnTypeDisallowListRule"
+}
+
+func (r *columnTypeDisallowListOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *columnTypeDisallowListOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, col := range n.Columns {
+ r.checkColumnType(tableName, col.Name, col.TypeName, col.Loc)
+ }
+}
+
+func (r *columnTypeDisallowListOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := omniTableName(n.Table)
+ if tableName == "" {
+ return
+ }
+ for _, cmd := range n.Commands {
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ r.checkColumnType(tableName, col.Name, col.TypeName, col.Loc)
+ }
+ }
+}
+
+func (r *columnTypeDisallowListOmniRule) checkColumnType(tableName, colName string, dt *ast.DataType, loc ast.Loc) {
+ if dt == nil {
+ return
+ }
+ columnType := strings.ToUpper(omniDataTypeNameCompact(dt))
+ if _, exists := r.typeRestriction[columnType]; exists {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DisabledColumnType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Disallow column type %s but column `%s`.`%s` is", columnType, tableName, colName),
+ StartPosition: &storepb.Position{
+ Line: r.LocToLine(loc),
+ },
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_database_drop_empty_db.go b/backend/plugin/advisor/oceanbase/rule_database_drop_empty_db.go
new file mode 100644
index 0000000000..10c67c73f0
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_database_drop_empty_db.go
@@ -0,0 +1,79 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*DatabaseAllowDropIfEmptyAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_DATABASE_DROP_EMPTY_DATABASE, &DatabaseAllowDropIfEmptyAdvisor{})
+}
+
+// DatabaseAllowDropIfEmptyAdvisor is the advisor checking the MySQLDatabaseAllowDropIfEmpty rule.
+type DatabaseAllowDropIfEmptyAdvisor struct {
+}
+
+// Check checks for drop table naming convention.
+func (*DatabaseAllowDropIfEmptyAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &databaseDropEmptyDBOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ originMetadata: checkCtx.OriginalMetadata,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type databaseDropEmptyDBOmniRule struct {
+ OmniBaseRule
+ originMetadata *model.DatabaseMetadata
+}
+
+func (*databaseDropEmptyDBOmniRule) Name() string {
+ return "DatabaseDropEmptyDBRule"
+}
+
+func (r *databaseDropEmptyDBOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.DropDatabaseStmt)
+ if !ok {
+ return
+ }
+ dbName := n.Name
+ line := r.BaseLine + int(r.LocToLine(n.Loc))
+ if r.originMetadata.DatabaseName() != dbName {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NotCurrentDatabase.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Database `%s` that is trying to be deleted is not the current database `%s`", dbName, r.originMetadata.DatabaseName()),
+ StartPosition: base.ConvertANTLRLineToPosition(line),
+ })
+ } else if !r.originMetadata.HasNoTable() {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DatabaseNotEmpty.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Database `%s` is not allowed to drop if not empty", dbName),
+ StartPosition: base.ConvertANTLRLineToPosition(line),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_key_number_limit.go b/backend/plugin/advisor/oceanbase/rule_index_key_number_limit.go
new file mode 100644
index 0000000000..962fe9c3b5
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_key_number_limit.go
@@ -0,0 +1,149 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*IndexKeyNumberLimitAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_KEY_NUMBER_LIMIT, &IndexKeyNumberLimitAdvisor{})
+}
+
+// IndexKeyNumberLimitAdvisor is the advisor checking for index key number limit.
+type IndexKeyNumberLimitAdvisor struct {
+}
+
+// Check checks for index key number limit.
+func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 := &indexKeyNumberLimitOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ max: int(numberPayload.Number),
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type indexKeyNumberLimitOmniRule struct {
+ OmniBaseRule
+ max int
+}
+
+func (*indexKeyNumberLimitOmniRule) Name() string {
+ return "IndexKeyNumberLimitRule"
+}
+
+func (r *indexKeyNumberLimitOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *indexKeyNumberLimitOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ r.handleConstraint(tableName, constraint, r.LocToLine(constraint.Loc))
+ }
+}
+
+func (r *indexKeyNumberLimitOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ r.handleConstraint(tableName, cmd.Constraint, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+}
+
+func (r *indexKeyNumberLimitOmniRule) handleConstraint(tableName string, constraint *ast.Constraint, line int32) {
+ var columnList []string
+ switch constraint.Type {
+ case ast.ConstrPrimaryKey, ast.ConstrUnique, ast.ConstrIndex:
+ columnList = constraint.Columns
+ case ast.ConstrForeignKey:
+ columnList = constraint.Columns
+ default:
+ return
+ }
+
+ indexName := omniConstraintName(constraint)
+ if indexName == "" && constraint.Type == ast.ConstrPrimaryKey {
+ indexName = extractPKNameFromText(r.StmtText)
+ }
+ if r.max > 0 && len(columnList) > r.max {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexKeyNumberExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The number of index `%s` in table `%s` should be not greater than %d", indexName, tableName, r.max),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(line)),
+ })
+ }
+}
+
+func (r *indexKeyNumberLimitOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ if n.Table == nil {
+ return
+ }
+ if n.Fulltext || n.Spatial {
+ return
+ }
+
+ tableName := n.Table.Name
+ indexName := n.IndexName
+ columnList := omniIndexColumns(n.Columns)
+ if r.max > 0 && len(columnList) > r.max {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexKeyNumberExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The number of index `%s` in table `%s` should be not greater than %d", indexName, tableName, r.max),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_no_duplicate_column.go b/backend/plugin/advisor/oceanbase/rule_index_no_duplicate_column.go
new file mode 100644
index 0000000000..e44e01018b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_no_duplicate_column.go
@@ -0,0 +1,187 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "regexp"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*IndexNoDuplicateColumnAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_NO_DUPLICATE_COLUMN, &IndexNoDuplicateColumnAdvisor{})
+}
+
+// IndexNoDuplicateColumnAdvisor is the advisor checking for no duplicate columns in index.
+type IndexNoDuplicateColumnAdvisor struct {
+}
+
+// Check checks for no duplicate columns in index.
+func (*IndexNoDuplicateColumnAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &indexNoDuplicateColumnOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type indexNoDuplicateColumnOmniRule struct {
+ OmniBaseRule
+}
+
+func (*indexNoDuplicateColumnOmniRule) Name() string {
+ return "IndexNoDuplicateColumnRule"
+}
+
+func (r *indexNoDuplicateColumnOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *indexNoDuplicateColumnOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ r.handleConstraint(tableName, constraint, r.LocToLine(constraint.Loc))
+ }
+}
+
+func (r *indexNoDuplicateColumnOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ r.handleConstraint(tableName, cmd.Constraint, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+}
+
+func (r *indexNoDuplicateColumnOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ if n.Table == nil {
+ return
+ }
+ if n.Fulltext || n.Spatial {
+ return
+ }
+
+ tableName := n.Table.Name
+ indexName := n.IndexName
+
+ indexType := "INDEX "
+ if n.Unique {
+ indexType = "UNIQUE INDEX "
+ }
+
+ columnList := omniIndexColumns(n.Columns)
+ if column, duplicate := hasDuplicateColumn(columnList); duplicate {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DuplicateColumnInIndex.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("%s`%s` has duplicate column `%s`.`%s`", indexType, indexName, tableName, column),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+ }
+}
+
+func (r *indexNoDuplicateColumnOmniRule) handleConstraint(tableName string, constraint *ast.Constraint, line int32) {
+ var columnList []string
+ indexType := ""
+ switch constraint.Type {
+ case ast.ConstrPrimaryKey:
+ columnList = constraint.Columns
+ indexType = "PRIMARY KEY "
+ case ast.ConstrUnique:
+ columnList = constraint.Columns
+ indexType = "UNIQUE KEY "
+ case ast.ConstrIndex:
+ columnList = constraint.Columns
+ indexType = "INDEX "
+ case ast.ConstrForeignKey:
+ columnList = constraint.Columns
+ indexType = "FOREIGN KEY "
+ case ast.ConstrFulltextIndex, ast.ConstrSpatialIndex:
+ return
+ default:
+ return
+ }
+
+ indexName := omniConstraintName(constraint)
+ // Workaround: omni parser doesn't capture PRIMARY KEY constraint names.
+ // Extract from statement text as a fallback.
+ if indexName == "" && constraint.Type == ast.ConstrPrimaryKey {
+ indexName = extractPKNameFromText(r.StmtText)
+ }
+ if column, duplicate := hasDuplicateColumn(columnList); duplicate {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.DuplicateColumnInIndex.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("%s`%s` has duplicate column `%s`.`%s`", indexType, indexName, tableName, column),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(line)),
+ })
+ }
+}
+
+// primaryKeyNameRe extracts the optional constraint name from a PRIMARY KEY clause.
+// Matches patterns like: PRIMARY KEY pk_a (...), PRIMARY KEY `pk_a` (...)
+var primaryKeyNameRe = regexp.MustCompile(`(?i)PRIMARY\s+KEY\s+` + "`?" + `(\w+)` + "`?" + `\s*\(`)
+
+// extractPKNameFromText extracts the PRIMARY KEY constraint name from the statement text.
+// Returns empty string if no name is found.
+func extractPKNameFromText(stmtText string) string {
+ m := primaryKeyNameRe.FindStringSubmatch(stmtText)
+ if len(m) >= 2 {
+ return m[1]
+ }
+ return ""
+}
+
+func hasDuplicateColumn(keyList []string) (string, bool) {
+ listMap := make(map[string]struct{})
+ for _, keyName := range keyList {
+ if _, exists := listMap[keyName]; exists {
+ return keyName, true
+ }
+ listMap[keyName] = struct{}{}
+ }
+ return "", false
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_pk_type.go b/backend/plugin/advisor/oceanbase/rule_index_pk_type.go
new file mode 100644
index 0000000000..3342715e41
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_pk_type.go
@@ -0,0 +1,204 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*IndexPkTypeAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_PK_TYPE_LIMIT, &IndexPkTypeAdvisor{})
+}
+
+// IndexPkTypeAdvisor is the advisor checking for correct type of PK.
+type IndexPkTypeAdvisor struct {
+}
+
+// Check checks for correct type of PK.
+func (*IndexPkTypeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &indexPkTypeOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ originalMetadata: checkCtx.OriginalMetadata,
+ tablesNewColumns: make(tableColumnTypes),
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type indexPkTypeOmniRule struct {
+ OmniBaseRule
+ originalMetadata *model.DatabaseMetadata
+ tablesNewColumns tableColumnTypes
+}
+
+func (*indexPkTypeOmniRule) Name() string {
+ return "IndexPkTypeRule"
+}
+
+func (r *indexPkTypeOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *indexPkTypeOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := r.getIntOrBigIntStr(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.addAdvice(tableName, col.Name, columnType, r.BaseLine+int(r.LocToLine(col.Loc)))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ r.checkConstraint(tableName, constraint, r.LocToLine(constraint.Loc))
+ }
+}
+
+func (r *indexPkTypeOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := r.getIntOrBigIntStr(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.addAdvice(tableName, col.Name, columnType, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATModifyColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := r.getIntOrBigIntStr(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.addAdvice(tableName, col.Name, columnType, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATChangeColumn:
+ r.tablesNewColumns.delete(tableName, cmd.Name)
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := r.getIntOrBigIntStr(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.addAdvice(tableName, col.Name, columnType, r.BaseLine+int(r.LocToLine(n.Loc)))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ r.checkConstraint(tableName, cmd.Constraint, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+}
+
+func (r *indexPkTypeOmniRule) checkConstraint(tableName string, constraint *ast.Constraint, line int32) {
+ if constraint.Type != ast.ConstrPrimaryKey {
+ return
+ }
+ for _, columnName := range constraint.Columns {
+ columnType, err := r.getPKColumnType(tableName, columnName)
+ if err != nil {
+ continue
+ }
+ r.addAdvice(tableName, columnName, columnType, r.BaseLine+int(line))
+ }
+}
+
+func (r *indexPkTypeOmniRule) addAdvice(tableName, columnName, columnType string, lineNumber int) {
+ if !strings.EqualFold(columnType, "INT") && !strings.EqualFold(columnType, "BIGINT") {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Columns in primary key must be INT/BIGINT but `%s`.`%s` is %s", tableName, columnName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(lineNumber),
+ })
+ }
+}
+
+func (r *indexPkTypeOmniRule) getPKColumnType(tableName string, columnName string) (string, error) {
+ if columnType, ok := r.tablesNewColumns.get(tableName, columnName); ok {
+ return columnType, nil
+ }
+ column := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetColumn(columnName)
+ if column != nil {
+ return column.GetProto().Type, nil
+ }
+ return "", errors.Errorf("cannot find the type of `%s`.`%s`", tableName, columnName)
+}
+
+func (*indexPkTypeOmniRule) getIntOrBigIntStr(dt *ast.DataType) string {
+ if dt == nil {
+ return ""
+ }
+ switch strings.ToUpper(dt.Name) {
+ case "INT", "INTEGER":
+ return "INT"
+ case "BIGINT":
+ return "BIGINT"
+ default:
+ name := strings.ToLower(dt.Name)
+ if dt.Length > 0 {
+ if dt.Scale > 0 {
+ return fmt.Sprintf("%s(%d,%d)", name, dt.Length, dt.Scale)
+ }
+ return fmt.Sprintf("%s(%d)", name, dt.Length)
+ }
+ return name
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_primary_key_type_allowlist.go b/backend/plugin/advisor/oceanbase/rule_index_primary_key_type_allowlist.go
new file mode 100644
index 0000000000..3fd644c716
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_primary_key_type_allowlist.go
@@ -0,0 +1,219 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*IndexPrimaryKeyTypeAllowlistAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_PRIMARY_KEY_TYPE_ALLOWLIST, &IndexPrimaryKeyTypeAllowlistAdvisor{})
+}
+
+// IndexPrimaryKeyTypeAllowlistAdvisor is the advisor checking for primary key type allowlist.
+type IndexPrimaryKeyTypeAllowlistAdvisor struct {
+}
+
+// Check checks for primary key type allowlist.
+func (*IndexPrimaryKeyTypeAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ stringArrayPayload := checkCtx.Rule.GetStringArrayPayload()
+ allowlist := make(map[string]bool)
+ for _, tp := range stringArrayPayload.List {
+ allowlist[strings.ToLower(tp)] = true
+ }
+
+ rule := &indexPrimaryKeyTypeAllowlistOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ allowlist: allowlist,
+ originalMetadata: checkCtx.OriginalMetadata,
+ tablesNewColumns: make(tableColumnTypes),
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type indexPrimaryKeyTypeAllowlistOmniRule struct {
+ OmniBaseRule
+ allowlist map[string]bool
+ originalMetadata *model.DatabaseMetadata
+ tablesNewColumns tableColumnTypes
+}
+
+func (*indexPrimaryKeyTypeAllowlistOmniRule) Name() string {
+ return "IndexPrimaryKeyTypeAllowlistRule"
+}
+
+func (r *indexPrimaryKeyTypeAllowlistOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *indexPrimaryKeyTypeAllowlistOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ if _, exists := r.allowlist[columnType]; !exists {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The column `%s` in table `%s` is one of the primary key, but its type \"%s\" is not in allowlist", col.Name, tableName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(col.Loc))),
+ })
+ }
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ r.checkConstraint(tableName, constraint, r.LocToLine(constraint.Loc))
+ }
+}
+
+func (r *indexPrimaryKeyTypeAllowlistOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ if _, exists := r.allowlist[columnType]; !exists {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The column `%s` in table `%s` is one of the primary key, but its type \"%s\" is not in allowlist", col.Name, tableName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+ }
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATModifyColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ if _, exists := r.allowlist[columnType]; !exists {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The column `%s` in table `%s` is one of the primary key, but its type \"%s\" is not in allowlist", col.Name, tableName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+ }
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATChangeColumn:
+ r.tablesNewColumns.delete(tableName, cmd.Name)
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ if _, exists := r.allowlist[columnType]; !exists {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The column `%s` in table `%s` is one of the primary key, but its type \"%s\" is not in allowlist", col.Name, tableName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+ }
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ r.checkConstraint(tableName, cmd.Constraint, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+}
+
+func (r *indexPrimaryKeyTypeAllowlistOmniRule) checkConstraint(tableName string, constraint *ast.Constraint, line int32) {
+ if constraint.Type != ast.ConstrPrimaryKey {
+ return
+ }
+ for _, columnName := range constraint.Columns {
+ columnType, err := r.getPKColumnType(tableName, columnName)
+ if err != nil {
+ continue
+ }
+ columnType = strings.ToLower(columnType)
+ if _, exists := r.allowlist[columnType]; !exists {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexPKType.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The column `%s` in table `%s` is one of the primary key, but its type \"%s\" is not in allowlist", columnName, tableName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(line)),
+ })
+ }
+ }
+}
+
+func (r *indexPrimaryKeyTypeAllowlistOmniRule) getPKColumnType(tableName string, columnName string) (string, error) {
+ if columnType, ok := r.tablesNewColumns.get(tableName, columnName); ok {
+ return columnType, nil
+ }
+ column := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetColumn(columnName)
+ if column != nil {
+ return column.GetProto().Type, nil
+ }
+ return "", errors.Errorf("cannot find the type of `%s`.`%s`", tableName, columnName)
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_total_number_limit.go b/backend/plugin/advisor/oceanbase/rule_index_total_number_limit.go
new file mode 100644
index 0000000000..c9da5a3716
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_total_number_limit.go
@@ -0,0 +1,177 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*IndexTotalNumberLimitAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_TOTAL_NUMBER_LIMIT, &IndexTotalNumberLimitAdvisor{})
+}
+
+// IndexTotalNumberLimitAdvisor is the advisor checking for index total number limit.
+type IndexTotalNumberLimitAdvisor struct {
+}
+
+// Check checks for index total number limit.
+func (*IndexTotalNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 := &indexTotalNumberLimitOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ max: int(numberPayload.Number),
+ lineForTable: make(map[string]int),
+ finalMetadata: checkCtx.FinalMetadata,
+ }
+
+ RunRules(checkCtx.ParsedStatements, []OmniRule{rule})
+ return rule.generateAdvice(), nil
+}
+
+type indexTotalNumberLimitOmniRule struct {
+ OmniBaseRule
+ max int
+ lineForTable map[string]int
+ finalMetadata *model.DatabaseMetadata
+}
+
+func (*indexTotalNumberLimitOmniRule) Name() string {
+ return "IndexTotalNumberLimitRule"
+}
+
+func (r *indexTotalNumberLimitOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *indexTotalNumberLimitOmniRule) generateAdvice() []*storepb.Advice {
+ type tableName struct {
+ name string
+ line int
+ }
+ var tableList []tableName
+
+ for k, v := range r.lineForTable {
+ tableList = append(tableList, tableName{
+ name: k,
+ line: v,
+ })
+ }
+ slices.SortFunc(tableList, func(i, j tableName) int {
+ if i.line < j.line {
+ return -1
+ }
+ if i.line > j.line {
+ return 1
+ }
+ return 0
+ })
+
+ for _, table := range tableList {
+ schema := r.finalMetadata.GetSchemaMetadata("")
+ if schema == nil {
+ continue
+ }
+ tableInfo := schema.GetTable(table.name)
+ if tableInfo != nil && len(tableInfo.GetProto().Indexes) > r.max {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexCountExceedsLimit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The count of index in table `%s` should be no more than %d, but found %d", table.name, r.max, len(tableInfo.GetProto().Indexes)),
+ StartPosition: base.ConvertANTLRLineToPosition(table.line),
+ })
+ }
+ }
+
+ return r.Advice
+}
+
+func (r *indexTotalNumberLimitOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ r.lineForTable[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+}
+
+func (r *indexTotalNumberLimitOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ r.lineForTable[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+}
+
+func (r *indexTotalNumberLimitOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil {
+ continue
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.lineForTable[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+ }
+ }
+ }
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ if cmd.Column != nil {
+ for _, c := range cmd.Column.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.lineForTable[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+ }
+ }
+ }
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ switch cmd.Constraint.Type {
+ case ast.ConstrPrimaryKey, ast.ConstrUnique, ast.ConstrIndex, ast.ConstrFulltextIndex:
+ r.lineForTable[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+ default:
+ }
+ }
+ default:
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_index_type_no_blob.go b/backend/plugin/advisor/oceanbase/rule_index_type_no_blob.go
new file mode 100644
index 0000000000..58aeef21bf
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_index_type_no_blob.go
@@ -0,0 +1,222 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*IndexTypeNoBlobAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_INDEX_TYPE_NO_BLOB, &IndexTypeNoBlobAdvisor{})
+}
+
+// IndexTypeNoBlobAdvisor is the advisor checking for index type no blob.
+type IndexTypeNoBlobAdvisor struct {
+}
+
+// Check checks for index type no blob.
+func (*IndexTypeNoBlobAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &indexTypeNoBlobOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ originalMetadata: checkCtx.OriginalMetadata,
+ tablesNewColumns: make(tableColumnTypes),
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type indexTypeNoBlobOmniRule struct {
+ OmniBaseRule
+ originalMetadata *model.DatabaseMetadata
+ tablesNewColumns tableColumnTypes
+}
+
+func (*indexTypeNoBlobOmniRule) Name() string {
+ return "IndexTypeNoBlobRule"
+}
+
+func (r *indexTypeNoBlobOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.addAdvice(tableName, col.Name, columnType, r.LocToLine(col.Loc))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ r.checkConstraint(tableName, constraint, r.LocToLine(constraint.Loc))
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col == nil || col.TypeName == nil {
+ continue
+ }
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.addAdvice(tableName, col.Name, columnType, r.LocToLine(n.Loc))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATModifyColumn:
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.addAdvice(tableName, col.Name, columnType, r.LocToLine(n.Loc))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATChangeColumn:
+ r.tablesNewColumns.delete(tableName, cmd.Name)
+ if cmd.Column != nil && cmd.Column.TypeName != nil {
+ col := cmd.Column
+ columnType := omniDataTypeNameCompact(col.TypeName)
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey || c.Type == ast.ColConstrUnique {
+ r.addAdvice(tableName, col.Name, columnType, r.LocToLine(n.Loc))
+ }
+ }
+ r.tablesNewColumns.set(tableName, col.Name, columnType)
+ }
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ r.checkConstraint(tableName, cmd.Constraint, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ if n.Table == nil {
+ return
+ }
+ if n.Fulltext || n.Spatial {
+ return
+ }
+
+ tableName := n.Table.Name
+ columnList := omniIndexColumns(n.Columns)
+ for _, columnName := range columnList {
+ columnType, err := r.getColumnType(tableName, columnName)
+ if err != nil {
+ continue
+ }
+ columnType = strings.ToLower(columnType)
+ r.addAdvice(tableName, columnName, columnType, r.LocToLine(n.Loc))
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) checkConstraint(tableName string, constraint *ast.Constraint, line int32) {
+ var columnList []string
+ switch constraint.Type {
+ case ast.ConstrPrimaryKey, ast.ConstrUnique, ast.ConstrIndex:
+ columnList = constraint.Columns
+ case ast.ConstrForeignKey:
+ columnList = constraint.Columns
+ default:
+ return
+ }
+
+ for _, columnName := range columnList {
+ columnType, err := r.getColumnType(tableName, columnName)
+ if err != nil {
+ continue
+ }
+ columnType = strings.ToLower(columnType)
+ r.addAdvice(tableName, columnName, columnType, line)
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) addAdvice(tableName, columnName, columnType string, line int32) {
+ if isBlob(columnType) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.IndexTypeNoBlob.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Columns in index must not be BLOB but `%s`.`%s` is %s", tableName, columnName, columnType),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(line)),
+ })
+ }
+}
+
+func isBlob(columnType string) bool {
+ switch strings.ToLower(columnType) {
+ case "blob", "tinyblob", "mediumblob", "longblob":
+ return true
+ default:
+ return false
+ }
+}
+
+func (r *indexTypeNoBlobOmniRule) getColumnType(tableName string, columnName string) (string, error) {
+ if columnType, ok := r.tablesNewColumns.get(tableName, columnName); ok {
+ return columnType, nil
+ }
+ column := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetColumn(columnName)
+ if column != nil {
+ return column.GetProto().Type, nil
+ }
+ return "", errors.Errorf("cannot find the type of `%s`.`%s`", tableName, columnName)
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_insert_disallow_order_by_rand.go b/backend/plugin/advisor/oceanbase/rule_insert_disallow_order_by_rand.go
new file mode 100644
index 0000000000..abcc663441
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_insert_disallow_order_by_rand.go
@@ -0,0 +1,107 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*InsertDisallowOrderByRandAdvisor)(nil)
+)
+
+const RandFn = "rand()"
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND, &InsertDisallowOrderByRandAdvisor{})
+}
+
+// InsertDisallowOrderByRandAdvisor is the advisor checking for to disallow order by rand in INSERT statements.
+type InsertDisallowOrderByRandAdvisor struct {
+}
+
+// Check checks for to disallow order by rand in INSERT statements.
+func (*InsertDisallowOrderByRandAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &insertDisallowOrderByRandOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type insertDisallowOrderByRandOmniRule struct {
+ OmniBaseRule
+}
+
+func (*insertDisallowOrderByRandOmniRule) Name() string {
+ return "InsertDisallowOrderByRandRule"
+}
+
+func (r *insertDisallowOrderByRandOmniRule) OnStatement(node ast.Node) {
+ ins, ok := node.(*ast.InsertStmt)
+ if !ok {
+ return
+ }
+
+ // Only check INSERT ... SELECT statements.
+ if ins.Select == nil {
+ return
+ }
+
+ text := r.TrimmedStmtText() + ";"
+
+ r.checkSelectForRandOrderBy(ins.Select, text)
+}
+
+func (r *insertDisallowOrderByRandOmniRule) checkSelectForRandOrderBy(sel *ast.SelectStmt, text string) {
+ if sel == nil {
+ return
+ }
+ if inner := sel.ParenSource; inner != nil {
+ r.checkSelectForRandOrderBy(inner, text)
+ }
+
+ for _, item := range sel.OrderBy {
+ if r.isRandFunc(item.Expr) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.InsertUseOrderByRand.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" uses ORDER BY RAND in the INSERT statement", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+ }
+ }
+
+ // Check set operations.
+ if sel.SetOp != ast.SetOpNone {
+ r.checkSelectForRandOrderBy(sel.Left, text)
+ r.checkSelectForRandOrderBy(sel.Right, text)
+ }
+}
+
+func (*insertDisallowOrderByRandOmniRule) isRandFunc(expr ast.ExprNode) bool {
+ if expr == nil {
+ return false
+ }
+ fc, ok := expr.(*ast.FuncCallExpr)
+ if !ok {
+ return false
+ }
+ return strings.EqualFold(fc.Name, "rand")
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_insert_must_specify_column.go b/backend/plugin/advisor/oceanbase/rule_insert_must_specify_column.go
new file mode 100644
index 0000000000..25a9c981fa
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_insert_must_specify_column.go
@@ -0,0 +1,82 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*InsertMustSpecifyColumnAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_INSERT_MUST_SPECIFY_COLUMN, &InsertMustSpecifyColumnAdvisor{})
+}
+
+// InsertMustSpecifyColumnAdvisor is the advisor checking for to enforce column specified.
+type InsertMustSpecifyColumnAdvisor struct {
+}
+
+// Check checks for to enforce column specified.
+func (*InsertMustSpecifyColumnAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &insertMustSpecifyColumnOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type insertMustSpecifyColumnOmniRule struct {
+ OmniBaseRule
+}
+
+func (*insertMustSpecifyColumnOmniRule) Name() string {
+ return "InsertMustSpecifyColumnRule"
+}
+
+func (r *insertMustSpecifyColumnOmniRule) OnStatement(node ast.Node) {
+ ins, ok := node.(*ast.InsertStmt)
+ if !ok {
+ return
+ }
+
+ text := r.TrimmedStmtText() + ";"
+
+ // INSERT ... SELECT without columns.
+ if ins.Select != nil && len(ins.Columns) == 0 {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.InsertNotSpecifyColumn.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The INSERT statement must specify columns but \"%s\" does not", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+ return
+ }
+
+ // INSERT ... VALUES without columns.
+ if len(ins.Values) > 0 && len(ins.Columns) == 0 {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.InsertNotSpecifyColumn.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The INSERT statement must specify columns but \"%s\" does not", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_migration_compatibility.go b/backend/plugin/advisor/oceanbase/rule_migration_compatibility.go
new file mode 100644
index 0000000000..37c06b5fd5
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_migration_compatibility.go
@@ -0,0 +1,155 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*CompatibilityAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_SCHEMA_BACKWARD_COMPATIBILITY, &CompatibilityAdvisor{})
+}
+
+// CompatibilityAdvisor is the advisor checking for schema backward compatibility.
+type CompatibilityAdvisor struct {
+}
+
+// Check checks schema backward compatibility.
+func (*CompatibilityAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &compatibilityOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type compatibilityOmniRule struct {
+ OmniBaseRule
+ lastCreateTable string
+}
+
+func (*compatibilityOmniRule) Name() string {
+ return "CompatibilityRule"
+}
+
+func (r *compatibilityOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.DropDatabaseStmt:
+ r.addIncompat(code.CompatibilityDropDatabase, n.Loc)
+ case *ast.RenameTableStmt:
+ r.addIncompat(code.CompatibilityRenameTable, n.Loc)
+ case *ast.DropTableStmt:
+ r.addIncompat(code.CompatibilityDropTable, n.Loc)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *compatibilityOmniRule) addIncompat(c code.Code, loc ast.Loc) {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: c.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" may cause incompatibility with the existing data and code", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(loc))),
+ })
+}
+
+func (r *compatibilityOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil || len(n.Columns) == 0 {
+ return
+ }
+ r.lastCreateTable = n.Table.Name
+}
+
+func (r *compatibilityOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ if tableName == r.lastCreateTable {
+ return
+ }
+
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATRenameColumn:
+ r.addIncompat(code.CompatibilityRenameColumn, n.Loc)
+ return
+ case ast.ATDropColumn:
+ r.addIncompat(code.CompatibilityDropColumn, n.Loc)
+ return
+ case ast.ATRenameTable:
+ r.addIncompat(code.CompatibilityRenameTable, n.Loc)
+ return
+ case ast.ATAddConstraint:
+ if cmd.Constraint == nil {
+ continue
+ }
+ switch cmd.Constraint.Type {
+ case ast.ConstrPrimaryKey:
+ r.addIncompat(code.CompatibilityAddPrimaryKey, n.Loc)
+ return
+ case ast.ConstrUnique:
+ r.addIncompat(code.CompatibilityAddUniqueKey, n.Loc)
+ return
+ case ast.ConstrForeignKey:
+ r.addIncompat(code.CompatibilityAddForeignKey, n.Loc)
+ return
+ case ast.ConstrCheck:
+ // add check enforced
+ if !cmd.Constraint.NotEnforced {
+ r.addIncompat(code.CompatibilityAddCheck, n.Loc)
+ return
+ }
+ default:
+ }
+ case ast.ATAlterCheckEnforced:
+ r.addIncompat(code.CompatibilityAlterCheck, n.Loc)
+ return
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ r.addIncompat(code.CompatibilityAlterColumn, n.Loc)
+ return
+ default:
+ }
+ }
+}
+
+func (r *compatibilityOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ if !n.Unique {
+ return
+ }
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ if r.lastCreateTable != tableName {
+ r.addIncompat(code.CompatibilityAddUniqueKey, n.Loc)
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_auto_increment_column.go b/backend/plugin/advisor/oceanbase/rule_naming_auto_increment_column.go
new file mode 100644
index 0000000000..3eef997354
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_auto_increment_column.go
@@ -0,0 +1,128 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "regexp"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*NamingAutoIncrementColumnAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_COLUMN_AUTO_INCREMENT, &NamingAutoIncrementColumnAdvisor{})
+}
+
+// NamingAutoIncrementColumnAdvisor is the advisor checking for auto-increment naming convention.
+type NamingAutoIncrementColumnAdvisor struct {
+}
+
+// Check checks for auto-increment naming convention.
+func (*NamingAutoIncrementColumnAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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, err := regexp.Compile(namingPayload.Format)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
+ }
+
+ rule := &namingAutoIncrementColumnOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type namingAutoIncrementColumnOmniRule struct {
+ OmniBaseRule
+ format *regexp.Regexp
+ maxLength int
+}
+
+func (*namingAutoIncrementColumnOmniRule) Name() string {
+ return "NamingAutoIncrementColumnRule"
+}
+
+func (r *namingAutoIncrementColumnOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil || !col.AutoIncrement {
+ continue
+ }
+ r.handleAutoIncrementColumn(tableName, col.Name, r.LocToLine(n.Loc))
+ }
+ case *ast.AlterTableStmt:
+ tableName := ""
+ if n.Table != nil {
+ tableName = n.Table.Name
+ }
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn, ast.ATModifyColumn, ast.ATChangeColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ if col.AutoIncrement {
+ r.handleAutoIncrementColumn(tableName, col.Name, r.LocToLine(n.Loc))
+ }
+ }
+ default:
+ }
+ }
+ default:
+ }
+}
+
+func (r *namingAutoIncrementColumnOmniRule) handleAutoIncrementColumn(tableName, columnName string, lineNumber int32) {
+ absoluteLine := r.BaseLine + int(lineNumber)
+ if !r.format.MatchString(columnName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingAutoIncrementColumnConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` mismatches auto_increment column naming convention, naming format should be %q", tableName, columnName, r.format),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+ if r.maxLength > 0 && len(columnName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingAutoIncrementColumnConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` mismatches auto_increment column naming convention, its length should be within %d characters", tableName, columnName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_column.go b/backend/plugin/advisor/oceanbase/rule_naming_column.go
new file mode 100644
index 0000000000..ed23a0c744
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_column.go
@@ -0,0 +1,133 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "regexp"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var _ advisor.Advisor = (*NamingColumnConventionAdvisor)(nil)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_COLUMN, &NamingColumnConventionAdvisor{})
+}
+
+// NamingColumnConventionAdvisor is the advisor checking for column naming convention.
+type NamingColumnConventionAdvisor struct {
+}
+
+// Check checks for column naming convention.
+func (*NamingColumnConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ 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, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
+ }
+
+ rule := &namingColumnOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type namingColumnOmniRule struct {
+ OmniBaseRule
+ format *regexp.Regexp
+ maxLength int
+}
+
+func (*namingColumnOmniRule) Name() string {
+ return "NamingColumnRule"
+}
+
+func (r *namingColumnOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, col := range n.Columns {
+ if col == nil {
+ continue
+ }
+ r.handleColumn(tableName, col.Name, r.LocToLine(col.Loc))
+ }
+ case *ast.AlterTableStmt:
+ tableName := ""
+ if n.Table != nil {
+ tableName = n.Table.Name
+ }
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ for _, col := range omniGetColumnsFromCmd(cmd) {
+ r.handleColumn(tableName, col.Name, r.LocToLine(n.Loc))
+ }
+ case ast.ATRenameColumn:
+ if cmd.NewName != "" {
+ r.handleColumn(tableName, cmd.NewName, r.LocToLine(n.Loc))
+ }
+ case ast.ATChangeColumn:
+ if cmd.Column != nil {
+ r.handleColumn(tableName, cmd.Column.Name, r.LocToLine(n.Loc))
+ }
+ default:
+ }
+ }
+ default:
+ }
+}
+
+func (r *namingColumnOmniRule) handleColumn(tableName, columnName string, lineNumber int32) {
+ absoluteLine := r.BaseLine + int(lineNumber)
+ if !r.format.MatchString(columnName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingColumnConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` mismatches column naming convention, naming format should be %q", tableName, columnName, r.format),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+ if r.maxLength > 0 && len(columnName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingColumnConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s`.`%s` mismatches column naming convention, its length should be within %d characters", tableName, columnName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_foreign_key_convention.go b/backend/plugin/advisor/oceanbase/rule_naming_foreign_key_convention.go
new file mode 100644
index 0000000000..8a82f85bab
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_foreign_key_convention.go
@@ -0,0 +1,193 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*NamingFKConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_FK, &NamingFKConventionAdvisor{})
+}
+
+// NamingFKConventionAdvisor is the advisor checking for foreign key naming convention.
+type NamingFKConventionAdvisor struct {
+}
+
+// Check checks for foreign key naming convention.
+func (*NamingFKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 := &namingFKOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ templateList: templateList,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+// fkIndexMetaData is the metadata for foreign key.
+type fkIndexMetaData struct {
+ indexName string
+ tableName string
+ metaData map[string]string
+ line int
+}
+
+type namingFKOmniRule struct {
+ OmniBaseRule
+ format string
+ maxLength int
+ templateList []string
+}
+
+func (*namingFKOmniRule) Name() string {
+ return "NamingFKConventionRule"
+}
+
+func (r *namingFKOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *namingFKOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ var indexDataList []*fkIndexMetaData
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ if metaData := r.handleConstraint(tableName, constraint, r.BaseLine+int(r.LocToLine(constraint.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingFKOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := ""
+ if n.Table != nil {
+ tableName = n.Table.Name
+ }
+ var indexDataList []*fkIndexMetaData
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ if cmd.Type == ast.ATAddConstraint && cmd.Constraint != nil {
+ if metaData := r.handleConstraint(tableName, cmd.Constraint, r.BaseLine+int(r.LocToLine(n.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingFKOmniRule) handleIndexList(indexDataList []*fkIndexMetaData) {
+ for _, indexData := range indexDataList {
+ regex, err := getTemplateRegexp(r.format, r.templateList, indexData.metaData)
+ if err != nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.Internal.Int32(),
+ Title: "Internal error for foreign key naming convention rule",
+ Content: fmt.Sprintf("%q meet internal error %q", r.TrimmedStmtText(), err.Error()),
+ })
+ continue
+ }
+ if !regex.MatchString(indexData.indexName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingFKConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Foreign key in table `%s` mismatches the naming convention, expect %q but found `%s`", indexData.tableName, regex, indexData.indexName),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ if r.maxLength > 0 && len(indexData.indexName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingFKConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Foreign key `%s` in table `%s` mismatches the naming convention, its length should be within %d characters", indexData.indexName, indexData.tableName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ }
+}
+
+func (*namingFKOmniRule) handleConstraint(tableName string, constraint *ast.Constraint, line int) *fkIndexMetaData {
+ // Focus on foreign key.
+ if constraint.Type != ast.ConstrForeignKey {
+ return nil
+ }
+
+ indexName := omniConstraintName(constraint)
+
+ referencingColumnList := constraint.Columns
+ referencedTable := ""
+ if constraint.RefTable != nil {
+ referencedTable = constraint.RefTable.Name
+ }
+ referencedColumnList := constraint.RefColumns
+
+ metaData := map[string]string{
+ advisor.ReferencingTableNameTemplateToken: tableName,
+ advisor.ReferencingColumnNameTemplateToken: strings.Join(referencingColumnList, "_"),
+ advisor.ReferencedTableNameTemplateToken: referencedTable,
+ advisor.ReferencedColumnNameTemplateToken: strings.Join(referencedColumnList, "_"),
+ }
+ return &fkIndexMetaData{
+ indexName: indexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: line,
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_index_convention.go b/backend/plugin/advisor/oceanbase/rule_naming_index_convention.go
new file mode 100644
index 0000000000..522f48a1aa
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_index_convention.go
@@ -0,0 +1,242 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*NamingIndexConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_IDX, &NamingIndexConventionAdvisor{})
+}
+
+// indexMetaData is the metadata for index.
+type indexMetaData struct {
+ indexName string
+ tableName string
+ metaData map[string]string
+ line int
+}
+
+// NamingIndexConventionAdvisor is the advisor checking for index naming convention.
+type NamingIndexConventionAdvisor struct {
+}
+
+// Check checks for index naming convention.
+func (*NamingIndexConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 := &namingIndexOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ templateList: templateList,
+ originalMetadata: checkCtx.OriginalMetadata,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type namingIndexOmniRule struct {
+ OmniBaseRule
+ format string
+ maxLength int
+ templateList []string
+ originalMetadata *model.DatabaseMetadata
+}
+
+func (*namingIndexOmniRule) Name() string {
+ return "NamingIndexConventionRule"
+}
+
+func (r *namingIndexOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *namingIndexOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ var indexDataList []*indexMetaData
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ if metaData := r.handleConstraint(tableName, constraint, r.BaseLine+int(r.LocToLine(constraint.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingIndexOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := ""
+ if n.Table != nil {
+ tableName = n.Table.Name
+ }
+ var indexDataList []*indexMetaData
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ if metaData := r.handleConstraint(tableName, cmd.Constraint, r.BaseLine+int(r.LocToLine(n.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ case ast.ATRenameIndex:
+ oldIndexName := cmd.Name
+ newIndexName := cmd.NewName
+ indexState := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetIndex(oldIndexName)
+ if indexState == nil {
+ continue
+ }
+ if indexState.GetProto().GetUnique() {
+ // Unique index naming convention should in rule_naming_unique_key_convention.go
+ continue
+ }
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(indexState.GetProto().GetExpressions(), "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ indexData := &indexMetaData{
+ indexName: newIndexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: r.BaseLine + int(r.LocToLine(n.Loc)),
+ }
+ indexDataList = append(indexDataList, indexData)
+ default:
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingIndexOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ // Unique, fulltext, spatial index naming convention should be in other rules.
+ if n.Unique || n.Fulltext || n.Spatial {
+ return
+ }
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ columnList := omniIndexColumns(n.Columns)
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ indexDataList := []*indexMetaData{
+ {
+ indexName: n.IndexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: r.BaseLine + int(r.LocToLine(n.Loc)),
+ },
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingIndexOmniRule) handleIndexList(indexDataList []*indexMetaData) {
+ for _, indexData := range indexDataList {
+ regex, err := getTemplateRegexp(r.format, r.templateList, indexData.metaData)
+ if err != nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.Internal.Int32(),
+ Title: "Internal error for unique key naming convention rule",
+ Content: fmt.Sprintf("%q meet internal error %q", r.TrimmedStmtText(), err.Error()),
+ })
+ continue
+ }
+ if !regex.MatchString(indexData.indexName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingIndexConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Index in table `%s` mismatches the naming convention, expect %q but found `%s`", indexData.tableName, regex, indexData.indexName),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ if r.maxLength > 0 && len(indexData.indexName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingIndexConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Index `%s` in table `%s` mismatches the naming convention, its length should be within %d characters", indexData.indexName, indexData.tableName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ }
+}
+
+func (*namingIndexOmniRule) handleConstraint(tableName string, constraint *ast.Constraint, line int) *indexMetaData {
+ // We only focus on normal index.
+ if constraint.Type != ast.ConstrIndex {
+ return nil
+ }
+ indexName := constraint.Name
+ columnList := constraint.Columns
+ if len(columnList) == 0 {
+ columnList = omniIndexColumns(constraint.IndexColumns)
+ }
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ return &indexMetaData{
+ indexName: indexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: line,
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_table.go b/backend/plugin/advisor/oceanbase/rule_naming_table.go
new file mode 100644
index 0000000000..89105b330a
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_table.go
@@ -0,0 +1,115 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "regexp"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*NamingTableConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_TABLE, &NamingTableConventionAdvisor{})
+}
+
+// NamingTableConventionAdvisor is the advisor checking for table naming convention.
+type NamingTableConventionAdvisor struct {
+}
+
+// Check checks for table naming convention.
+func (*NamingTableConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ 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, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ maxLength := int(namingPayload.MaxLength)
+ if maxLength == 0 {
+ maxLength = advisor.DefaultNameLengthLimit
+ }
+
+ rule := &namingTableOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type namingTableOmniRule struct {
+ OmniBaseRule
+ format *regexp.Regexp
+ maxLength int
+}
+
+func (*namingTableOmniRule) Name() string {
+ return "NamingTableRule"
+}
+
+func (r *namingTableOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ if n.Table != nil {
+ r.handleTableName(n.Table.Name, r.LocToLine(n.Loc))
+ }
+ case *ast.AlterTableStmt:
+ for _, cmd := range n.Commands {
+ if newTableName := omniRenameTableName(cmd); newTableName != "" {
+ r.handleTableName(newTableName, r.LocToLine(n.Loc))
+ }
+ }
+ case *ast.RenameTableStmt:
+ for _, pair := range n.Pairs {
+ if pair.New != nil {
+ r.handleTableName(pair.New.Name, r.LocToLine(n.Loc))
+ }
+ }
+ default:
+ }
+}
+
+func (r *namingTableOmniRule) handleTableName(tableName string, lineNumber int32) {
+ absoluteLine := r.BaseLine + int(lineNumber)
+ if !r.format.MatchString(tableName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingTableConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s` mismatches table naming convention, naming format should be %q", tableName, r.format),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+ if r.maxLength > 0 && len(tableName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingTableConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s` mismatches table naming convention, its length should be within %d characters", tableName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_naming_unique_key_convention.go b/backend/plugin/advisor/oceanbase/rule_naming_unique_key_convention.go
new file mode 100644
index 0000000000..1fb2a98806
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_naming_unique_key_convention.go
@@ -0,0 +1,242 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+var (
+ _ advisor.Advisor = (*NamingUKConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_NAMING_INDEX_UK, &NamingUKConventionAdvisor{})
+}
+
+// NamingUKConventionAdvisor is the advisor checking for unique key naming convention.
+type NamingUKConventionAdvisor struct {
+}
+
+// Check checks for index naming convention.
+func (*NamingUKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ 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 := &namingUKOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ maxLength: maxLength,
+ templateList: templateList,
+ originalMetadata: checkCtx.OriginalMetadata,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+// ukIndexMetaData is the metadata for unique key.
+type ukIndexMetaData struct {
+ indexName string
+ tableName string
+ metaData map[string]string
+ line int
+}
+
+type namingUKOmniRule struct {
+ OmniBaseRule
+ format string
+ maxLength int
+ templateList []string
+ originalMetadata *model.DatabaseMetadata
+}
+
+func (*namingUKOmniRule) Name() string {
+ return "NamingUKConventionRule"
+}
+
+func (r *namingUKOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ case *ast.CreateIndexStmt:
+ r.checkCreateIndex(n)
+ default:
+ }
+}
+
+func (r *namingUKOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ var indexDataList []*ukIndexMetaData
+ for _, constraint := range n.Constraints {
+ if constraint == nil {
+ continue
+ }
+ if metaData := r.handleConstraint(tableName, constraint, r.BaseLine+int(r.LocToLine(constraint.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingUKOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ tableName := ""
+ if n.Table != nil {
+ tableName = n.Table.Name
+ }
+ var indexDataList []*ukIndexMetaData
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddConstraint, ast.ATAddIndex:
+ if cmd.Constraint != nil {
+ if metaData := r.handleConstraint(tableName, cmd.Constraint, r.BaseLine+int(r.LocToLine(n.Loc))); metaData != nil {
+ indexDataList = append(indexDataList, metaData)
+ }
+ }
+ case ast.ATRenameIndex:
+ oldIndexName := cmd.Name
+ newIndexName := cmd.NewName
+ indexState := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetIndex(oldIndexName)
+ if indexState == nil {
+ continue
+ }
+ if !indexState.GetProto().GetUnique() {
+ continue
+ }
+ columnList := indexState.GetProto().GetExpressions()
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ indexData := &ukIndexMetaData{
+ indexName: newIndexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: r.BaseLine + int(r.LocToLine(n.Loc)),
+ }
+ indexDataList = append(indexDataList, indexData)
+ default:
+ }
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingUKOmniRule) checkCreateIndex(n *ast.CreateIndexStmt) {
+ // Only focus on unique index.
+ if !n.Unique {
+ return
+ }
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ columnList := omniIndexColumns(n.Columns)
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ indexDataList := []*ukIndexMetaData{
+ {
+ indexName: n.IndexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: r.BaseLine + int(r.LocToLine(n.Loc)),
+ },
+ }
+ r.handleIndexList(indexDataList)
+}
+
+func (r *namingUKOmniRule) handleIndexList(indexDataList []*ukIndexMetaData) {
+ for _, indexData := range indexDataList {
+ regex, err := getTemplateRegexp(r.format, r.templateList, indexData.metaData)
+ if err != nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.Internal.Int32(),
+ Title: "Internal error for unique key naming convention rule",
+ Content: fmt.Sprintf("%q meet internal error %q", r.TrimmedStmtText(), err.Error()),
+ })
+ continue
+ }
+ if !regex.MatchString(indexData.indexName) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingUKConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Unique key in table `%s` mismatches the naming convention, expect %q but found `%s`", indexData.tableName, regex, indexData.indexName),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ if r.maxLength > 0 && len(indexData.indexName) > r.maxLength {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.NamingUKConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Unique key `%s` in table `%s` mismatches the naming convention, its length should be within %d characters", indexData.indexName, indexData.tableName, r.maxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(indexData.line),
+ })
+ }
+ }
+}
+
+func (*namingUKOmniRule) handleConstraint(tableName string, constraint *ast.Constraint, line int) *ukIndexMetaData {
+ // Focus on unique index.
+ if constraint.Type != ast.ConstrUnique {
+ return nil
+ }
+ indexName := constraint.Name
+ columnList := constraint.Columns
+ if len(columnList) == 0 {
+ columnList = omniIndexColumns(constraint.IndexColumns)
+ }
+ metaData := map[string]string{
+ advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
+ advisor.TableNameTemplateToken: tableName,
+ }
+ return &ukIndexMetaData{
+ indexName: indexName,
+ tableName: tableName,
+ metaData: metaData,
+ line: line,
+ }
+}
diff --git a/backend/plugin/advisor/mysql/rule_statement_add_column_without_position.go b/backend/plugin/advisor/oceanbase/rule_statement_add_column_without_position.go
similarity index 97%
rename from backend/plugin/advisor/mysql/rule_statement_add_column_without_position.go
rename to backend/plugin/advisor/oceanbase/rule_statement_add_column_without_position.go
index 889e26660c..23c33a1de3 100644
--- a/backend/plugin/advisor/mysql/rule_statement_add_column_without_position.go
+++ b/backend/plugin/advisor/oceanbase/rule_statement_add_column_without_position.go
@@ -1,10 +1,10 @@
-package mysql
+package oceanbase
import (
"context"
"fmt"
- "github.com/bytebase/omni/mysql/ast"
+ "github.com/bytebase/omni/oceanbase/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
diff --git a/backend/plugin/advisor/oceanbase/rule_statement_disallow_truncate.go b/backend/plugin/advisor/oceanbase/rule_statement_disallow_truncate.go
new file mode 100644
index 0000000000..6ed356686d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_statement_disallow_truncate.go
@@ -0,0 +1,94 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var _ advisor.Advisor = (*StatementDisallowTruncateAdvisor)(nil)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_TRUNCATE, &StatementDisallowTruncateAdvisor{})
+}
+
+type StatementDisallowTruncateAdvisor struct{}
+
+func (*StatementDisallowTruncateAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ rule := &statementDisallowTruncateOmniRule{
+ OmniBaseRule: OmniBaseRule{Level: level, Title: checkCtx.Rule.Type.String()},
+ }
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type statementDisallowTruncateOmniRule struct{ OmniBaseRule }
+
+func (*statementDisallowTruncateOmniRule) Name() string { return "StatementDisallowTruncateRule" }
+
+func (r *statementDisallowTruncateOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.TruncateStmt:
+ for _, tbl := range n.Tables {
+ r.emitTable(tbl, n.Loc)
+ }
+ case *ast.AlterTableStmt:
+ if n.Table == nil {
+ return
+ }
+ for _, cmd := range n.Commands {
+ if cmd.Type != ast.ATTruncatePartition {
+ continue
+ }
+ // Point the advice at the individual ALTER command, not the
+ // ALTER TABLE statement. A multi-command ALTER TABLE splits the
+ // truncate clause onto its own line and the user needs to jump
+ // to that line, not the statement head.
+ loc := cmd.Loc
+ if cmd.AllPartitions {
+ r.emitPartition(n.Table, "ALL PARTITIONS", loc)
+ continue
+ }
+ for _, pname := range cmd.PartitionNames {
+ r.emitPartition(n.Table, pname, loc)
+ }
+ }
+ default:
+ }
+}
+
+func (r *statementDisallowTruncateOmniRule) emitTable(tbl *ast.TableRef, loc ast.Loc) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementDisallowTruncate.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf(`TRUNCATE TABLE %q is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.`, qualifyMySQLName(tbl)),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(loc))),
+ })
+}
+
+func (r *statementDisallowTruncateOmniRule) emitPartition(tbl *ast.TableRef, partition string, loc ast.Loc) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementDisallowTruncate.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf(`ALTER TABLE %q TRUNCATE PARTITION %q is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.`, qualifyMySQLName(tbl), partition),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(loc))),
+ })
+}
+
+func qualifyMySQLName(tbl *ast.TableRef) string {
+ if tbl.Schema != "" {
+ return tbl.Schema + "." + tbl.Name
+ }
+ return tbl.Name
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_statement_dml_dry_run.go b/backend/plugin/advisor/oceanbase/rule_statement_dml_dry_run.go
new file mode 100644
index 0000000000..db28d35bce
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_statement_dml_dry_run.go
@@ -0,0 +1,87 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ "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"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ _ advisor.Advisor = (*StatementDmlDryRunAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DML_DRY_RUN, &StatementDmlDryRunAdvisor{})
+}
+
+// StatementDmlDryRunAdvisor is the advisor checking for DML dry run.
+type StatementDmlDryRunAdvisor struct {
+}
+
+// Check checks for DML dry run.
+func (*StatementDmlDryRunAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ // BYT-8855: Skip DML dry run if there are DDL statements mixed in, because DML
+ // statements often reference objects created by DDL statements, causing false positives.
+ if advisor.ContainsDDL(checkCtx.DBType, checkCtx.ParsedStatements) {
+ return nil, nil
+ }
+
+ driver := checkCtx.Driver
+ title := checkCtx.Rule.Type.String()
+ var advice []*storepb.Advice
+ explainCount := 0
+
+ if driver != nil {
+ for _, stmt := range checkCtx.ParsedStatements {
+ if stmt.AST == nil {
+ continue
+ }
+ node, ok := oceanbaseparser.GetOmniNode(stmt.AST)
+ if !ok {
+ continue
+ }
+
+ // Only handle DML statements.
+ switch node.(type) {
+ case *ast.InsertStmt, *ast.UpdateStmt, *ast.DeleteStmt:
+ default:
+ continue
+ }
+
+ baseLine := stmt.BaseLine()
+ text := strings.TrimRight(strings.TrimSpace(stmt.Text), ";") + ";"
+ line := baseLine + int(oceanbaseparser.ByteOffsetToRunePosition(stmt.Text, contentStartIndex(stmt.Text)).Line)
+
+ explainCount++
+ if _, err := advisor.Query(ctx, advisor.QueryContext{}, driver, storepb.Engine_OCEANBASE, fmt.Sprintf("EXPLAIN %s", text)); err != nil {
+ advice = append(advice, &storepb.Advice{
+ Status: level,
+ Code: code.StatementDMLDryRunFailed.Int32(),
+ Title: title,
+ Content: fmt.Sprintf("\"%s\" dry runs failed: %s", text, err.Error()),
+ StartPosition: base.ConvertANTLRLineToPosition(line),
+ })
+ }
+
+ if explainCount >= common.MaximumLintExplainSize {
+ break
+ }
+ }
+ }
+
+ return advice, nil
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_statement_merge_alter_table.go b/backend/plugin/advisor/oceanbase/rule_statement_merge_alter_table.go
new file mode 100644
index 0000000000..eb9e77f7e0
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_statement_merge_alter_table.go
@@ -0,0 +1,121 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*StatementMergeAlterTableAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_MERGE_ALTER_TABLE, &StatementMergeAlterTableAdvisor{})
+}
+
+// StatementMergeAlterTableAdvisor is the advisor checking for merging ALTER TABLE statements.
+type StatementMergeAlterTableAdvisor struct {
+}
+
+// Check checks for merging ALTER TABLE statements.
+func (*StatementMergeAlterTableAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &mergeAlterTableOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ tableMap: make(map[string]tableStatement),
+ }
+
+ RunRules(checkCtx.ParsedStatements, []OmniRule{rule})
+ rule.generateAdvice()
+ return rule.GetAdviceList(), nil
+}
+
+// tableStatement represents information about a table's statements.
+type tableStatement struct {
+ name string
+ count int
+ lastLine int
+}
+
+type mergeAlterTableOmniRule struct {
+ OmniBaseRule
+ tableMap map[string]tableStatement
+}
+
+func (*mergeAlterTableOmniRule) Name() string {
+ return "StatementMergeAlterTableRule"
+}
+
+func (r *mergeAlterTableOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ r.tableMap[tableName] = tableStatement{
+ name: tableName,
+ count: 1,
+ lastLine: r.BaseLine + int(r.ContentStartLine()),
+ }
+ case *ast.AlterTableStmt:
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ table, ok := r.tableMap[tableName]
+ if !ok {
+ table = tableStatement{
+ name: tableName,
+ count: 0,
+ }
+ }
+ table.count++
+ table.lastLine = r.BaseLine + int(r.ContentStartLine())
+ r.tableMap[tableName] = table
+ default:
+ }
+}
+
+func (r *mergeAlterTableOmniRule) generateAdvice() {
+ var tableList []tableStatement
+ for _, table := range r.tableMap {
+ tableList = append(tableList, table)
+ }
+ slices.SortFunc(tableList, func(i, j tableStatement) int {
+ if i.lastLine < j.lastLine {
+ return -1
+ }
+ if i.lastLine > j.lastLine {
+ return 1
+ }
+ return 0
+ })
+
+ for _, table := range tableList {
+ if table.count > 1 {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementRedundantAlterTable.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("There are %d statements to modify table `%s`", table.count, table.name),
+ StartPosition: base.ConvertANTLRLineToPosition(table.lastLine),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_disallow_commit.go b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_commit.go
new file mode 100644
index 0000000000..cbc00d32c8
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_commit.go
@@ -0,0 +1,66 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*StatementDisallowCommitAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_COMMIT, &StatementDisallowCommitAdvisor{})
+}
+
+// StatementDisallowCommitAdvisor is the advisor checking for disallowing commit.
+type StatementDisallowCommitAdvisor struct {
+}
+
+// Check checks for disallowing commit.
+func (*StatementDisallowCommitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &disallowCommitOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type disallowCommitOmniRule struct {
+ OmniBaseRule
+}
+
+func (*disallowCommitOmniRule) Name() string {
+ return "StatementDisallowCommitRule"
+}
+
+func (r *disallowCommitOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.CommitStmt)
+ if !ok {
+ return
+ }
+ text := strings.TrimSpace(r.StmtText)
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementDisallowCommit.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Commit is not allowed, related statement: \"%s\"", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(n.Loc))),
+ })
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_disallow_limit.go b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_limit.go
new file mode 100644
index 0000000000..f0e197af6f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_limit.go
@@ -0,0 +1,105 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*StatementDisallowLimitAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_LIMIT, &StatementDisallowLimitAdvisor{})
+}
+
+// StatementDisallowLimitAdvisor is the advisor checking for no LIMIT clause in INSERT/UPDATE/DELETE statement.
+type StatementDisallowLimitAdvisor struct {
+}
+
+// Check checks for no LIMIT clause in INSERT/UPDATE/DELETE statement.
+func (*StatementDisallowLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &disallowLimitOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type disallowLimitOmniRule struct {
+ OmniBaseRule
+}
+
+func (*disallowLimitOmniRule) Name() string {
+ return "StatementDisallowLimitRule"
+}
+
+func (r *disallowLimitOmniRule) OnStatement(node ast.Node) {
+ text := strings.TrimSpace(r.StmtText)
+ switch n := node.(type) {
+ case *ast.DeleteStmt:
+ if n.Limit != nil {
+ r.addLimitAdvice(code.DeleteUseLimit, text, n.Loc)
+ }
+ case *ast.UpdateStmt:
+ if n.Limit != nil {
+ r.addLimitAdvice(code.UpdateUseLimit, text, n.Loc)
+ }
+ case *ast.InsertStmt:
+ if n.Select != nil {
+ r.checkSelectLimit(n.Select, text)
+ }
+ default:
+ }
+}
+
+func (r *disallowLimitOmniRule) checkSelectLimit(sel *ast.SelectStmt, text string) {
+ if sel == nil {
+ return
+ }
+ if inner := sel.ParenSource; inner != nil {
+ if sel.Limit != nil {
+ r.addLimitAdvice(code.InsertUseLimit, text, sel.Loc)
+ }
+ r.checkSelectLimit(inner, text)
+ return
+ }
+ if sel.SetOp != ast.SetOpNone {
+ // Check set operation top-level limit.
+ if sel.Limit != nil {
+ r.addLimitAdvice(code.InsertUseLimit, text, sel.Loc)
+ }
+ r.checkSelectLimit(sel.Left, text)
+ r.checkSelectLimit(sel.Right, text)
+ return
+ }
+ if sel.Limit != nil {
+ r.addLimitAdvice(code.InsertUseLimit, text, sel.Loc)
+ }
+}
+
+func (r *disallowLimitOmniRule) addLimitAdvice(c code.Code, text string, _ ast.Loc) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: c.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but \"%s\" uses", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_disallow_order_by.go b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_order_by.go
new file mode 100644
index 0000000000..b990884d03
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_disallow_order_by.go
@@ -0,0 +1,76 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*DisallowOrderByAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_DISALLOW_ORDER_BY, &DisallowOrderByAdvisor{})
+}
+
+// DisallowOrderByAdvisor is the advisor checking for no ORDER BY clause in DELETE/UPDATE statements.
+type DisallowOrderByAdvisor struct {
+}
+
+// Check checks for no ORDER BY clause in DELETE/UPDATE statements.
+func (*DisallowOrderByAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &disallowOrderByOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type disallowOrderByOmniRule struct {
+ OmniBaseRule
+}
+
+func (*disallowOrderByOmniRule) Name() string {
+ return "DisallowOrderByRule"
+}
+
+func (r *disallowOrderByOmniRule) OnStatement(node ast.Node) {
+ text := strings.TrimSpace(r.StmtText)
+ switch n := node.(type) {
+ case *ast.DeleteStmt:
+ if len(n.OrderBy) > 0 {
+ r.addOrderByAdvice(code.DeleteUseOrderBy, text, n.Loc)
+ }
+ case *ast.UpdateStmt:
+ if len(n.OrderBy) > 0 {
+ r.addOrderByAdvice(code.UpdateUseOrderBy, text, n.Loc)
+ }
+ default:
+ }
+}
+
+func (r *disallowOrderByOmniRule) addOrderByAdvice(c code.Code, text string, loc ast.Loc) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: c.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("ORDER BY clause is forbidden in DELETE and UPDATE statements, but \"%s\" uses", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(loc))),
+ })
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_no_leading_wildcard_like.go b/backend/plugin/advisor/oceanbase/rule_stmt_no_leading_wildcard_like.go
new file mode 100644
index 0000000000..6b8c31f1e0
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_no_leading_wildcard_like.go
@@ -0,0 +1,78 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*NoLeadingWildcardLikeAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE, &NoLeadingWildcardLikeAdvisor{})
+}
+
+// NoLeadingWildcardLikeAdvisor is the advisor checking for no leading wildcard LIKE.
+type NoLeadingWildcardLikeAdvisor struct {
+}
+
+// Check checks for no leading wildcard LIKE.
+func (*NoLeadingWildcardLikeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &noLeadingWildcardLikeOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type noLeadingWildcardLikeOmniRule struct {
+ OmniBaseRule
+}
+
+func (*noLeadingWildcardLikeOmniRule) Name() string {
+ return "NoLeadingWildcardLikeRule"
+}
+
+func (r *noLeadingWildcardLikeOmniRule) OnStatement(node ast.Node) {
+ text := strings.TrimSpace(r.StmtText)
+ ast.Inspect(node, func(n ast.Node) bool {
+ if like, ok := n.(*ast.LikeExpr); ok {
+ r.checkLikeExpr(like, text)
+ }
+ return true
+ })
+}
+
+func (r *noLeadingWildcardLikeOmniRule) checkLikeExpr(like *ast.LikeExpr, text string) {
+ if like.Pattern == nil {
+ return
+ }
+ if str, ok := like.Pattern.(*ast.StringLit); ok {
+ if strings.HasPrefix(str.Value, "%") {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementLeadingWildcardLike.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" uses leading wildcard LIKE", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(like.Loc))),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_no_select_all.go b/backend/plugin/advisor/oceanbase/rule_stmt_no_select_all.go
new file mode 100644
index 0000000000..a56423a023
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_no_select_all.go
@@ -0,0 +1,105 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*NoSelectAllAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_SELECT_NO_SELECT_ALL, &NoSelectAllAdvisor{})
+}
+
+// NoSelectAllAdvisor is the advisor checking for no "select *".
+type NoSelectAllAdvisor struct {
+}
+
+// Check checks for no "select *".
+func (*NoSelectAllAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &noSelectAllOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type noSelectAllOmniRule struct {
+ OmniBaseRule
+}
+
+func (*noSelectAllOmniRule) Name() string {
+ return "NoSelectAllRule"
+}
+
+func (r *noSelectAllOmniRule) OnStatement(node ast.Node) {
+ text := strings.TrimSpace(r.StmtText)
+ ast.Inspect(node, func(n ast.Node) bool {
+ sel, ok := n.(*ast.SelectStmt)
+ if !ok {
+ return true
+ }
+ // Only check TargetList on leaf SelectStmt (not UNION nodes).
+ if sel.SetOp != ast.SetOpNone {
+ return true
+ }
+ for _, target := range sel.TargetList {
+ if r.isStarTarget(target) {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementSelectAll.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" uses SELECT all", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.findStarLine(target))),
+ })
+ }
+ }
+ // Recurse into children (CTEs, subqueries in FROM, etc.) via Inspect.
+ return true
+ })
+}
+
+func (*noSelectAllOmniRule) isStarTarget(expr ast.ExprNode) bool {
+ switch e := expr.(type) {
+ case *ast.StarExpr:
+ return true
+ case *ast.ResTarget:
+ if _, ok := e.Val.(*ast.StarExpr); ok {
+ return true
+ }
+ default:
+ }
+ return false
+}
+
+func (r *noSelectAllOmniRule) findStarLine(expr ast.ExprNode) int32 {
+ switch e := expr.(type) {
+ case *ast.StarExpr:
+ return r.LocToLine(e.Loc)
+ case *ast.ResTarget:
+ if star, ok := e.Val.(*ast.StarExpr); ok {
+ return r.LocToLine(star.Loc)
+ }
+ return r.LocToLine(e.Loc)
+ default:
+ return r.ContentStartLine()
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_select.go b/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_select.go
new file mode 100644
index 0000000000..26a0363bf6
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_select.go
@@ -0,0 +1,120 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*WhereRequirementForSelectAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_SELECT, &WhereRequirementForSelectAdvisor{})
+}
+
+// WhereRequirementForSelectAdvisor is the advisor checking for the WHERE clause requirement for SELECT statements.
+type WhereRequirementForSelectAdvisor struct {
+}
+
+// Check checks for the WHERE clause requirement.
+func (*WhereRequirementForSelectAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &whereRequirementForSelectOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type whereRequirementForSelectOmniRule struct {
+ OmniBaseRule
+}
+
+func (*whereRequirementForSelectOmniRule) Name() string {
+ return "WhereRequirementForSelectRule"
+}
+
+func (r *whereRequirementForSelectOmniRule) OnStatement(node ast.Node) {
+ sel, ok := node.(*ast.SelectStmt)
+ if !ok {
+ return
+ }
+ text := strings.TrimSpace(r.StmtText)
+ r.checkSelectStmt(sel, text)
+}
+
+func (r *whereRequirementForSelectOmniRule) checkSelectStmt(sel *ast.SelectStmt, text string) {
+ if sel == nil {
+ return
+ }
+
+ // Check CTEs.
+ for _, cte := range sel.CTEs {
+ if cte.Select != nil {
+ r.checkSelectStmt(cte.Select, text)
+ }
+ }
+ if inner := sel.ParenSource; inner != nil {
+ r.checkSelectStmt(inner, text)
+ return
+ }
+
+ // Check set operations (UNION left/right).
+ if sel.SetOp != ast.SetOpNone {
+ r.checkSelectStmt(sel.Left, text)
+ r.checkSelectStmt(sel.Right, text)
+ return
+ }
+
+ // Allow SELECT queries without a FROM clause, e.g. SELECT 1.
+ if len(sel.From) == 0 {
+ return
+ }
+
+ if sel.Where == nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementNoWhere.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" requires WHERE clause", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(sel.Loc))),
+ })
+ }
+
+ // Check subqueries in WHERE, FROM, and target list.
+ // We inspect each subtree individually (not the whole SelectStmt) to avoid
+ // recursing into the SelectStmt itself, which checkSelectStmt already handles.
+ var subtrees []ast.Node
+ subtrees = append(subtrees, sel.Where)
+ for _, from := range sel.From {
+ subtrees = append(subtrees, from)
+ }
+ for _, target := range sel.TargetList {
+ subtrees = append(subtrees, target)
+ }
+ for _, subtree := range subtrees {
+ ast.Inspect(subtree, func(n ast.Node) bool {
+ if sub, ok := n.(*ast.SelectStmt); ok {
+ r.checkSelectStmt(sub, text)
+ return false
+ }
+ return true
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_update_delete.go b/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_update_delete.go
new file mode 100644
index 0000000000..26829f801d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_stmt_where_requirement_for_update_delete.go
@@ -0,0 +1,78 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*WhereRequirementForUpdateDeleteAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, &WhereRequirementForUpdateDeleteAdvisor{})
+}
+
+// WhereRequirementForUpdateDeleteAdvisor is the advisor checking for the WHERE clause requirement for UPDATE/DELETE statements.
+type WhereRequirementForUpdateDeleteAdvisor struct {
+}
+
+// Check checks for the WHERE clause requirement.
+func (*WhereRequirementForUpdateDeleteAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &whereRequirementForUpdateDeleteOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type whereRequirementForUpdateDeleteOmniRule struct {
+ OmniBaseRule
+}
+
+func (*whereRequirementForUpdateDeleteOmniRule) Name() string {
+ return "WhereRequirementForUpdateDeleteRule"
+}
+
+func (r *whereRequirementForUpdateDeleteOmniRule) OnStatement(node ast.Node) {
+ text := strings.TrimSpace(r.StmtText)
+ switch n := node.(type) {
+ case *ast.DeleteStmt:
+ if n.Where == nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementNoWhere.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" requires WHERE clause", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+ }
+ case *ast.UpdateStmt:
+ if n.Where == nil {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.StatementNoWhere.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("\"%s\" requires WHERE clause", text),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.ContentStartLine())),
+ })
+ }
+ default:
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_table_comment_convention.go b/backend/plugin/advisor/oceanbase/rule_table_comment_convention.go
new file mode 100644
index 0000000000..68eebc65ac
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_table_comment_convention.go
@@ -0,0 +1,97 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*TableCommentConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_COMMENT, &TableCommentConventionAdvisor{})
+}
+
+// TableCommentConventionAdvisor is the advisor checking for table comment convention.
+type TableCommentConventionAdvisor struct {
+}
+
+// Check checks for table comment convention.
+func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ commentPayload := checkCtx.Rule.GetCommentConventionPayload()
+
+ rule := &tableCommentConventionOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ payload: commentPayload,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type tableCommentConventionOmniRule struct {
+ OmniBaseRule
+ payload *storepb.SQLReviewRule_CommentConventionRulePayload
+}
+
+func (*tableCommentConventionOmniRule) Name() string {
+ return "TableCommentConventionRule"
+}
+
+func (r *tableCommentConventionOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.CreateTableStmt)
+ if !ok {
+ return
+ }
+ r.checkCreateTable(n)
+}
+
+func (r *tableCommentConventionOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+
+ comment := omniTableOptionValue(n.Options, "COMMENT")
+ exists := comment != ""
+ // Check if any COMMENT option exists (even empty string).
+ for _, opt := range n.Options {
+ if opt != nil && opt.Name == "COMMENT" {
+ exists = true
+ break
+ }
+ }
+
+ if r.payload.Required && !exists {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CommentEmpty.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table `%s` requires comments", tableName),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+ if r.payload.MaxLength >= 0 && int32(len(comment)) > r.payload.MaxLength {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.CommentTooLong.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("The length of table `%s` comment should be within %d characters", tableName, r.payload.MaxLength),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_table_disallow_partition.go b/backend/plugin/advisor/oceanbase/rule_table_disallow_partition.go
new file mode 100644
index 0000000000..d2e1e0740f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_table_disallow_partition.go
@@ -0,0 +1,90 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ advisorcode "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*TableDisallowPartitionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_DISALLOW_PARTITION, &TableDisallowPartitionAdvisor{})
+}
+
+// TableDisallowPartitionAdvisor is the advisor checking for disallow table partition.
+type TableDisallowPartitionAdvisor struct {
+}
+
+// Check checks for disallow table partition.
+func (*TableDisallowPartitionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &tableDisallowPartitionOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type tableDisallowPartitionOmniRule struct {
+ OmniBaseRule
+}
+
+func (*tableDisallowPartitionOmniRule) Name() string {
+ return "TableDisallowPartitionRule"
+}
+
+func (r *tableDisallowPartitionOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *tableDisallowPartitionOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Partitions != nil {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: advisorcode.CreateTablePartition.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table partition is forbidden, but \"%s\" creates", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ }
+}
+
+func (r *tableDisallowPartitionOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ if cmd.Type == ast.ATPartitionBy && cmd.PartitionBy != nil {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: advisorcode.CreateTablePartition.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table partition is forbidden, but \"%s\" creates", r.QueryText()),
+ StartPosition: base.ConvertANTLRLineToPosition(int(r.ContentStartLine())),
+ })
+ return
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_table_drop_naming_convention.go b/backend/plugin/advisor/oceanbase/rule_table_drop_naming_convention.go
new file mode 100644
index 0000000000..e3cd72de92
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_table_drop_naming_convention.go
@@ -0,0 +1,82 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "regexp"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*TableDropNamingConventionAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_DROP_NAMING_CONVENTION, &TableDropNamingConventionAdvisor{})
+}
+
+// TableDropNamingConventionAdvisor is the advisor checking the MySQLTableDropNamingConvention rule.
+type TableDropNamingConventionAdvisor struct {
+}
+
+// Check checks for drop table naming convention.
+func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+ 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, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
+ }
+
+ rule := &tableDropNamingConventionOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ format: format,
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type tableDropNamingConventionOmniRule struct {
+ OmniBaseRule
+ format *regexp.Regexp
+}
+
+func (*tableDropNamingConventionOmniRule) Name() string {
+ return "TableDropNamingConventionRule"
+}
+
+func (r *tableDropNamingConventionOmniRule) OnStatement(node ast.Node) {
+ n, ok := node.(*ast.DropTableStmt)
+ if !ok {
+ return
+ }
+ for _, tbl := range n.Tables {
+ if !r.format.MatchString(tbl.Name) {
+ absoluteLine := r.BaseLine + int(r.LocToLine(n.Loc))
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.TableDropNamingConventionMismatch.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("`%s` mismatches drop table naming convention, naming format should be %q", tbl.Name, r.format),
+ StartPosition: base.ConvertANTLRLineToPosition(absoluteLine),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_table_no_fk.go b/backend/plugin/advisor/oceanbase/rule_table_no_fk.go
new file mode 100644
index 0000000000..454527f85e
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_table_no_fk.go
@@ -0,0 +1,99 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+var (
+ _ advisor.Advisor = (*TableNoFKAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_NO_FOREIGN_KEY, &TableNoFKAdvisor{})
+}
+
+// TableNoFKAdvisor is the advisor checking table disallow foreign key.
+type TableNoFKAdvisor struct {
+}
+
+// Check checks table disallow foreign key.
+func (*TableNoFKAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &tableNoFKOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ }
+
+ return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
+}
+
+type tableNoFKOmniRule struct {
+ OmniBaseRule
+}
+
+func (*tableNoFKOmniRule) Name() string {
+ return "TableNoFKRule"
+}
+
+func (r *tableNoFKOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *tableNoFKOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, constraint := range n.Constraints {
+ if constraint.Type == ast.ConstrForeignKey {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.TableHasFK.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Foreign key is not allowed in the table `%s`", tableName),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(constraint.Loc))),
+ })
+ }
+ }
+}
+
+func (r *tableNoFKOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ if cmd.Type == ast.ATAddConstraint && cmd.Constraint != nil && cmd.Constraint.Type == ast.ConstrForeignKey {
+ r.AddAdvice(&storepb.Advice{
+ Status: r.Level,
+ Code: code.TableHasFK.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Foreign key is not allowed in the table `%s`", tableName),
+ StartPosition: base.ConvertANTLRLineToPosition(r.BaseLine + int(r.LocToLine(cmd.Constraint.Loc))),
+ })
+ }
+ }
+}
diff --git a/backend/plugin/advisor/oceanbase/rule_table_require_pk.go b/backend/plugin/advisor/oceanbase/rule_table_require_pk.go
new file mode 100644
index 0000000000..6d0bd1ab1b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/rule_table_require_pk.go
@@ -0,0 +1,235 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/advisor"
+ "github.com/bytebase/bytebase/backend/plugin/advisor/code"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+const (
+ primaryKeyName = "PRIMARY"
+)
+
+var (
+ _ advisor.Advisor = (*TableRequirePKAdvisor)(nil)
+)
+
+func init() {
+ advisor.Register(storepb.Engine_OCEANBASE, storepb.SQLReviewRule_TABLE_REQUIRE_PK, &TableRequirePKAdvisor{})
+}
+
+// TableRequirePKAdvisor is the advisor checking table requires PK.
+type TableRequirePKAdvisor struct {
+}
+
+// Check checks table requires PK.
+func (*TableRequirePKAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
+ level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
+ if err != nil {
+ return nil, err
+ }
+
+ rule := &tableRequirePKOmniRule{
+ OmniBaseRule: OmniBaseRule{
+ Level: level,
+ Title: checkCtx.Rule.Type.String(),
+ },
+ tables: make(map[string]columnSet),
+ line: make(map[string]int),
+ originalMetadata: checkCtx.OriginalMetadata,
+ }
+
+ // Walk all statements.
+ RunRules(checkCtx.ParsedStatements, []OmniRule{rule})
+
+ // Generate advice after walking all statements.
+ rule.generateAdviceList()
+
+ return rule.GetAdviceList(), nil
+}
+
+type tableRequirePKOmniRule struct {
+ OmniBaseRule
+ tables map[string]columnSet
+ line map[string]int
+ originalMetadata *model.DatabaseMetadata
+}
+
+func (*tableRequirePKOmniRule) Name() string {
+ return "TableRequirePKRule"
+}
+
+func (r *tableRequirePKOmniRule) OnStatement(node ast.Node) {
+ switch n := node.(type) {
+ case *ast.CreateTableStmt:
+ r.checkCreateTable(n)
+ case *ast.DropTableStmt:
+ r.checkDropTable(n)
+ case *ast.AlterTableStmt:
+ r.checkAlterTable(n)
+ default:
+ }
+}
+
+func (r *tableRequirePKOmniRule) checkCreateTable(n *ast.CreateTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ r.initEmptyTable(tableName)
+ r.line[tableName] = r.BaseLine + int(r.LocToLine(n.Loc))
+
+ // Check column-level PRIMARY KEY.
+ for _, col := range n.Columns {
+ if col == nil {
+ continue
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.tables[tableName] = newColumnSet([]string{col.Name})
+ }
+ }
+ }
+
+ // Check table-level PRIMARY KEY constraint.
+ for _, constraint := range n.Constraints {
+ if constraint.Type == ast.ConstrPrimaryKey {
+ r.tables[tableName] = newColumnSet(constraint.Columns)
+ }
+ }
+}
+
+func (r *tableRequirePKOmniRule) checkDropTable(n *ast.DropTableStmt) {
+ for _, ref := range n.Tables {
+ if ref != nil {
+ delete(r.tables, ref.Name)
+ }
+ }
+}
+
+func (r *tableRequirePKOmniRule) checkAlterTable(n *ast.AlterTableStmt) {
+ if n.Table == nil {
+ return
+ }
+ tableName := n.Table.Name
+ lineNumber := r.BaseLine + int(r.LocToLine(n.Loc))
+
+ for _, cmd := range n.Commands {
+ if cmd == nil {
+ continue
+ }
+ switch cmd.Type {
+ case ast.ATAddConstraint:
+ if cmd.Constraint != nil && cmd.Constraint.Type == ast.ConstrPrimaryKey {
+ r.tables[tableName] = newColumnSet(cmd.Constraint.Columns)
+ }
+ case ast.ATDropConstraint:
+ // DROP PRIMARY KEY
+ if strings.EqualFold(cmd.Name, primaryKeyName) || cmd.Name == "" {
+ // cmd.Name == "" when it's DROP PRIMARY KEY (no explicit constraint name)
+ r.initEmptyTable(tableName)
+ r.line[tableName] = lineNumber
+ }
+ case ast.ATDropIndex:
+ if strings.EqualFold(cmd.Name, primaryKeyName) {
+ r.initEmptyTable(tableName)
+ r.line[tableName] = lineNumber
+ }
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ r.handleColumnDef(tableName, cmd.Column)
+ }
+ for _, col := range cmd.Columns {
+ r.handleColumnDef(tableName, col)
+ }
+ case ast.ATChangeColumn:
+ if cmd.Column != nil {
+ oldColumn := cmd.Name
+ newColumn := cmd.Column.Name
+ if r.changeColumn(tableName, oldColumn, newColumn) {
+ r.line[tableName] = lineNumber
+ }
+ r.handleColumnDef(tableName, cmd.Column)
+ }
+ case ast.ATModifyColumn:
+ if cmd.Column != nil {
+ r.handleColumnDef(tableName, cmd.Column)
+ }
+ case ast.ATDropColumn:
+ if r.dropColumn(tableName, cmd.Name) {
+ r.line[tableName] = lineNumber
+ }
+ default:
+ }
+ }
+}
+
+func (r *tableRequirePKOmniRule) handleColumnDef(tableName string, col *ast.ColumnDef) {
+ if col == nil {
+ return
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ r.tables[tableName] = newColumnSet([]string{col.Name})
+ }
+ }
+}
+
+func (r *tableRequirePKOmniRule) generateAdviceList() {
+ tableList := r.getTableList()
+ for _, tableName := range tableList {
+ if len(r.tables[tableName]) == 0 {
+ r.AddAdviceAbsolute(&storepb.Advice{
+ Status: r.Level,
+ Code: code.TableNoPK.Int32(),
+ Title: r.Title,
+ Content: fmt.Sprintf("Table `%s` requires PRIMARY KEY", tableName),
+ StartPosition: base.ConvertANTLRLineToPosition(r.line[tableName]),
+ })
+ }
+ }
+}
+
+func (r *tableRequirePKOmniRule) changeColumn(tableName string, oldColumn string, newColumn string) bool {
+ if r.dropColumn(tableName, oldColumn) {
+ pk := r.tables[tableName]
+ pk[newColumn] = true
+ return true
+ }
+ return false
+}
+
+func (r *tableRequirePKOmniRule) dropColumn(tableName string, colName string) bool {
+ if _, ok := r.tables[tableName]; !ok {
+ pk := r.originalMetadata.GetSchemaMetadata("").GetTable(tableName).GetIndex(primaryKeyName)
+ if pk == nil {
+ return false
+ }
+ r.tables[tableName] = newColumnSet(pk.GetProto().GetExpressions())
+ }
+
+ pk := r.tables[tableName]
+ _, columnInPk := pk[colName]
+ delete(r.tables[tableName], colName)
+ return columnInPk
+}
+
+func (r *tableRequirePKOmniRule) initEmptyTable(name string) {
+ r.tables[name] = make(columnSet)
+}
+
+func (r *tableRequirePKOmniRule) getTableList() []string {
+ var tableList []string
+ for tableName := range r.tables {
+ tableList = append(tableList, tableName)
+ }
+ return tableList
+}
diff --git a/backend/plugin/advisor/oceanbase/test/column_auto_increment_initial_value.yaml b/backend/plugin/advisor/oceanbase/test/column_auto_increment_initial_value.yaml
new file mode 100644
index 0000000000..5ad47f0c8b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_auto_increment_initial_value.yaml
@@ -0,0 +1,28 @@
+- statement: CREATE TABLE t(a int);
+- statement: CREATE TABLE t(a int auto_increment) auto_increment = 20;
+- statement: |-
+ CREATE TABLE t1(a int auto_increment) auto_increment = 20;
+ CREATE TABLE t2(a int auto_increment) auto_increment = 2;
+ want:
+ - status: 2
+ code: 416
+ title: COLUMN_AUTO_INCREMENT_INITIAL_VALUE
+ content: The initial auto-increment value in table `t2` is 2, which doesn't equal 20
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int auto_increment) auto_increment = 20;
+ ALTER TABLE t COMMENT 'table t';
+ ALTER TABLE t AUTO_INCREMENT = 20;
+ ALTER TABLE t AUTO_INCREMENT = 100;
+ want:
+ - status: 2
+ code: 416
+ title: COLUMN_AUTO_INCREMENT_INITIAL_VALUE
+ content: The initial auto-increment value in table `t` is 100, which doesn't equal 20
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_integer.yaml b/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_integer.yaml
new file mode 100644
index 0000000000..bd3e31258b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_integer.yaml
@@ -0,0 +1,84 @@
+- statement: |-
+ CREATE TABLE t1(a INT AUTO_INCREMENT);
+ CREATE TABLE t2(a int AUTO_INCREMENT);
+ CREATE TABLE t3(a INTEGER AUTO_INCREMENT);
+ CREATE TABLE t4(a integer AUTO_INCREMENT);
+ CREATE TABLE t5(a TINYINT AUTO_INCREMENT);
+ CREATE TABLE t6(a tinyint AUTO_INCREMENT);
+ CREATE TABLE t7(a mediumint AUTO_INCREMENT);
+ CREATE TABLE t8(a MEDIUMINT AUTO_INCREMENT);
+ CREATE TABLE t9(a bigint AUTO_INCREMENT);
+ CREATE TABLE t10(a BIGINT AUTO_INCREMENT);
+- statement: |-
+ CREATE TABLE t1(a INT AUTO_INCREMENT);
+ CREATE TABLE t2(a varchar(255) AUTO_INCREMENT);
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t2`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a varchar(255) AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a varchar(255) AUTO_INCREMENT, ADD COLUMN c INT;
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN (a varchar(255) AUTO_INCREMENT, c INT);
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int);
+ ALTER TABLE t MODIFY COLUMN a varchar(255) AUTO_INCREMENT;
+ ALTER TABLE t MODIFY COLUMN b varchar(255);
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t CHANGE COLUMN b a varchar(255) AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 410
+ title: COLUMN_AUTO_INCREMENT_MUST_INTEGER
+ content: Auto-increment column `t`.`a` requires integer type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_unsigned.yaml b/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_unsigned.yaml
new file mode 100644
index 0000000000..fd98cb06d8
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_auto_increment_must_unsigned.yaml
@@ -0,0 +1,60 @@
+- statement: CREATE TABLE t(a INT UNSIGNED AUTO_INCREMENT);
+- statement: CREATE TABLE t(a INT AUTO_INCREMENT);
+ want:
+ - status: 2
+ code: 417
+ title: COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
+ content: Auto-increment column `t`.`a` is not UNSIGNED type
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(a INT SIGNED AUTO_INCREMENT);
+ want:
+ - status: 2
+ code: 417
+ title: COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
+ content: Auto-increment column `t`.`a` is not UNSIGNED type
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(a INT ZEROFILL AUTO_INCREMENT);
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a INT AUTO_INCREMENT, ADD COLUMN c INT ZEROFILL AUTO_INCREMENT, ADD COLUMN d INT UNSIGNED AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 417
+ title: COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
+ content: Auto-increment column `t`.`a` is not UNSIGNED type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int);
+ ALTER TABLE t MODIFY COLUMN a INT AUTO_INCREMENT;
+ ALTER TABLE t MODIFY COLUMN a INT UNSIGNED AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 417
+ title: COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
+ content: Auto-increment column `t`.`a` is not UNSIGNED type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t CHANGE COLUMN b a INT AUTO_INCREMENT;
+ ALTER TABLE t CHANGE COLUMN a c INT UNSIGNED AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 417
+ title: COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
+ content: Auto-increment column `t`.`a` is not UNSIGNED type
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_comment.yaml b/backend/plugin/advisor/oceanbase/test/column_comment.yaml
new file mode 100644
index 0000000000..e3455ef4be
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_comment.yaml
@@ -0,0 +1,227 @@
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `userTable`.`id` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `userTable`.`name` requires comments
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `userTable`.`roomId` requires comments
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: CREATE TABLE t(a int COMMENT 'comments');
+- statement: |-
+ CREATE TABLE t(
+ a int COMMENT 'some comments',
+ b int,
+ c int
+ );
+ want:
+ - status: 2
+ code: 1301
+ title: COLUMN_COMMENT
+ content: The length of column `t`.`a` comment should be within 10 characters
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`c` requires comments
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int COMMENT 'comment');
+ ALTER TABLE t ADD COLUMN b int;
+ want:
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int COMMENT 'comment');
+ ALTER TABLE t ADD COLUMN (b int, c int);
+ want:
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`c` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int COMMENT 'this is comment');
+ ALTER TABLE t CHANGE COLUMN a b int;
+ want:
+ - status: 2
+ code: 1301
+ title: COLUMN_COMMENT
+ content: The length of column `t`.`a` comment should be within 10 characters
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int COMMENT 'It is comment');
+ ALTER TABLE t MODIFY COLUMN b int;
+ want:
+ - status: 2
+ code: 1301
+ title: COLUMN_COMMENT
+ content: The length of column `t`.`b` comment should be within 10 characters
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int COMMENT 'It is COMMENT');
+ ALTER TABLE t MODIFY COLUMN b int COMMENT 'abcdefghiakljhakljdsfalugelkhnabsdguelkadf';
+ want:
+ - status: 2
+ code: 1301
+ title: COLUMN_COMMENT
+ content: The length of column `t`.`b` comment should be within 10 characters
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1301
+ title: COLUMN_COMMENT
+ content: The length of column `t`.`b` comment should be within 10 characters
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE users (
+ id INT AUTO_INCREMENT PRIMARY KEY COMMENT 'ID',
+ first_name VARCHAR(60) NOT NULL COMMENT 'First',
+ last_name VARCHAR(60) NOT NULL COMMENT 'Last',
+ full_name VARCHAR(120) GENERATED ALWAYS AS (CONCAT(first_name, ' ', last_name)) VIRTUAL COMMENT 'Full'
+ );
+- statement: |-
+ CREATE TABLE t(
+ a int COMMENT 'comment',
+ b int GENERATED ALWAYS AS (a * 2) VIRTUAL COMMENT 'comment'
+ );
+- statement: |-
+ CREATE TABLE t(
+ a int COMMENT 'comment',
+ b int GENERATED ALWAYS AS (a * 2) STORED COMMENT 'comment'
+ );
+- statement: |-
+ CREATE TABLE t(
+ a int COMMENT 'comment',
+ b int GENERATED ALWAYS AS (a * 2) VIRTUAL
+ );
+ want:
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(
+ a int,
+ b int GENERATED ALWAYS AS (a * 2) VIRTUAL
+ );
+ want:
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`a` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 1032
+ title: COLUMN_COMMENT
+ content: Column `t`.`b` requires comments
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_current_time_count_limit.yaml b/backend/plugin/advisor/oceanbase/test/column_current_time_count_limit.yaml
new file mode 100644
index 0000000000..7a305fd4bf
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_current_time_count_limit.yaml
@@ -0,0 +1,76 @@
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 419
+ title: COLUMN_CURRENT_TIME_COUNT_LIMIT
+ content: Table `userTable` has 2 ON UPDATE CURRENT_TIMESTAMP() columns. The count greater than 1.
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: CREATE TABLE t(a timestamp, b timestamp)
+- statement: |-
+ CREATE TABLE t(
+ a timestamp default now(),
+ b timestamp default current_timestamp(),
+ c timestamp default localtime
+ );
+ want:
+ - status: 2
+ code: 418
+ title: COLUMN_CURRENT_TIME_COUNT_LIMIT
+ content: Table `t` has 3 DEFAULT CURRENT_TIMESTAMP() columns. The count greater than 2.
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(
+ a timestamp default now() on update localtime,
+ b timestamp default current_timestamp() on update localtimestamp()
+ );
+ want:
+ - status: 2
+ code: 419
+ title: COLUMN_CURRENT_TIME_COUNT_LIMIT
+ content: Table `t` has 2 ON UPDATE CURRENT_TIMESTAMP() columns. The count greater than 1.
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a timestamp default now() on update localtime;
+ ALTER TABLE tech_book ADD COLUMN b timestamp default current_timestamp() on update localtimestamp();
+ want:
+ - status: 2
+ code: 419
+ title: COLUMN_CURRENT_TIME_COUNT_LIMIT
+ content: Table `tech_book` has 2 ON UPDATE CURRENT_TIMESTAMP() columns. The count greater than 1.
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_disallow_change.yaml b/backend/plugin/advisor/oceanbase/test/column_disallow_change.yaml
new file mode 100644
index 0000000000..260d315cbd
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_disallow_change.yaml
@@ -0,0 +1,15 @@
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a int;
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t CHANGE COLUMN b a int;
+ want:
+ - status: 2
+ code: 406
+ title: COLUMN_DISALLOW_CHANGE
+ content: '"ALTER TABLE t CHANGE COLUMN b a int;" contains CHANGE COLUMN statement'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_disallow_change_type.yaml b/backend/plugin/advisor/oceanbase/test/column_disallow_change_type.yaml
new file mode 100644
index 0000000000..62356a8df0
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_disallow_change_type.yaml
@@ -0,0 +1,56 @@
+- statement: |-
+ ALTER TABLE tech_book MODIFY id int;
+ ALTER TABLE tech_book MODIFY id INT;
+ ALTER TABLE tech_book MODIFY id INTEGER;
+ ALTER TABLE tech_book MODIFY id INTEGER UNSIGNED;
+ want:
+ - status: 2
+ code: 403
+ title: COLUMN_DISALLOW_CHANGE_TYPE
+ content: '"ALTER TABLE tech_book MODIFY id INTEGER UNSIGNED;" changes column type'
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book MODIFY id int;
+ ALTER TABLE tech_book MODIFY id int(4);
+ want:
+ - status: 2
+ code: 403
+ title: COLUMN_DISALLOW_CHANGE_TYPE
+ content: '"ALTER TABLE tech_book MODIFY id int(4);" changes column type'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book MODIFY id bigint;
+ ALTER TABLE tech_book MODIFY id smallint;
+ want:
+ - status: 2
+ code: 403
+ title: COLUMN_DISALLOW_CHANGE_TYPE
+ content: '"ALTER TABLE tech_book MODIFY id bigint;" changes column type'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 403
+ title: COLUMN_DISALLOW_CHANGE_TYPE
+ content: '"ALTER TABLE tech_book MODIFY id smallint;" changes column type'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book CHANGE name uname varchar(20);
+ want:
+ - status: 2
+ code: 403
+ title: COLUMN_DISALLOW_CHANGE_TYPE
+ content: '"ALTER TABLE tech_book CHANGE name uname varchar(20);" changes column type'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_disallow_changing_order.yaml b/backend/plugin/advisor/oceanbase/test/column_disallow_changing_order.yaml
new file mode 100644
index 0000000000..00da817b2d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_disallow_changing_order.yaml
@@ -0,0 +1,51 @@
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t MODIFY COLUMN a int;
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t MODIFY COLUMN a int FIRST;
+ want:
+ - status: 2
+ code: 407
+ title: COLUMN_DISALLOW_CHANGING_ORDER
+ content: '"ALTER TABLE t MODIFY COLUMN a int FIRST;" changes column order'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int, a1 int);
+ ALTER TABLE t CHANGE COLUMN a1 a int FIRST;
+ want:
+ - status: 2
+ code: 407
+ title: COLUMN_DISALLOW_CHANGING_ORDER
+ content: '"ALTER TABLE t CHANGE COLUMN a1 a int FIRST;" changes column order'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int);
+ ALTER TABLE t MODIFY COLUMN a int AFTER b;
+ want:
+ - status: 2
+ code: 407
+ title: COLUMN_DISALLOW_CHANGING_ORDER
+ content: '"ALTER TABLE t MODIFY COLUMN a int AFTER b;" changes column order'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a1 int, b int);
+ ALTER TABLE t CHANGE COLUMN a1 a int AFTER b;
+ want:
+ - status: 2
+ code: 407
+ title: COLUMN_DISALLOW_CHANGING_ORDER
+ content: '"ALTER TABLE t CHANGE COLUMN a1 a int AFTER b;" changes column order'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_disallow_drop_in_index.yaml b/backend/plugin/advisor/oceanbase/test/column_disallow_drop_in_index.yaml
new file mode 100644
index 0000000000..140f091c3b
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_disallow_drop_in_index.yaml
@@ -0,0 +1,77 @@
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: |-
+ CREATE TABLE t(a int, b int, INDEX idx_a(a));
+ ALTER TABLE t DROP COLUMN b;
+- statement: |-
+ CREATE TABLE t(a int, b int, INDEX idx_b(b));
+ ALTER TABLE t DROP COLUMN b;
+ want:
+ - status: 2
+ code: 424
+ title: COLUMN_DISALLOW_DROP_IN_INDEX
+ content: '`t`.`b` cannot drop index column'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, c int, INDEX idx_ac(a,c));
+ ALTER TABLE t DROP COLUMN c;
+ want:
+ - status: 2
+ code: 424
+ title: COLUMN_DISALLOW_DROP_IN_INDEX
+ content: '`t`.`c` cannot drop index column'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int, INDEX idx_a(a));
+ CREATE TABLE y(a int, b int);
+ ALTER TABLE y DROP COLUMN a;
+- statement: |-
+ CREATE TABLE t(a int,b int, c int, INDEX idx_ac(a,c));
+ ALTER TABLE t DROP COLUMN a;
+ ALTER TABLE t DROP COLUMN c;
+ want:
+ - status: 2
+ code: 424
+ title: COLUMN_DISALLOW_DROP_IN_INDEX
+ content: '`t`.`a` cannot drop index column'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 424
+ title: COLUMN_DISALLOW_DROP_IN_INDEX
+ content: '`t`.`c` cannot drop index column'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_disallow_set_charset.yaml b/backend/plugin/advisor/oceanbase/test/column_disallow_set_charset.yaml
new file mode 100644
index 0000000000..0a3128f32f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_disallow_set_charset.yaml
@@ -0,0 +1,89 @@
+- statement: |-
+ CREATE TABLE dt_relation_temp(objto int);
+ ALTER TABLE dt_relation_temp ADD COLUMN infos json null comment'关系信息点'AFTER`objto`;
+- statement: CREATE TABLE t(a varchar(20));
+- statement: |-
+ CREATE TABLE t1(a varchar(20) CHARSET ascii);
+ CREATE TABLE t2(a varchar(20) CHARSET ascii);
+ want:
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "CREATE TABLE t1(a varchar(20) CHARSET ascii);" does
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "CREATE TABLE t2(a varchar(20) CHARSET ascii);" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a varchar(20);
+ ALTER TABLE tech_book ADD COLUMN b varchar(20) CHARSET ascii;
+ want:
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book ADD COLUMN b varchar(20) CHARSET ascii;" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a varchar(20), ADD COLUMN b varchar(20);
+ ALTER TABLE tech_book ADD COLUMN (c varchar(20) CHARSET ascii, d varchar(20) CHARSET ascii);
+ ALTER TABLE tech_book ADD COLUMN e varchar(20) CHARSET ascii;
+ want:
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book ADD COLUMN (c varchar(20) CHARSET ascii, d varchar(20) CHARSET ascii);" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book ADD COLUMN (c varchar(20) CHARSET ascii, d varchar(20) CHARSET ascii);" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book ADD COLUMN e varchar(20) CHARSET ascii;" does
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book MODIFY COLUMN id int;
+ ALTER TABLE tech_book MODIFY COLUMN id varchar(20) CHARSET ascii;
+ want:
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book MODIFY COLUMN id varchar(20) CHARSET ascii;" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book CHANGE COLUMN name name int;
+ ALTER TABLE tech_book CHANGE COLUMN name name varchar(20) CHARSET ascii;
+ want:
+ - status: 2
+ code: 414
+ title: COLUMN_DISALLOW_SET_CHARSET
+ content: Disallow set column charset but "ALTER TABLE tech_book CHANGE COLUMN name name varchar(20) CHARSET ascii;" does
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_maximum_character_length.yaml b/backend/plugin/advisor/oceanbase/test/column_maximum_character_length.yaml
new file mode 100644
index 0000000000..e087779496
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_maximum_character_length.yaml
@@ -0,0 +1,51 @@
+- statement: CREATE TABLE t1(name char);
+- statement: CREATE TABLE t(name char(20));
+- statement: CREATE TABLE t(name varchar(225));
+- statement: |-
+ CREATE TABLE t1(name char(20));
+ CREATE TABLE t2(name char(225));
+ want:
+ - status: 2
+ code: 415
+ title: COLUMN_MAXIMUM_CHARACTER_LENGTH
+ content: The length of the CHAR column `t2.name` is bigger than 20, please use VARCHAR instead
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN name_1 char(20);
+ ALTER TABLE tech_book ADD COLUMN name_2 char(225);
+ want:
+ - status: 2
+ code: 415
+ title: COLUMN_MAXIMUM_CHARACTER_LENGTH
+ content: The length of the CHAR column `tech_book.name_2` is bigger than 20, please use VARCHAR instead
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book CHANGE COLUMN name name char(20);
+ ALTER TABLE tech_book CHANGE COLUMN name name char(225);
+ want:
+ - status: 2
+ code: 415
+ title: COLUMN_MAXIMUM_CHARACTER_LENGTH
+ content: The length of the CHAR column `tech_book.name` is bigger than 20, please use VARCHAR instead
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book MODIFY COLUMN name char(20);
+ ALTER TABLE tech_book MODIFY COLUMN name char(225);
+ want:
+ - status: 2
+ code: 415
+ title: COLUMN_MAXIMUM_CHARACTER_LENGTH
+ content: The length of the CHAR column `tech_book.name` is bigger than 20, please use VARCHAR instead
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_maximum_varchar_length.yaml b/backend/plugin/advisor/oceanbase/test/column_maximum_varchar_length.yaml
new file mode 100644
index 0000000000..6946f51838
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_maximum_varchar_length.yaml
@@ -0,0 +1,23 @@
+- statement: CREATE TABLE t(name varchar(225));
+- statement: CREATE TABLE t1(name varchar(3000));
+ want:
+ - status: 2
+ code: 422
+ title: COLUMN_MAXIMUM_VARCHAR_LENGTH
+ content: The length of the VARCHAR column `t1.name` is bigger than 2560
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN name_1 char(20);
+ ALTER TABLE tech_book ADD COLUMN name_2 varchar(3000);
+ want:
+ - status: 2
+ code: 422
+ title: COLUMN_MAXIMUM_VARCHAR_LENGTH
+ content: The length of the VARCHAR column `tech_book.name_2` is bigger than 2560
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/column_no_null.yaml b/backend/plugin/advisor/oceanbase/test/column_no_null.yaml
new file mode 100644
index 0000000000..f8b88bf310
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_no_null.yaml
@@ -0,0 +1,88 @@
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ name varchar(255)
+ );
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`id` cannot have NULL value'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`name` cannot have NULL value'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id int PRIMARY KEY, name varchar(255));
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`name` cannot have NULL value'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id int NOT NULL, name varchar(255));
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`name` cannot have NULL value'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id int PRIMARY KEY, name varchar(255) NOT NULL);
+- statement: |-
+ CREATE TABLE book(a int NOT NULL);
+ ALTER TABLE book ADD COLUMN (id int, name varchar(255) NOT NULL);
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`id` cannot have NULL value'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(a int NOT NULL);
+ ALTER TABLE book ADD COLUMN id int, ADD COLUMN name varchar(255) NOT NULL;
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`id` cannot have NULL value'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(a int NOT NULL);
+ ALTER TABLE book ADD COLUMN (id int PRIMARY KEY, name varchar(255) NOT NULL);
+- statement: |-
+ CREATE TABLE book(a int NOT NULL);
+ ALTER TABLE book ADD COLUMN id int PRIMARY KEY, ADD COLUMN name varchar(255) NOT NULL;
+- statement: |-
+ CREATE TABLE book(id int NOT NULL);
+ ALTER TABLE book CHANGE COLUMN id name varchar(255);
+ want:
+ - status: 2
+ code: 402
+ title: COLUMN_NO_NULL
+ content: '`book`.`name` cannot have NULL value'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(id int NOT NULL);
+ ALTER TABLE book CHANGE COLUMN id name varchar(255) NOT NULL;
diff --git a/backend/plugin/advisor/oceanbase/test/column_require_default.yaml b/backend/plugin/advisor/oceanbase/test/column_require_default.yaml
new file mode 100644
index 0000000000..22eae3c651
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_require_default.yaml
@@ -0,0 +1,105 @@
+- statement: |-
+ CREATE TABLE t(
+ a bigint(20) unsigned not null,
+ b varchar(50) not null unique,
+ primary key (a)
+ );
+ want:
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `t`.`b` doesn't have DEFAULT.
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(
+ a int auto_increment primary key,
+ b int default 1,
+ c varchar(255) default 'default value',
+ d blob,
+ e json,
+ f geometry
+ );
+- statement: |-
+ CREATE TABLE t(
+ a geometry,
+ b point,
+ c linestring,
+ d polygon,
+ e multipoint,
+ f multilinestring,
+ g multipolygon,
+ h geometrycollection
+ );
+- statement: |-
+ CREATE TABLE t1(
+ a int primary key
+ );
+ CREATE TABLE t2(
+ a int auto_increment primary key
+ );
+- statement: |-
+ CREATE TABLE t(
+ a int,
+ b int default 1
+ )
+ want:
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `t`.`a` doesn't have DEFAULT.
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a BLOB;
+ ALTER TABLE tech_book ADD COLUMN b timestamp;
+ ALTER TABLE tech_book MODIFY COLUMN a varchar(220);
+ want:
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `tech_book`.`b` doesn't have DEFAULT.
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `tech_book`.`a` doesn't have DEFAULT.
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD COLUMN (a BLOB, b timestamp);
+ want:
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `tech_book`.`b` doesn't have DEFAULT.
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a VARCHAR(255) DEFAULT 'default value';
+ ALTER TABLE tech_book MODIFY COLUMN a char(25) DEFAULT 'default';
+ ALTER TABLE tech_book CHANGE COLUMN a b int;
+ want:
+ - status: 2
+ code: 420
+ title: COLUMN_REQUIRE_DEFAULT
+ content: Column `tech_book`.`b` doesn't have DEFAULT.
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(
+ id int,
+ PRIMARY KEY (id)
+ )
diff --git a/backend/plugin/advisor/oceanbase/test/column_required.yaml b/backend/plugin/advisor/oceanbase/test/column_required.yaml
new file mode 100644
index 0000000000..358bdb28af
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_required.yaml
@@ -0,0 +1,212 @@
+- statement: |-
+ CREATE TABLE t1(a INT);
+ CREATE TABLE book(id int);
+ CREATE TABLE t2(id INT, creator_id INT);
+ CREATE TABLE t3(id INT, creator_id INT, created_ts timestamp);
+ CREATE TABLE t4(id INT, creator_id INT, created_ts timestamp, updater_id INT);
+ CREATE TABLE t5(id INT, creator_id INT, created_ts timestamp, updater_id INT, updated_ts timestamp);
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `t1` requires columns: created_ts, creator_id, id, updated_ts, updater_id'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: created_ts, creator_id, updated_ts, updater_id'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `t2` requires columns: created_ts, updated_ts, updater_id'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `t3` requires columns: updated_ts, updater_id'
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `t4` requires columns: updated_ts'
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book RENAME COLUMN creator_id TO creator;
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: creator_id'
+ startposition:
+ line: 8
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book RENAME COLUMN creator TO creator_id;
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book CHANGE COLUMN creator_id creator int;
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: creator_id'
+ startposition:
+ line: 8
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book CHANGE COLUMN creator creator_id int;
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book DROP COLUMN creator_id;
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: creator_id'
+ startposition:
+ line: 8
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp,
+ content varchar(255)
+ );
+ ALTER TABLE book DROP COLUMN content;
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updated_ts timestamp
+ );
+ ALTER TABLE book ADD COLUMN content varchar(255);
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: updater_id'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ ALTER TABLE book ADD COLUMN creator_id int;
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ CREATE TABLE student(
+ id int,
+ created_ts timestamp,
+ updated_ts timestamp
+ );
+ want:
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `book` requires columns: creator_id'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 401
+ title: COLUMN_REQUIRED
+ content: 'Table `student` requires columns: creator_id, updater_id'
+ startposition:
+ line: 7
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
+ DROP TABLE book;
+- statement: |-
+ CREATE TABLE book(
+ id int
+ );
+ ALTER TABLE book ADD COLUMN (
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp
+ );
diff --git a/backend/plugin/advisor/oceanbase/test/column_set_default_for_not_null.yaml b/backend/plugin/advisor/oceanbase/test/column_set_default_for_not_null.yaml
new file mode 100644
index 0000000000..a29bf44653
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_set_default_for_not_null.yaml
@@ -0,0 +1,109 @@
+- statement: |-
+ CREATE TABLE book(
+ id int PRIMARY KEY DEFAULT 0
+ );
+- statement: |-
+ CREATE TABLE book(
+ id int PRIMARY KEY
+ );
+- statement: |-
+ CREATE TABLE book(
+ id int NOT NULL
+ );
+ want:
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`id` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ PRIMARY KEY (id)
+ );
+- statement: |-
+ CREATE TABLE book(a int);
+ ALTER TABLE book ADD COLUMN id int PRIMARY KEY;
+- statement: |-
+ CREATE TABLE book(a int);
+ ALTER TABLE book ADD COLUMN id int NOT NULL;
+ want:
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`id` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(a int);
+ ALTER TABLE book ADD COLUMN (b int NOT NULL, c int NOT NULL);
+ want:
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`b` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`c` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(id int);
+ ALTER TABLE book MODIFY COLUMN id int NOT NULL;
+ want:
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`id` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(id int);
+ ALTER TABLE book MODIFY COLUMN id int PRIMARY KEY;
+- statement: |-
+ CREATE TABLE book(uid int);
+ ALTER TABLE book CHANGE COLUMN uid id int PRIMARY KEY;
+- statement: |-
+ CREATE TABLE book(uid int);
+ ALTER TABLE book CHANGE COLUMN uid id int NOT NULL;
+ want:
+ - status: 2
+ code: 404
+ title: COLUMN_SET_DEFAULT_FOR_NOT_NULL
+ content: Column `book`.`id` is NOT NULL but doesn't have DEFAULT
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(uid int, id int);
+ ALTER TABLE book CHANGE COLUMN uid uid int NOT NULL DEFAULT 0, MODIFY COLUMN id int PRIMARY KEY DEFAULT 0, ADD COLUMN name varchar(20) NOT NULL DEFAULT '';
+- statement: |-
+ create table all_types(
+ c1 tinyblob not null,
+ c2 blob not null,
+ c3 mediumblob not null,
+ c4 longblob not null,
+ c5 tinytext not null,
+ c6 text not null,
+ c7 mediumtext not null,
+ c8 longtext not null,
+ c9 json not null,
+ c10 serial not null,
+ c11 long varbinary not null,
+ c12 long varchar not null
+ );
diff --git a/backend/plugin/advisor/oceanbase/test/column_type_disallow_list.yaml b/backend/plugin/advisor/oceanbase/test/column_type_disallow_list.yaml
new file mode 100644
index 0000000000..bdea97107d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/column_type_disallow_list.yaml
@@ -0,0 +1,67 @@
+- statement: CREATE TABLE t(a int);
+- statement: CREATE TABLE t(a JSON, b BLOB, c TEXT);
+ want:
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`a` is
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(d int);
+ ALTER TABLE t add COLUMN (a JSON, b BLOB, c TEXT);
+ want:
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`a` is
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(d int);
+ ALTER TABLE t ADD COLUMN (a JSON, b JSON);
+ want:
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`a` is
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`b` is
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(c int, b int);
+ ALTER TABLE t CHANGE COLUMN c a JSON, MODIFY b BLOB;
+ want:
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`a` is
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(c int, b int);
+ ALTER TABLE t MODIFY COLUMN c JSON;
+ want:
+ - status: 2
+ code: 411
+ title: COLUMN_TYPE_DISALLOW_LIST
+ content: Disallow column type JSON but column `t`.`c` is
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/database_drop_empty_database.yaml b/backend/plugin/advisor/oceanbase/test/database_drop_empty_database.yaml
new file mode 100644
index 0000000000..e3258b1e3e
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/database_drop_empty_database.yaml
@@ -0,0 +1,10 @@
+- statement: DROP DATABASE IF EXISTS test;
+ want:
+ - status: 2
+ code: 701
+ title: DATABASE_DROP_EMPTY_DATABASE
+ content: Database `test` is not allowed to drop if not empty
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/index_key_number_limit.yaml b/backend/plugin/advisor/oceanbase/test/index_key_number_limit.yaml
new file mode 100644
index 0000000000..e47a751810
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_key_number_limit.yaml
@@ -0,0 +1,91 @@
+- statement: CREATE TABLE t(a int, b int, primary key (a, b));
+- statement: |-
+ CREATE TABLE t(
+ a int,
+ b int,
+ primary key pk (a, b, b, b, b, b, b),
+ unique key uk (a, b, b, b, b, b, b),
+ foreign key fk (a, b, b, b, b, b) references t1(a, b, b, b, b, b)
+ );
+ want:
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `pk` in table `t` should be not greater than 5
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `uk` in table `t` should be not greater than 5
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `fk` in table `t` should be not greater than 5
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int, c int, d int, e int, f int, g int);
+ CREATE INDEX idx ON t(a, b, c, d, e, f, g);
+ CREATE UNIQUE INDEX uk ON t(a, b, c, d, e, f, g);
+ want:
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `idx` in table `t` should be not greater than 5
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `uk` in table `t` should be not greater than 5
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int, c int, d int, e int, f int, g int);
+ ALTER TABLE t ADD PRIMARY KEY pk (a, b, c, d, e, f, g);
+ ALTER TABLE t ADD UNIQUE KEY uk (a, b, c, d, e, f, g);
+ want:
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `pk` in table `t` should be not greater than 5
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `uk` in table `t` should be not greater than 5
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b int, c int, d int, e int, f int, g int);
+ ALTER TABLE t ADD FOREIGN KEY uk (a, b, c, d, e, f, g) REFERENCES t1(a, b, c, d, e, f, g)
+ want:
+ - status: 2
+ code: 802
+ title: INDEX_KEY_NUMBER_LIMIT
+ content: The number of index `uk` in table `t` should be not greater than 5
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int, b varchar(255));
+ CREATE FULLTEXT INDEX idx ON t(b, b, b, b, b, b);
diff --git a/backend/plugin/advisor/oceanbase/test/index_no_duplicate_column.yaml b/backend/plugin/advisor/oceanbase/test/index_no_duplicate_column.yaml
new file mode 100644
index 0000000000..46a9a237fa
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_no_duplicate_column.yaml
@@ -0,0 +1,131 @@
+- statement: CREATE TABLE t (a int, PRIMARY KEY (a));
+- statement: |-
+ CREATE TABLE t (
+ a int,
+ PRIMARY KEY (a, a)
+ );
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: PRIMARY KEY `` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t1 (
+ a int,
+ PRIMARY KEY (a)
+ );
+ CREATE TABLE t2 (
+ a int,
+ FOREIGN KEY fk1 (a) REFERENCES t1(a)
+ );
+ CREATE TABLE t3 (
+ a int,
+ FOREIGN KEY fk1 (a, a) REFERENCES t1(a, a)
+ );
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: FOREIGN KEY `fk1` has duplicate column `t3`.`a`
+ startposition:
+ line: 11
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t (
+ a int,
+ INDEX idx_a (a, a)
+ );
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: INDEX `idx_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ CREATE INDEX idx ON t(a);
+ CREATE INDEX idx_a ON t(a, a);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: INDEX `idx_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ CREATE UNIQUE INDEX idx ON t(a);
+ CREATE UNIQUE INDEX idx_a ON t(a, a);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: UNIQUE INDEX `idx_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD INDEX idx (a);
+ ALTER TABLE t ADD INDEX idx_a (a, a);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: INDEX `idx_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD PRIMARY KEY pk_a (a, a);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: PRIMARY KEY `pk_a` has duplicate column `t`.`a`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD PRIMARY KEY pk_a (a);
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD UNIQUE KEY uk (a);
+ ALTER TABLE t ADD UNIQUE KEY uk_a (a, a);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: UNIQUE KEY `uk_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD FOREIGN KEY fk (a) REFERENCES t1(a);
+ ALTER TABLE t ADD FOREIGN KEY fk_a (a, a) REFERENCES t1(a, b);
+ want:
+ - status: 2
+ code: 812
+ title: INDEX_NO_DUPLICATE_COLUMN
+ content: FOREIGN KEY `fk_a` has duplicate column `t`.`a`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/index_pk_type_limit.yaml b/backend/plugin/advisor/oceanbase/test/index_pk_type_limit.yaml
new file mode 100644
index 0000000000..9c57a453fd
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_pk_type_limit.yaml
@@ -0,0 +1,162 @@
+- statement: CREATE TABLE t(id VARCHAR(5) PRIMARY KEY);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT PRIMARY KEY);
+- statement: CREATE TABLE t(id VARCHAR(5), PRIMARY KEY(id));
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT, id2 VARCHAR(5), id3 VARCHAR(5), PRIMARY KEY(id, id2, id3));
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id2` is varchar(5)
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id3` is varchar(5)
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT, id2 BIGINT, PRIMARY KEY(id, id2));
+- statement: CREATE TABLE t(id INT, PRIMARY KEY(id));
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT PRIMARY KEY;
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id VARCHAR(5), ADD PRIMARY KEY (id);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT, ADD COLUMN id2 VARCHAR(5), ADD COLUMN id3 VARCHAR(5), ADD PRIMARY KEY (id, id2, id3);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id2` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id3` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT, ADD COLUMN id2 BIGINT, ADD PRIMARY KEY (id, id2);
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id BIGINT, ADD PRIMARY KEY (id);
+- statement: |-
+ CREATE TABLE t(id VARCHAR(5));
+ ALTER TABLE t ADD PRIMARY KEY(id);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT, id2 VARCHAR(5), id3 VARCHAR(5));
+ ALTER TABLE t ADD PRIMARY KEY(id, id2, id3);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id2` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id3` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT, id2 BIGINT);
+ ALTER TABLE t ADD PRIMARY KEY(id, id2);
+- statement: |-
+ CREATE TABLE t(id BIGINT);
+ ALTER TABLE t ADD PRIMARY KEY(id);
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t MODIFY COLUMN id VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t MODIFY COLUMN id INT(5) PRIMARY KEY;
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t CHANGE COLUMN id id2 VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PK_TYPE_LIMIT
+ content: Columns in primary key must be INT/BIGINT but `t`.`id2` is varchar(5)
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t CHANGE COLUMN id id2 INT(5) PRIMARY KEY;
diff --git a/backend/plugin/advisor/oceanbase/test/index_primary_key_type_allowlist.yaml b/backend/plugin/advisor/oceanbase/test/index_primary_key_type_allowlist.yaml
new file mode 100644
index 0000000000..68c982ce7f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_primary_key_type_allowlist.yaml
@@ -0,0 +1,162 @@
+- statement: CREATE TABLE t(id VARCHAR(5) PRIMARY KEY);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT PRIMARY KEY);
+- statement: CREATE TABLE t(id VARCHAR(5), PRIMARY KEY(id));
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT, id2 VARCHAR(5), id3 VARCHAR(5), PRIMARY KEY(id, id2, id3));
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id2` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id3` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT, id2 BIGINT, PRIMARY KEY(id, id2));
+- statement: CREATE TABLE t(id INT, PRIMARY KEY(id));
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT PRIMARY KEY;
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id VARCHAR(5), ADD PRIMARY KEY (id);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT, ADD COLUMN id2 VARCHAR(5), ADD COLUMN id3 VARCHAR(5), ADD PRIMARY KEY (id, id2, id3);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id2` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id3` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id INT, ADD COLUMN id2 BIGINT, ADD PRIMARY KEY (id, id2);
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN id BIGINT, ADD PRIMARY KEY (id);
+- statement: |-
+ CREATE TABLE t(id VARCHAR(5));
+ ALTER TABLE t ADD PRIMARY KEY(id);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT, id2 VARCHAR(5), id3 VARCHAR(5));
+ ALTER TABLE t ADD PRIMARY KEY(id, id2, id3);
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id2` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id3` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT, id2 BIGINT);
+ ALTER TABLE t ADD PRIMARY KEY(id, id2);
+- statement: |-
+ CREATE TABLE t(id BIGINT);
+ ALTER TABLE t ADD PRIMARY KEY(id);
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t MODIFY COLUMN id VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t MODIFY COLUMN id INT(5) PRIMARY KEY;
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t CHANGE COLUMN id id2 VARCHAR(5) PRIMARY KEY;
+ want:
+ - status: 2
+ code: 803
+ title: INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
+ content: The column `id2` in table `t` is one of the primary key, but its type "varchar" is not in allowlist
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id int);
+ ALTER TABLE t CHANGE COLUMN id id2 INT(5) PRIMARY KEY;
diff --git a/backend/plugin/advisor/oceanbase/test/index_total_number_limit.yaml b/backend/plugin/advisor/oceanbase/test/index_total_number_limit.yaml
new file mode 100644
index 0000000000..52366e0316
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_total_number_limit.yaml
@@ -0,0 +1,72 @@
+- statement: CREATE TABLE t(a int, b int, c int, unique key(a, b, c));
+- statement: CREATE INDEX idx_id_name on tech_book(id, name);
+- statement: |-
+ CREATE INDEX idx_id_name_1 on tech_book(id, name);
+ CREATE INDEX idx_id_name_2 on tech_book(id, name);
+ CREATE INDEX idx_id_name_3 on tech_book(id, name);
+ CREATE INDEX idx_id_name_4 on tech_book(id, name);
+ CREATE INDEX idx_id_name_5 on tech_book(id, name);
+ want:
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table `tech_book` should be no more than 5, but found 8
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int PRIMARY KEY, b int, c int);
+ CREATE INDEX idx_a_b_1 on t(a, b);
+ CREATE INDEX idx_a_b_2 on t(a, b);
+ CREATE INDEX idx_a_b_3 on t(a, b);
+ CREATE INDEX idx_a_b_4 on t(a, b);
+ CREATE INDEX idx_a_b_5 on t(a, b);
+ want:
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table `t` should be no more than 5, but found 6
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(
+ a int PRIMARY KEY,
+ b int,
+ c int,
+ INDEX idx_a_b_1 (a, b),
+ INDEX idx_a_b_2 (a, b),
+ INDEX idx_a_b_3 (a, b),
+ INDEX idx_a_b_4 (a, b),
+ INDEX idx_a_b_5 (a, b));
+ want:
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table `t` should be no more than 5, but found 6
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t (
+ a int PRIMARY KEY,
+ b int,
+ c int
+ );
+ ALTER TABLE t ADD INDEX idx_a_b_1 (a, b);
+ ALTER TABLE t ADD INDEX idx_a_b_2 (a, b);
+ ALTER TABLE t ADD INDEX idx_a_b_3 (a, b);
+ ALTER TABLE t ADD INDEX idx_a_b_4 (a, b);
+ ALTER TABLE t ADD INDEX idx_a_b_5 (a, b);
+ want:
+ - status: 2
+ code: 813
+ title: INDEX_TOTAL_NUMBER_LIMIT
+ content: The count of index in table `t` should be no more than 5, but found 6
+ startposition:
+ line: 10
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/index_type_no_blob.yaml b/backend/plugin/advisor/oceanbase/test/index_type_no_blob.yaml
new file mode 100644
index 0000000000..c7fd537402
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/index_type_no_blob.yaml
@@ -0,0 +1,254 @@
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `userTable`.`content` is blob
+ startposition:
+ line: 12
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: CREATE TABLE t(b BLOB, PRIMARY KEY(b(10)));
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(b BLOB, mb MEDIUMBLOB, lb LONGBLOB, id INT, PRIMARY KEY(b(1), mb(2), lb(3), id));
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(b BLOB, mb MEDIUMBLOB, lb LONGBLOB, id INT, UNIQUE INDEX(b(1), mb(2), lb(3), id))
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(b BLOB, mb MEDIUMBLOB, lb LONGBLOB, id iNT, INDEX(b(1), mb(2), lb(3), id))
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(id INT, PRIMARY KEY(id))
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN b BLOB, ADD COLUMN id INT, ADD PRIMARY KEY(b(1), id);
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN b BLOB, ADD COLUMN mb MEDIUMBLOB, ADD COLUMN lb LONGBLOB, ADD COLUMN id INT, ADD UNIQUE INDEX(b(1), mb(2), lb(3), id)
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN b BLOB, ADD COLUMN mb MEDIUMBLOB, ADD COLUMN lb LONGBLOB, ADD COLUMN id INT, ADD INDEX(b(1), mb(2), lb(3), id)
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t ADD COLUMN b BLOB, ADD COLUMN mb MEDIUMBLOB, ADD COLUMN lb LONGBLOB, ADD COLUMN id INT, ADD INDEX(id);
+- statement: |-
+ CREATE TABLE t(b blob, mb mediumblob, lb longblob, id int);
+ CREATE INDEX idx_b ON t(b(5));
+ CREATE INDEX idx_mb ON t(mb(5));
+ CREATE INDEX idx_lb ON t(lb(5));
+ CREATE INDEX idx_id ON t(id);
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`mb` is mediumblob
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`lb` is longblob
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b blob, mb mediumblob, lb longblob, id int);
+ CREATE INDEX idx_id ON t(id);
+- statement: |-
+ CREATE TABLE t(b int, mb mediumblob, lb longblob, id int);
+ ALTER TABLE t MODIFY COLUMN b blob;
+ ALTER TABLE t ADD PRIMARY KEY(b);
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`b` is blob
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int, mb mediumblob, lb longblob, id int);
+ ALTER TABLE t CHANGE COLUMN b d blob;
+ ALTER TABLE t ADD PRIMARY KEY(d);
+ want:
+ - status: 2
+ code: 804
+ title: INDEX_TYPE_NO_BLOB
+ content: Columns in index must not be BLOB but `t`.`d` is blob
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/naming_column.yaml b/backend/plugin/advisor/oceanbase/test/naming_column.yaml
new file mode 100644
index 0000000000..deb6733efb
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_column.yaml
@@ -0,0 +1,158 @@
+- statement: CREATE TABLE book(id int, creatorId int);
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`creatorId` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id int, gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx int);
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx` mismatches column naming convention, its length should be within 64 characters'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id int, creator_id int);
+- statement: |-
+ CREATE TABLE book(id int, creator_id int);
+ ALTER TABLE book RENAME COLUMN creator_id TO creatorId;
+ ALTER TABLE book CHANGE COLUMN creatorId gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx int;
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`creatorId` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx` mismatches column naming convention, its length should be within 64 characters'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |
+ ALTER TABLE tech_book RENAME COLUMN id TO creator_id;
+ ALTER TABLE tech_book RENAME COLUMN creator_id TO gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx;
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`tech_book`.`gbhzmtchhsjzyrhdroxmyouwloxqezowdvhcbqalqcgqhfbjnvmhwrbggezmzeusx` mismatches column naming convention, its length should be within 64 characters'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updater_id int,
+ updated_ts timestamp);
+ ALTER TABLE book CHANGE COLUMN creator_id creatorId int;
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`creatorId` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 7
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book (id INT);
+ ALTER TABLE book CHANGE COLUMN id creator_id int;
+- statement: ALTER TABLE tech_book DROP COLUMN id;
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updated_ts timestamp);
+ ALTER TABLE book ADD COLUMN contentString varchar(255);
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`contentString` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ creator_id int,
+ created_ts timestamp,
+ updated_ts timestamp);
+ ALTER TABLE book ADD COLUMN (personAge INT, contentString varchar(255));
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`contentString` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`personAge` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE book(
+ id int,
+ createdTs timestamp,
+ updaterId int,
+ updated_ts timestamp);
+ CREATE TABLE student(
+ id int,
+ createdTs timestamp,
+ updatedTs timestamp);
+ want:
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`createdTs` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`book`.`updaterId` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`student`.`createdTs` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 8
+ column: 0
+ endposition: null
+ - status: 2
+ code: 302
+ title: NAMING_COLUMN
+ content: '`student`.`updatedTs` mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 9
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/naming_column_auto_increment.yaml b/backend/plugin/advisor/oceanbase/test/naming_column_auto_increment.yaml
new file mode 100644
index 0000000000..530e8a5d4f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_column_auto_increment.yaml
@@ -0,0 +1,53 @@
+- statement: CREATE TABLE book(id int AUTO_INCREMENT);
+- statement: CREATE TABLE book(a int AUTO_INCREMENT);
+ want:
+ - status: 2
+ code: 307
+ title: NAMING_COLUMN_AUTO_INCREMENT
+ content: '`book`.`a` mismatches auto_increment column naming convention, naming format should be "^id$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD COLUMN a int AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 307
+ title: NAMING_COLUMN_AUTO_INCREMENT
+ content: '`tech_book`.`a` mismatches auto_increment column naming convention, naming format should be "^id$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book CHANGE COLUMN id a int AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 307
+ title: NAMING_COLUMN_AUTO_INCREMENT
+ content: '`tech_book`.`a` mismatches auto_increment column naming convention, naming format should be "^id$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book MODIFY COLUMN name int AUTO_INCREMENT;
+ want:
+ - status: 2
+ code: 307
+ title: NAMING_COLUMN_AUTO_INCREMENT
+ content: '`tech_book`.`name` mismatches auto_increment column naming convention, naming format should be "^id$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(id int);
+ ALTER TABLE tech_book MODIFY COLUMN id int AUTO_INCREMENT;
+- statement: |
+ CREATE TABLE book(name VARCHAR(255));
+ ALTER TABLE book ADD COLUMN id int AUTO_INCREMENT;
+- statement: |
+ CREATE TABLE book(a INT, name VARCHAR(255));
+ ALTER TABLE book CHANGE COLUMN a id int AUTO_INCREMENT;
+- statement: |
+ CREATE TABLE book(name VARCHAR(255));
+ ALTER TABLE book ADD COLUMN (id int AUTO_INCREMENT, a int, b int, c int, d int);
diff --git a/backend/plugin/advisor/oceanbase/test/naming_index_fk.yaml b/backend/plugin/advisor/oceanbase/test/naming_index_fk.yaml
new file mode 100644
index 0000000000..678c433581
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_index_fk.yaml
@@ -0,0 +1,77 @@
+- statement: CREATE TABLE userTable(id INT NOT NULL,name VARCHAR(255) CHARSET ascii,roomId INT,time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',content BLOB NOT NULL COMMENT 'comment',json_content JSON NOT NULL COMMENT 'comment',INDEX idx1(name),UNIQUE KEY uk1(id, name),FOREIGN KEY fk1(roomId) REFERENCES room(id),INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key in table `userTable` mismatches the naming convention, expect "^$|^fk_userTable_roomId_room_id$" but found `fk1`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_tech_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id);
+- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_author_id FOREIGN KEY (author_id) REFERENCES author (id);
+ want:
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key in table `tech_book` mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found `fk_author_id`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD CONSTRAINT rvemempmcmmhutaskvcidmwaldtfjdgmcpkhmibtadfydtkexpuzczrrneucthfwk FOREIGN KEY (author_id) REFERENCES author (id);
+ want:
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key `rvemempmcmmhutaskvcidmwaldtfjdgmcpkhmibtadfydtkexpuzczrrneucthfwk` in table `tech_book` mismatches the naming convention, its length should be within 64 characters
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key in table `tech_book` mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found `rvemempmcmmhutaskvcidmwaldtfjdgmcpkhmibtadfydtkexpuzczrrneucthfwk`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(
+ id INT,
+ author_id INT,
+ FOREIGN KEY fk_book_author_id_author_id (author_id) REFERENCES author (id)
+ );
+- statement: |
+ CREATE TABLE book(
+ id INT,
+ author_id INT,
+ FOREIGN KEY (author_id) REFERENCES author (id)
+ );
+- statement: |
+ CREATE TABLE book(
+ id INT,
+ author_id INT,
+ FOREIGN KEY fk_book_author_id (author_id) REFERENCES author (id)
+ );
+ want:
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key in table `book` mismatches the naming convention, expect "^$|^fk_book_author_id_author_id$" but found `fk_book_author_id`
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id INT, author_id INT, CONSTRAINT fk_book_author_id_author_id FOREIGN KEY fk1 (author_id) REFERENCES author (id));
+- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_author_id FOREIGN KEY fk_tech_book_author_id_author_id (author_id) REFERENCES author (id);
+ want:
+ - status: 2
+ code: 305
+ title: NAMING_INDEX_FK
+ content: Foreign key in table `tech_book` mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found `fk_author_id`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/naming_index_idx.yaml b/backend/plugin/advisor/oceanbase/test/naming_index_idx.yaml
new file mode 100644
index 0000000000..1abfa88d31
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_index_idx.yaml
@@ -0,0 +1,56 @@
+- statement: CREATE INDEX idx_tech_book_id_name ON tech_book(id, name);
+- statement: CREATE INDEX tech_book_id_name ON tech_book(id, name);
+ want:
+ - status: 2
+ code: 303
+ title: NAMING_INDEX_IDX
+ content: Index in table `tech_book` mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found `tech_book_id_name`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE INDEX afvjwsgrbgqzjfrkmbcoxzstznuypasijbbcdykoboredqovetzfcmmqliaelyavw ON tech_book(id, name);
+ want:
+ - status: 2
+ code: 303
+ title: NAMING_INDEX_IDX
+ content: Index `afvjwsgrbgqzjfrkmbcoxzstznuypasijbbcdykoboredqovetzfcmmqliaelyavw` in table `tech_book` mismatches the naming convention, its length should be within 64 characters
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 303
+ title: NAMING_INDEX_IDX
+ content: Index in table `tech_book` mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found `afvjwsgrbgqzjfrkmbcoxzstznuypasijbbcdykoboredqovetzfcmmqliaelyavw`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book RENAME INDEX old_index TO idx_tech_book_id_name;
+- statement: ALTER TABLE tech_book RENAME INDEX old_index TO idx_tech_book;
+ want:
+ - status: 2
+ code: 303
+ title: NAMING_INDEX_IDX
+ content: Index in table `tech_book` mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found `idx_tech_book`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD INDEX idx_tech_book_id_name (id, name);
+- statement: ALTER TABLE tech_book ADD INDEX tech_book_id_name (id, name);
+ want:
+ - status: 2
+ code: 303
+ title: NAMING_INDEX_IDX
+ content: Index in table `tech_book` mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found `tech_book_id_name`
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE tech_book_copy(id INT PRIMARY KEY, name VARCHAR(20), INDEX idx_tech_book_copy_name (name));
+- statement: CREATE TABLE tech_book_copy(id INT PRIMARY KEY, name VARCHAR(20), INDEX (name));
+- statement: CREATE TABLE tech_book_copy(id INT PRIMARY KEY, name VARCHAR(20), UNIQUE INDEX (name));
+- statement: CREATE TABLE tech_book_copy(id INT PRIMARY KEY, name VARCHAR(20), FULLTEXT INDEX (name));
+- statement: CREATE TABLE tech_book_copy(id INT PRIMARY KEY, name VARCHAR(20), SPATIAL INDEX (name));
diff --git a/backend/plugin/advisor/oceanbase/test/naming_index_uk.yaml b/backend/plugin/advisor/oceanbase/test/naming_index_uk.yaml
new file mode 100644
index 0000000000..b3f8c7ed53
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_index_uk.yaml
@@ -0,0 +1,72 @@
+- statement: CREATE UNIQUE INDEX uk_tech_book_id_name ON tech_book(id, name);
+- statement: |
+ CREATE UNIQUE INDEX uk_tech_book_id_name ON tech_book(id, name);
+ CREATE UNIQUE INDEX tech_book_id_name ON tech_book(id, name);
+ want:
+ - status: 2
+ code: 304
+ title: NAMING_INDEX_UK
+ content: Unique key in table `tech_book` mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found `tech_book_id_name`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE UNIQUE INDEX uk_tech_book_id_name ON tech_book(id, name);
+ CREATE UNIQUE INDEX qtzmquwvlnttctfluoouxelxeliltcfzzstrtyocogwwyiyrflmrkbhbfasynlacy ON tech_book(id, name)
+ want:
+ - status: 2
+ code: 304
+ title: NAMING_INDEX_UK
+ content: Unique key `qtzmquwvlnttctfluoouxelxeliltcfzzstrtyocogwwyiyrflmrkbhbfasynlacy` in table `tech_book` mismatches the naming convention, its length should be within 64 characters
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 304
+ title: NAMING_INDEX_UK
+ content: Unique key in table `tech_book` mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found `qtzmquwvlnttctfluoouxelxeliltcfzzstrtyocogwwyiyrflmrkbhbfasynlacy`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book ADD UNIQUE uk_tech_book_id_name (id, name);
+- statement: |
+ CREATE TABLE t1(a INT);
+ ALTER TABLE tech_book ADD UNIQUE tech_book_id_name (id, name);
+ want:
+ - status: 2
+ code: 304
+ title: NAMING_INDEX_UK
+ content: Unique key in table `tech_book` mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found `tech_book_id_name`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book RENAME INDEX old_uk TO uk_tech_book_id_name;
+- statement: |
+ CREATE TABLE t1(a INT);
+ ALTER TABLE tech_book RENAME INDEX old_uk TO uk_tech_book;
+ want:
+ - status: 2
+ code: 304
+ title: NAMING_INDEX_UK
+ content: Unique key in table `tech_book` mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found `uk_tech_book`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: CREATE TABLE book(id INT PRIMARY KEY, name VARCHAR(20), UNIQUE INDEX uk_book_name (name));
+- statement: |
+ CREATE TABLE book(
+ id INT PRIMARY KEY,
+ name VARCHAR(20),
+ UNIQUE KEY (name)
+ );
+- statement: |
+ CREATE TABLE book(
+ id INT PRIMARY KEY,
+ name VARCHAR(20),
+ UNIQUE INDEX (name)
+ );
diff --git a/backend/plugin/advisor/oceanbase/test/naming_table.yaml b/backend/plugin/advisor/oceanbase/test/naming_table.yaml
new file mode 100644
index 0000000000..df19df0f45
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/naming_table.yaml
@@ -0,0 +1,73 @@
+- statement: CREATE TABLE techBook(id int, name varchar(255));
+ want:
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`techBook` mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE tech_book_copy(id int, name varchar(255));
+- statement: CREATE TABLE cjnubexocfhqoogdmihudyahmmghviqkzvpixnwvxtxumvuannpwdcbtsgwrvzpde(id int, name varchar(255));
+ want:
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`cjnubexocfhqoogdmihudyahmmghviqkzvpixnwvxtxumvuannpwdcbtsgwrvzpde` mismatches table naming convention, its length should be within 64 characters'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(a INT);
+ ALTER TABLE book RENAME TO TechBook;
+ want:
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`TechBook` mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(a INT);
+ ALTER TABLE book RENAME TO tech_book_copy;
+- statement: |
+ CREATE TABLE book (a INT);
+ RENAME TABLE book TO tech_book_copy, tech_book_copy TO LiteraryBook;
+ want:
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`LiteraryBook` mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE literary_book(a int);
+ CREATE TABLE book(a int);
+ RENAME TABLE book TO TechBook, literary_book TO LiteraryBook;
+ want:
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`LiteraryBook` mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 301
+ title: NAMING_TABLE
+ content: '`TechBook` mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE literary_book(a int);
+ CREATE TABLE book(a int);
+ RENAME TABLE book TO tech_book_copy, literary_book TO literary_book_copy;
diff --git a/backend/plugin/advisor/oceanbase/test/schema_backward_compatibility.yaml b/backend/plugin/advisor/oceanbase/test/schema_backward_compatibility.yaml
new file mode 100644
index 0000000000..adfc0b37b9
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/schema_backward_compatibility.yaml
@@ -0,0 +1,50 @@
+- statement: ALTER TABLE tech_book CHANGE name f2 TEXT;
+ want:
+ - status: 2
+ code: 111
+ title: SCHEMA_BACKWARD_COMPATIBILITY
+ content: '"ALTER TABLE tech_book CHANGE name f2 TEXT;" may cause incompatibility with the existing data and code'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book MODIFY name TEXT;
+ want:
+ - status: 2
+ code: 111
+ title: SCHEMA_BACKWARD_COMPATIBILITY
+ content: '"ALTER TABLE tech_book MODIFY name TEXT;" may cause incompatibility with the existing data and code'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book MODIFY name TEXT NULL;
+ want:
+ - status: 2
+ code: 111
+ title: SCHEMA_BACKWARD_COMPATIBILITY
+ content: '"ALTER TABLE tech_book MODIFY name TEXT NULL;" may cause incompatibility with the existing data and code'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book MODIFY name TEXT NOT NULL;
+ want:
+ - status: 2
+ code: 111
+ title: SCHEMA_BACKWARD_COMPATIBILITY
+ content: '"ALTER TABLE tech_book MODIFY name TEXT NOT NULL;" may cause incompatibility with the existing data and code'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book MODIFY name TEXT COMMENT 'bla';
+ want:
+ - status: 2
+ code: 111
+ title: SCHEMA_BACKWARD_COMPATIBILITY
+ content: '"ALTER TABLE tech_book MODIFY name TEXT COMMENT ''bla'';" may cause incompatibility with the existing data and code'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_affected_row_limit.yaml b/backend/plugin/advisor/oceanbase/test/statement_affected_row_limit.yaml
new file mode 100644
index 0000000000..57e738764f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_affected_row_limit.yaml
@@ -0,0 +1,2 @@
+- statement: DELETE FROM tech_book WHERE a > 1;
+- statement: UPDATE tech_book SET id = 1;
diff --git a/backend/plugin/advisor/oceanbase/test/statement_disallow_commit.yaml b/backend/plugin/advisor/oceanbase/test/statement_disallow_commit.yaml
new file mode 100644
index 0000000000..e9d2cd7dca
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_disallow_commit.yaml
@@ -0,0 +1,38 @@
+- statement: |-
+ START TRANSACTION;
+ CREATE TABLE techBook(id int, name varchar(255));
+ COMMIT;
+ want:
+ - status: 2
+ code: 206
+ title: STATEMENT_DISALLOW_COMMIT
+ content: 'Commit is not allowed, related statement: "COMMIT;"'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ START TRANSACTION;
+ CREATE TABLE techBook(id int, name varchar(255));
+ COMMIT;
+
+ START TRANSACTION;
+ INSERT INTO techBook(id, name) VALUES(1, "book");
+ COMMIT;
+ want:
+ - status: 2
+ code: 206
+ title: STATEMENT_DISALLOW_COMMIT
+ content: 'Commit is not allowed, related statement: "COMMIT;"'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 206
+ title: STATEMENT_DISALLOW_COMMIT
+ content: 'Commit is not allowed, related statement: "COMMIT;"'
+ startposition:
+ line: 7
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_disallow_limit.yaml b/backend/plugin/advisor/oceanbase/test/statement_disallow_limit.yaml
new file mode 100644
index 0000000000..39d567da64
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_disallow_limit.yaml
@@ -0,0 +1,73 @@
+- statement: INSERT INTO tech_book SELECT * FROM tech_book;
+- statement: |
+ INSERT INTO tech_book SELECT * FROM tech_book;
+ INSERT INTO tech_book SELECT * FROM tech_book LIMIT 1;
+ want:
+ - status: 2
+ code: 1103
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "INSERT INTO tech_book SELECT * FROM tech_book LIMIT 1;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ INSERT INTO tech_book SELECT * FROM tech_book;
+ INSERT INTO tech_book SELECT * FROM tech_book UNION SELECT * FROM tech_book LIMIT 1;
+ want:
+ - status: 2
+ code: 1103
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "INSERT INTO tech_book SELECT * FROM tech_book UNION SELECT * FROM tech_book LIMIT 1;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ INSERT INTO tech_book SELECT * FROM tech_book;
+ INSERT INTO tech_book SELECT * FROM tech_book UNION SELECT * FROM tech_book LIMIT 1;
+ want:
+ - status: 2
+ code: 1103
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "INSERT INTO tech_book SELECT * FROM tech_book UNION SELECT * FROM tech_book LIMIT 1;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ INSERT INTO tech_book SELECT * FROM tech_book;
+ INSERT INTO tech_book (SELECT * FROM tech_book LIMIT 1);
+ want:
+ - status: 2
+ code: 1103
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "INSERT INTO tech_book (SELECT * FROM tech_book LIMIT 1);" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ UPDATE tech_book SET name = 'my name';
+ UPDATE tech_book SET name = 'my name' LIMIT 10;
+ want:
+ - status: 2
+ code: 1102
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "UPDATE tech_book SET name = 'my name' LIMIT 10;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ DELETE FROM tech_book;
+ DELETE FROM tech_book LIMIT 10;
+ want:
+ - status: 2
+ code: 1106
+ title: STATEMENT_DISALLOW_LIMIT
+ content: LIMIT clause is forbidden in INSERT, UPDATE and DELETE statement, but "DELETE FROM tech_book LIMIT 10;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_disallow_order_by.yaml b/backend/plugin/advisor/oceanbase/test/statement_disallow_order_by.yaml
new file mode 100644
index 0000000000..2789c4b9aa
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_disallow_order_by.yaml
@@ -0,0 +1,25 @@
+- statement: INSERT INTO tech_book values(1, 'a');
+- statement: |-
+ UPDATE tech_book SET name = 'my name';
+ UPDATE tech_book SET name = 'my name' ORDER BY id;
+ want:
+ - status: 2
+ code: 1104
+ title: STATEMENT_DISALLOW_ORDER_BY
+ content: ORDER BY clause is forbidden in DELETE and UPDATE statements, but "UPDATE tech_book SET name = 'my name' ORDER BY id;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ DELETE FROM tech_book;
+ DELETE FROM tech_book ORDER BY id;
+ want:
+ - status: 2
+ code: 1105
+ title: STATEMENT_DISALLOW_ORDER_BY
+ content: ORDER BY clause is forbidden in DELETE and UPDATE statements, but "DELETE FROM tech_book ORDER BY id;" uses
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_disallow_truncate.yaml b/backend/plugin/advisor/oceanbase/test/statement_disallow_truncate.yaml
new file mode 100644
index 0000000000..88db44d5d1
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_disallow_truncate.yaml
@@ -0,0 +1,218 @@
+# SQL review rule: STATEMENT_DISALLOW_TRUNCATE (MySQL / MariaDB / OceanBase)
+#
+# Detection targets:
+# * top-level TruncateStmt -> table-variant advice (one per target table)
+# * AlterTableStmt with ATTruncatePartition commands -> partition-variant
+# advice (one per partition; AllPartitions flag emits a single
+# "ALL PARTITIONS" advice)
+#
+# MySQL TRUNCATE auto-commits, bypasses triggers, resets AUTO_INCREMENT, and
+# the prior-backup pipeline classifies it as DDL (no row-level snapshot).
+
+# --- Positive cases: top-level TRUNCATE ---
+
+# Test: bare TRUNCATE TABLE
+- statement: TRUNCATE TABLE techbook;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "techbook" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: TABLE keyword omitted (MySQL legal)
+- statement: TRUNCATE techbook;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "techbook" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: schema-qualified
+- statement: TRUNCATE TABLE db.techbook;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "db.techbook" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: backtick-quoted identifier resolves to unquoted name
+- statement: TRUNCATE TABLE `tech book`;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "tech book" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: lowercase keywords
+- statement: truncate table techbook;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "techbook" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# --- Positive cases: ALTER TABLE ... TRUNCATE PARTITION ---
+
+# Test: single partition
+- statement: ALTER TABLE sales TRUNCATE PARTITION p_2024_q4;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "sales" TRUNCATE PARTITION "p_2024_q4" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: multiple partitions — advice order follows the omni parser's
+# PartitionNames slice (reverse of source order for comma-separated list).
+- statement: ALTER TABLE sales TRUNCATE PARTITION p_jan, p_feb;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "sales" TRUNCATE PARTITION "p_feb" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "sales" TRUNCATE PARTITION "p_jan" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: ALL PARTITIONS form — surfaces as AllPartitions=true, one advice
+- statement: ALTER TABLE sales TRUNCATE PARTITION ALL;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "sales" TRUNCATE PARTITION "ALL PARTITIONS" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: schema-qualified table with partition truncate
+- statement: ALTER TABLE db.sales TRUNCATE PARTITION p_2024_q4;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "db.sales" TRUNCATE PARTITION "p_2024_q4" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+
+# Test: multi-command ALTER TABLE — advice line points to the TRUNCATE
+# PARTITION command (line 3), not the ALTER TABLE statement head (line 1).
+- statement: |-
+ ALTER TABLE sales
+ ADD COLUMN region VARCHAR(32),
+ TRUNCATE PARTITION p_2024_q4;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'ALTER TABLE "sales" TRUNCATE PARTITION "p_2024_q4" is not allowed: partition truncate shares the auto-commit and prior-backup gaps of TRUNCATE TABLE on MySQL.'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+
+# Test: multi-statement — advice line must point to the TRUNCATE, not stmt 1
+- statement: |-
+ CREATE TABLE tech_book(id int);
+ TRUNCATE TABLE tech_book;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "tech_book" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+
+# Test: multiple TRUNCATE statements in one script, line positions independent
+- statement: |-
+ TRUNCATE TABLE a;
+ INSERT INTO a VALUES (1);
+ TRUNCATE TABLE b;
+ changeType: 1
+ want:
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "a" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 257
+ title: STATEMENT_DISALLOW_TRUNCATE
+ content: 'TRUNCATE TABLE "b" is not allowed: TRUNCATE auto-commits (breaking surrounding transactional work), bypasses triggers, and resets AUTO_INCREMENT. Prior-backup treats this as DDL and does not produce row-level snapshots.'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+
+# --- Negative cases ---
+
+# Test: DELETE is not TRUNCATE
+- statement: DELETE FROM techbook WHERE id = 1;
+ changeType: 1
+
+# Test: TRUNCATE as string literal in SELECT
+- statement: SELECT 'TRUNCATE foo' AS x;
+ changeType: 1
+
+# Test: ALTER TABLE with unrelated command
+- statement: ALTER TABLE sales ADD COLUMN region VARCHAR(32);
+ changeType: 1
+
+# Test: ALTER TABLE DROP PARTITION is NOT truncate partition
+- statement: ALTER TABLE sales DROP PARTITION p_2024_q4;
+ changeType: 1
+
+# Test: DROP TABLE is a different statement type
+- statement: DROP TABLE techbook;
+ changeType: 1
diff --git a/backend/plugin/advisor/oceanbase/test/statement_dml_dry_run.yaml b/backend/plugin/advisor/oceanbase/test/statement_dml_dry_run.yaml
new file mode 100644
index 0000000000..449cbfac8e
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_dml_dry_run.yaml
@@ -0,0 +1,3 @@
+- statement: INSERT INTO tech_book values(1, 'zp');
+- statement: DELETE FROM tech_book;
+- statement: UPDATE tech_book SET name = 'xz' WHERE id = 1;
diff --git a/backend/plugin/advisor/oceanbase/test/statement_insert_disallow_order_by_rand.yaml b/backend/plugin/advisor/oceanbase/test/statement_insert_disallow_order_by_rand.yaml
new file mode 100644
index 0000000000..c47e318328
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_insert_disallow_order_by_rand.yaml
@@ -0,0 +1,25 @@
+- statement: INSERT INTO tech_book VALUES(1, "a");
+- statement: |-
+ INSERT INTO tech_book VALUES(1, "a");
+ INSERT INTO tech_book SELECT * FROM tech_book ORDER BY rand();
+ want:
+ - status: 2
+ code: 1108
+ title: STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND
+ content: '"INSERT INTO tech_book SELECT * FROM tech_book ORDER BY rand();" uses ORDER BY RAND in the INSERT statement'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ INSERT INTO tech_book VALUES(1, "a");
+ INSERT INTO tech_book SELECT * FROM tech_book ORDER BY RAND() LIMIT 1;
+ want:
+ - status: 2
+ code: 1108
+ title: STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND
+ content: '"INSERT INTO tech_book SELECT * FROM tech_book ORDER BY RAND() LIMIT 1;" uses ORDER BY RAND in the INSERT statement'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_insert_must_specify_column.yaml b/backend/plugin/advisor/oceanbase/test/statement_insert_must_specify_column.yaml
new file mode 100644
index 0000000000..27cfa98381
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_insert_must_specify_column.yaml
@@ -0,0 +1,21 @@
+- statement: INSERT INTO t_copy SELECT * FROM t;
+ want:
+ - status: 2
+ code: 1107
+ title: STATEMENT_INSERT_MUST_SPECIFY_COLUMN
+ content: The INSERT statement must specify columns but "INSERT INTO t_copy SELECT * FROM t;" does not
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: INSERT INTO tech_book(id, name) VALUES (1, '1');
+- statement: "INSERT INTO tech_book(id, name) VALUES (1, '1'); \nINSERT INTO tech_book VALUES (1, '1');"
+ want:
+ - status: 2
+ code: 1107
+ title: STATEMENT_INSERT_MUST_SPECIFY_COLUMN
+ content: The INSERT statement must specify columns but "INSERT INTO tech_book VALUES (1, '1');" does not
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_insert_row_limit.yaml b/backend/plugin/advisor/oceanbase/test/statement_insert_row_limit.yaml
new file mode 100644
index 0000000000..4f28b376d3
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_insert_row_limit.yaml
@@ -0,0 +1,16 @@
+- statement: INSERT INTO tech_book values(1, 'a');
+- statement: |
+ INSERT INTO tech_book values(1, 'a');
+ INSERT INTO tech_book values(1, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e'), (6, 'f');
+ want:
+ - status: 2
+ code: 1101
+ title: STATEMENT_INSERT_ROW_LIMIT
+ content: |-
+ "
+ INSERT INTO tech_book values(1, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e'), (6, 'f');" inserts 6 rows. The count exceeds 5.
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: INSERT INTO tech_book SELECT * FROM tech_book;
diff --git a/backend/plugin/advisor/oceanbase/test/statement_merge_alter_table.yaml b/backend/plugin/advisor/oceanbase/test/statement_merge_alter_table.yaml
new file mode 100644
index 0000000000..414e441462
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_merge_alter_table.yaml
@@ -0,0 +1,57 @@
+- statement: ALTER TABLE tech_book ADD COLUMN a int;
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN a int;
+ ALTER TABLE tech_book CHANGE COLUMN a c int;
+ want:
+ - status: 2
+ code: 207
+ title: STATEMENT_MERGE_ALTER_TABLE
+ content: There are 2 statements to modify table `tech_book`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE tech_book ADD COLUMN b int;
+ ALTER TABLE t ADD COLUMN b int;
+ ALTER TABLE tech_book MODIFY COLUMN b varchar(255);
+ want:
+ - status: 2
+ code: 207
+ title: STATEMENT_MERGE_ALTER_TABLE
+ content: There are 2 statements to modify table `t`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 207
+ title: STATEMENT_MERGE_ALTER_TABLE
+ content: There are 2 statements to modify table `tech_book`
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE tech_book ADD COLUMN a int;
+ ALTER TABLE tech_book ADD COLUMN b int;
+ ALTER TABLE t ADD COLUMN b int;
+ want:
+ - status: 2
+ code: 207
+ title: STATEMENT_MERGE_ALTER_TABLE
+ content: There are 2 statements to modify table `tech_book`
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 207
+ title: STATEMENT_MERGE_ALTER_TABLE
+ content: There are 2 statements to modify table `t`
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_select_no_select_all.yaml b/backend/plugin/advisor/oceanbase/test/statement_select_no_select_all.yaml
new file mode 100644
index 0000000000..3654e301b9
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_select_no_select_all.yaml
@@ -0,0 +1,105 @@
+- statement: SELECT * FROM t;
+ want:
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: '"SELECT * FROM t;" uses SELECT all'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: SELECT a, b FROM t;
+- statement: |
+ SELECT a, b FROM t;
+ SELECT * FROM t;
+ SELECT a, b FROM (SELECT * from t1 JOIN t2) t;
+ want:
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: '"SELECT * FROM t;" uses SELECT all'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: '"SELECT a, b FROM (SELECT * from t1 JOIN t2) t;" uses SELECT all'
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ SELECT a, b FROM t;
+ SELECT * FROM t1
+ UNION
+ SELECT * FROM t2;
+ want:
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: |-
+ "SELECT * FROM t1
+ UNION
+ SELECT * FROM t2;" uses SELECT all
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: |-
+ "SELECT * FROM t1
+ UNION
+ SELECT * FROM t2;" uses SELECT all
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ SELECT a, b FROM t;
+ WITH cte AS (
+ SELECT * FROM a
+ ) SELECT * FROM cte;
+ want:
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: |-
+ "WITH cte AS (
+ SELECT * FROM a
+ ) SELECT * FROM cte;" uses SELECT all
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: |-
+ "WITH cte AS (
+ SELECT * FROM a
+ ) SELECT * FROM cte;" uses SELECT all
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+- statement: |-
+ SELECT a, b FROM t;
+ SELECT *
+ FROM a
+ INNER JOIN b USING(id);
+ want:
+ - status: 2
+ code: 203
+ title: STATEMENT_SELECT_NO_SELECT_ALL
+ content: |-
+ "SELECT *
+ FROM a
+ INNER JOIN b USING(id);" uses SELECT all
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_where_no_leading_wildcard_like.yaml b/backend/plugin/advisor/oceanbase/test/statement_where_no_leading_wildcard_like.yaml
new file mode 100644
index 0000000000..c58d737a91
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_where_no_leading_wildcard_like.yaml
@@ -0,0 +1,106 @@
+- statement: |
+ DELETE FROM tech_book WHERE name like "%abc";
+ want:
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: '"DELETE FROM tech_book WHERE name like "%abc";" uses leading wildcard LIKE'
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE t (id INT);
+ SELECT * FROM t WHERE a LIKE 'abc%';
+- statement: |
+ CREATE TABLE t (id INT);
+ SELECT * FROM t WHERE a LIKE '%abc';
+ want:
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: '"SELECT * FROM t WHERE a LIKE ''%abc'';" uses leading wildcard LIKE'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE t (id INT);
+ SELECT * FROM t WHERE a LIKE 'abc' OR a LIKE '%abc';
+ want:
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: '"SELECT * FROM t WHERE a LIKE ''abc'' OR a LIKE ''%abc'';" uses leading wildcard LIKE'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE t (id INT, a VARCHAR(255));
+ SELECT *
+ FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc';
+ want:
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: |-
+ "SELECT *
+ FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc';" uses leading wildcard LIKE
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: |-
+ "SELECT *
+ FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc';" uses leading wildcard LIKE
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE t (id INT, a VARCHAR(255));
+ SELECT * FROM
+ (
+ SELECT * FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc'
+ ) t1;
+ want:
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: |-
+ "SELECT * FROM
+ (
+ SELECT * FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc'
+ ) t1;" uses leading wildcard LIKE
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+ - status: 2
+ code: 204
+ title: STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
+ content: |-
+ "SELECT * FROM
+ (
+ SELECT * FROM t
+ WHERE a LIKE '%acc'
+ OR a LIKE '%abc'
+ ) t1;" uses leading wildcard LIKE
+ startposition:
+ line: 6
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/statement_where_require_select.yaml b/backend/plugin/advisor/oceanbase/test/statement_where_require_select.yaml
new file mode 100644
index 0000000000..9030549209
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_where_require_select.yaml
@@ -0,0 +1,55 @@
+- statement: |
+ CREATE TABLE book(id INT);
+ INSERT INTO book(id) values (1);
+- statement: |
+ CREATE TABLE book(id INT);
+ SELECT id FROM book;
+ want:
+ - status: 2
+ code: 202
+ title: STATEMENT_WHERE_REQUIRE_SELECT
+ content: '"SELECT id FROM book;" requires WHERE clause'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(id INT);
+ SELECT id FROM book WHERE id > 0;
+- statement: |
+ CREATE TABLE book(id INT);
+ (SELECT id FROM book);
+ want:
+ - status: 2
+ code: 202
+ title: STATEMENT_WHERE_REQUIRE_SELECT
+ content: '"(SELECT id FROM book);" requires WHERE clause'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(id INT);
+ SELECT id
+ FROM book
+ WHERE id > (
+ SELECT max(id)
+ FROM book
+ );
+ want:
+ - status: 2
+ code: 202
+ title: STATEMENT_WHERE_REQUIRE_SELECT
+ content: |-
+ "SELECT id
+ FROM book
+ WHERE id > (
+ SELECT max(id)
+ FROM book
+ );" requires WHERE clause
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
+- statement: |
+ SELECT CURDATE();
diff --git a/backend/plugin/advisor/oceanbase/test/statement_where_require_update_delete.yaml b/backend/plugin/advisor/oceanbase/test/statement_where_require_update_delete.yaml
new file mode 100644
index 0000000000..a5a757216f
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/statement_where_require_update_delete.yaml
@@ -0,0 +1,33 @@
+- statement: |
+ CREATE TABLE book(id INT);
+ INSERT INTO book(id) values (1);
+- statement: |
+ CREATE TABLE book(id INT);
+ DELETE FROM book;
+ want:
+ - status: 2
+ code: 202
+ title: STATEMENT_WHERE_REQUIRE_UPDATE_DELETE
+ content: '"DELETE FROM book;" requires WHERE clause'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(id INT);
+ UPDATE book SET id = 1;
+ want:
+ - status: 2
+ code: 202
+ title: STATEMENT_WHERE_REQUIRE_UPDATE_DELETE
+ content: '"UPDATE book SET id = 1;" requires WHERE clause'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE book(id INT);
+ DELETE FROM book WHERE id > 0;
+- statement: |
+ CREATE TABLE book(id INT);
+ UPDATE book SET id = 1 WHERE id > 10;
diff --git a/backend/plugin/advisor/oceanbase/test/system_charset_allowlist.yaml b/backend/plugin/advisor/oceanbase/test/system_charset_allowlist.yaml
new file mode 100644
index 0000000000..c653580385
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/system_charset_allowlist.yaml
@@ -0,0 +1,81 @@
+- statement: CREATE TABLE t(a int) CHARSET utf8mb4;
+- statement: CREATE TABLE t(a varchar(255));
+- statement: CREATE TABLE t(a int) CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"CREATE TABLE t(a int) CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"ALTER TABLE t CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER DATABASE test CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"ALTER DATABASE test CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(a varchar(255) CHARSET ascii);
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"CREATE TABLE t(a varchar(255) CHARSET ascii);" used disabled charset ''ascii'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a varchar(255) CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"ALTER TABLE t ADD COLUMN a varchar(255) CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t MODIFY COLUMN a varchar(255) CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"ALTER TABLE t MODIFY COLUMN a varchar(255) CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t CHANGE COLUMN a a varchar(255) CHARSET ascii;
+ want:
+ - status: 2
+ code: 1001
+ title: SYSTEM_CHARSET_ALLOWLIST
+ content: '"ALTER TABLE t CHANGE COLUMN a a varchar(255) CHARSET ascii;" used disabled charset ''ascii'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: /* this is a comment */
diff --git a/backend/plugin/advisor/oceanbase/test/system_collation_allowlist.yaml b/backend/plugin/advisor/oceanbase/test/system_collation_allowlist.yaml
new file mode 100644
index 0000000000..955df88470
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/system_collation_allowlist.yaml
@@ -0,0 +1,136 @@
+- statement: CREATE TABLE test(id INT PRIMARY KEY COMMENT 'comment',name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',INDEX idx_test_name(name),UNIQUE KEY uk_test_id_name(id, name)) ENGINE = INNODB COMMENT 'comment'
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: |-
+ "CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;" used disabled collation 'latin1_bin'
+ startposition:
+ line: 12
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: CREATE TABLE t(a int) COLLATE utf8mb4_polish_ci;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"CREATE TABLE t(a int) COLLATE utf8mb4_polish_ci;" used disabled collation ''utf8mb4_polish_ci'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(a varchar(255));
+- statement: CREATE TABLE t(a int) COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"CREATE TABLE t(a int) COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"ALTER TABLE t COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER DATABASE test COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"ALTER DATABASE test COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: CREATE TABLE t(a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin);
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"CREATE TABLE t(a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin);" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(b int);
+ ALTER TABLE t ADD COLUMN a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"ALTER TABLE t ADD COLUMN a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t MODIFY COLUMN a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"ALTER TABLE t MODIFY COLUMN a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int);
+ ALTER TABLE t CHANGE COLUMN a a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 1201
+ title: SYSTEM_COLLATION_ALLOWLIST
+ content: '"ALTER TABLE t CHANGE COLUMN a a varchar(255) CHARACTER SET latin1 COLLATE latin1_bin;" used disabled collation ''latin1_bin'''
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/table_comment.yaml b/backend/plugin/advisor/oceanbase/test/table_comment.yaml
new file mode 100644
index 0000000000..2b2dbc2910
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/table_comment.yaml
@@ -0,0 +1,36 @@
+- statement: |-
+ CREATE TABLE a(b INT) COMMENT 'table';
+ CREATE TABLE t(a int) COMMENT 'some comments';
+ want:
+ - status: 2
+ code: 1301
+ title: TABLE_COMMENT
+ content: The length of table `t` comment should be within 10 characters
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE a(b INT) COMMENT 'table';
+ CREATE TABLE t(a int);
+ want:
+ - status: 2
+ code: 1032
+ title: TABLE_COMMENT
+ content: Table `t` requires comments
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE a(b INT) COMMENT 'table';
+ CREATE TABLE t(a int) COMMENT 'sdlfkjalkseblkjduafelbnlsdfkljayue';
+ want:
+ - status: 2
+ code: 1301
+ title: TABLE_COMMENT
+ content: The length of table `t` comment should be within 10 characters
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/table_disallow_partition.yaml b/backend/plugin/advisor/oceanbase/test/table_disallow_partition.yaml
new file mode 100644
index 0000000000..de737b9318
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/table_disallow_partition.yaml
@@ -0,0 +1,72 @@
+- statement: CREATE TABLE t(a int);
+- statement: |-
+ CREATE TABLE b(a INT);
+ CREATE TABLE t(a int) PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );
+ want:
+ - status: 2
+ code: 608
+ title: TABLE_DISALLOW_PARTITION
+ content: |-
+ Table partition is forbidden, but "CREATE TABLE t(a int) PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );" creates
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );
+ want:
+ - status: 2
+ code: 608
+ title: TABLE_DISALLOW_PARTITION
+ content: |-
+ Table partition is forbidden, but "ALTER TABLE tech_book PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );" creates
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(a int) PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );
+ ALTER TABLE tech_book PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );
+ want:
+ - status: 2
+ code: 608
+ title: TABLE_DISALLOW_PARTITION
+ content: |-
+ Table partition is forbidden, but "CREATE TABLE t(a int) PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );" creates
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+ - status: 2
+ code: 608
+ title: TABLE_DISALLOW_PARTITION
+ content: |-
+ Table partition is forbidden, but "ALTER TABLE tech_book PARTITION BY RANGE (a) (
+ PARTITION p0 VALUES LESS THAN (6),
+ PARTITION p1 VALUES LESS THAN (11)
+ );" creates
+ startposition:
+ line: 5
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/table_drop_naming_convention.yaml b/backend/plugin/advisor/oceanbase/test/table_drop_naming_convention.yaml
new file mode 100644
index 0000000000..f7b4cc5bd9
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/table_drop_naming_convention.yaml
@@ -0,0 +1,30 @@
+- statement: |-
+ CREATE TABLE foo(a INT);
+ RENAME TABLE foo to foo_delete;
+ DROP TABLE IF EXISTS foo_delete;
+- statement: |-
+ CREATE TABLE foo(a INT);
+ DROP TABLE IF EXISTS foo;
+ want:
+ - status: 2
+ code: 603
+ title: TABLE_DROP_NAMING_CONVENTION
+ content: '`foo` mismatches drop table naming convention, naming format should be "_delete$"'
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE foo(a INT);
+ RENAME TABLE foo to foo_delete;
+ CREATE TABLE bar(a INT);
+ DROP TABLE IF EXISTS foo_delete, bar;
+ want:
+ - status: 2
+ code: 603
+ title: TABLE_DROP_NAMING_CONVENTION
+ content: '`bar` mismatches drop table naming convention, naming format should be "_delete$"'
+ startposition:
+ line: 4
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/table_no_foreign_key.yaml b/backend/plugin/advisor/oceanbase/test/table_no_foreign_key.yaml
new file mode 100644
index 0000000000..c5cbe6391d
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/table_no_foreign_key.yaml
@@ -0,0 +1,24 @@
+- statement: |-
+ CREATE TABLE book(id INT);
+ ALTER TABLE tech_book ADD CONSTRAINT fk_tech_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id);
+ want:
+ - status: 2
+ code: 602
+ title: TABLE_NO_FOREIGN_KEY
+ content: Foreign key is not allowed in the table `tech_book`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t1 (id INT);
+ CREATE TABLE book(id INT, author_id INT, FOREIGN KEY fk_book_author_id_author_id (author_id) REFERENCES author (id));
+ want:
+ - status: 2
+ code: 602
+ title: TABLE_NO_FOREIGN_KEY
+ content: Foreign key is not allowed in the table `book`
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/test/table_require_pk.yaml b/backend/plugin/advisor/oceanbase/test/table_require_pk.yaml
new file mode 100644
index 0000000000..484efc2304
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/test/table_require_pk.yaml
@@ -0,0 +1,172 @@
+- statement: |
+ CREATE TABLE userTable(
+ id INT NOT NULL,
+ name VARCHAR(255) CHARSET ascii,
+ roomId INT,
+ time_created TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ time_updated TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ content BLOB NOT NULL COMMENT 'comment',
+ json_content JSON NOT NULL COMMENT 'comment',
+ INDEX idx1(name),
+ UNIQUE KEY uk1(id, name),
+ FOREIGN KEY fk1(roomId) REFERENCES room(id),
+ INDEX idx_userTable_content(content)) ENGINE = CSV COLLATE latin1_bin;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `userTable` requires PRIMARY KEY
+ startposition:
+ line: 1
+ column: 0
+ endposition: null
+- statement: |
+ CREATE TABLE user(
+ id INT PRIMARY KEY COMMENT 'comment',
+ name VARCHAR(255) NOT NULL DEFAULT '' COMMENT 'comment',
+ room_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ creator_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ created_ts TIMESTAMP NOT NULL DEFAULT NOW() COMMENT 'comment',
+ updater_id INT NOT NULL DEFAULT 0 COMMENT 'comment',
+ updated_ts TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW() COMMENT 'comment',
+ INDEX idx_user_name(name),
+ UNIQUE KEY uk_user_id_name(id, name)
+ ) ENGINE = INNODB COMMENT 'comment';
+- statement: |
+ CREATE TABLE t1(id INT PRIMARY KEY);
+ CREATE TABLE t2(id INT);
+ ALTER TABLE t2 ADD UNIQUE INDEX uk (id);
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t2` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t1(id INT, PRIMARY KEY (id));
+ CREATE TABLE t2(id INT);
+ ALTER TABLE t2 ADD COLUMN uid INT UNIQUE KEY;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t2` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t1(id INT PRIMARY KEY);
+ CREATE TABLE t2(id INT, PRIMARY KEY (id));
+- statement: |-
+ CREATE TABLE t1(id INT PRIMARY KEY);
+ CREATE TABLE t2(id INT);
+ DROP TABLE t1;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t2` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t1(id INT PRIMARY KEY);
+ CREATE TABLE t2(id INT);
+ DROP TABLE t1;
+ DROP TABLE t2;
+- statement: |-
+ CREATE TABLE t(id INT);
+ ALTER TABLE t ADD CONSTRAINT PRIMARY KEY (id);
+- statement: |-
+ CREATE TABLE t(id INT PRIMARY KEY);
+ ALTER TABLE t DROP PRIMARY KEY;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT PRIMARY KEY);
+ ALTER TABLE t DROP INDEX `PRIMARY`;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ CREATE TABLE t(id INT);
+ ALTER TABLE t ADD COLUMN name varchar(30) PRIMARY KEY;
+- statement: |-
+ CREATE TABLE t(id INT);
+ ALTER TABLE t CHANGE COLUMN id id INT PRIMARY KEY;
+- statement: ALTER TABLE tech_book CHANGE COLUMN id uid INT;
+- statement: |-
+ CREATE TABLE t(id INT);
+ ALTER TABLE t MODIFY COLUMN id INT PRIMARY KEY;
+- statement: ALTER TABLE tech_book MODIFY COLUMN id INT;
+- statement: |-
+ CREATE TABLE t(id INT, name varchar(30), PRIMARY KEY(id, name));
+ ALTER TABLE t DROP COLUMN id;
+- statement: |-
+ CREATE TABLE t(id INT, name varchar(30), comment varchar(255), PRIMARY KEY(id, name));
+ ALTER TABLE t ADD COLUMN age INT;
+ ALTER TABLE t DROP COLUMN id, DROP COLUMN name;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `t` requires PRIMARY KEY
+ startposition:
+ line: 3
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN c INT;
+ ALTER TABLE tech_book ADD COLUMN a int, DROP COLUMN id, DROP COLUMN name;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `tech_book` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: ALTER TABLE tech_book DROP COLUMN name;
+- statement: |-
+ ALTER TABLE tech_book ADD COLUMN c INT;
+ ALTER TABLE tech_book DROP COLUMN name, DROP COLUMN id;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `tech_book` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
+- statement: |-
+ ALTER TABLE tech_book CHANGE COLUMN id uid int;
+ ALTER TABLE tech_book ADD COLUMN a int, DROP COLUMN uid, DROP COLUMN name;
+ want:
+ - status: 2
+ code: 601
+ title: TABLE_REQUIRE_PK
+ content: Table `tech_book` requires PRIMARY KEY
+ startposition:
+ line: 2
+ column: 0
+ endposition: null
diff --git a/backend/plugin/advisor/oceanbase/utils.go b/backend/plugin/advisor/oceanbase/utils.go
new file mode 100644
index 0000000000..93d0380bca
--- /dev/null
+++ b/backend/plugin/advisor/oceanbase/utils.go
@@ -0,0 +1,388 @@
+// Package mysql implements the SQL advisor rules for MySQL.
+package oceanbase
+
+import (
+ "regexp"
+ "slices"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+)
+
+type columnSet map[string]bool
+
+func newColumnSet(columns []string) columnSet {
+ res := make(columnSet)
+ for _, col := range columns {
+ res[col] = true
+ }
+ return res
+}
+
+type tableState map[string]columnSet
+
+// tableList returns table list in lexicographical order.
+func (t tableState) tableList() []string {
+ var tableList []string
+ for tableName := range t {
+ tableList = append(tableList, tableName)
+ }
+ slices.Sort(tableList)
+ return tableList
+}
+
+// getTemplateRegexp formats the template as regex.
+func getTemplateRegexp(template string, templateList []string, tokens map[string]string) (*regexp.Regexp, error) {
+ for _, key := range templateList {
+ if token, ok := tokens[key]; ok {
+ template = strings.ReplaceAll(template, key, token)
+ }
+ }
+
+ return regexp.Compile(template)
+}
+
+// tableName --> columnName --> columnType.
+type tableColumnTypes map[string]map[string]string
+
+func (t tableColumnTypes) set(tableName string, columnName string, columnType string) {
+ if _, ok := t[tableName]; !ok {
+ t[tableName] = make(map[string]string)
+ }
+ t[tableName][columnName] = columnType
+}
+
+func (t tableColumnTypes) get(tableName string, columnName string) (columnType string, ok bool) {
+ if _, ok := t[tableName]; !ok {
+ return "", false
+ }
+ col, ok := t[tableName][columnName]
+ return col, ok
+}
+
+func (t tableColumnTypes) delete(tableName string, columnName string) {
+ if _, ok := t[tableName]; !ok {
+ return
+ }
+ delete(t[tableName], columnName)
+}
+
+// nolint:unused
+// omniTableName extracts the table name from a TableRef.
+func omniTableName(ref *ast.TableRef) string {
+ if ref == nil {
+ return ""
+ }
+ return ref.Name
+}
+
+// nolint:unused
+// omniColumnNames extracts column name list from a table-level constraint.
+func omniColumnNames(constraint *ast.Constraint) []string {
+ if constraint == nil {
+ return nil
+ }
+ return constraint.Columns
+}
+
+// nolint:unused
+// omniIndexColumns extracts column names from an index column list.
+// For expression-based index columns, it falls back to the column reference name.
+func omniIndexColumns(cols []*ast.IndexColumn) []string {
+ if len(cols) == 0 {
+ return nil
+ }
+ var names []string
+ for _, col := range cols {
+ if ref, ok := col.Expr.(*ast.ColumnRef); ok {
+ names = append(names, ref.Column)
+ }
+ }
+ return names
+}
+
+// nolint:unused
+// omniDataTypeName extracts the normalized (upper-case) type name string from a DataType.
+func omniDataTypeName(dt *ast.DataType) string {
+ if dt == nil {
+ return ""
+ }
+ return strings.ToUpper(dt.Name)
+}
+
+// nolint:unused
+// omniIsNullable checks if a column allows NULL.
+// A column is nullable unless it has a NOT NULL constraint or is a PRIMARY KEY.
+func omniIsNullable(col *ast.ColumnDef) bool {
+ if col == nil {
+ return true
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrNotNull || c.Type == ast.ColConstrPrimaryKey {
+ return false
+ }
+ }
+ return true
+}
+
+// nolint:unused
+// omniHasDefault checks if a column has a DEFAULT value.
+func omniHasDefault(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ if col.DefaultValue != nil {
+ return true
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrDefault {
+ return true
+ }
+ }
+ return false
+}
+
+// nolint:unused
+// omniIsAutoIncrement checks if a column has AUTO_INCREMENT.
+func omniIsAutoIncrement(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ return col.AutoIncrement
+}
+
+// nolint:unused
+// omniColumnComment extracts the COMMENT string from a column definition.
+func omniColumnComment(col *ast.ColumnDef) string {
+ if col == nil {
+ return ""
+ }
+ return col.Comment
+}
+
+// nolint:unused
+// omniTableOptionValue extracts a table option value by name (case-insensitive).
+func omniTableOptionValue(opts []*ast.TableOption, name string) string {
+ for _, opt := range opts {
+ if strings.EqualFold(opt.Name, name) {
+ return opt.Value
+ }
+ }
+ return ""
+}
+
+// nolint:unused
+// omniConstraintsByType filters constraints by the given type.
+func omniConstraintsByType(constraints []*ast.Constraint, typ ast.ConstraintType) []*ast.Constraint {
+ var result []*ast.Constraint
+ for _, c := range constraints {
+ if c.Type == typ {
+ result = append(result, c)
+ }
+ }
+ return result
+}
+
+// omniConstraintName returns the CONSTRAINT symbol, else the name written after
+// FOREIGN KEY, which omni keeps in IndexName.
+func omniConstraintName(c *ast.Constraint) string {
+ if c.Name != "" {
+ return c.Name
+ }
+ return c.IndexName
+}
+
+// omniDataTypeNameCompact returns a compact, lowercase type name string.
+func omniDataTypeNameCompact(dt *ast.DataType) string {
+ if dt == nil {
+ return ""
+ }
+ return strings.ToLower(dt.Name)
+}
+
+// omniIsIntegerType checks if the data type is an integer type.
+func omniIsIntegerType(dt *ast.DataType) bool {
+ if dt == nil {
+ return false
+ }
+ switch strings.ToUpper(dt.Name) {
+ case "INT", "TINYINT", "SMALLINT", "MEDIUMINT", "BIGINT", "INTEGER":
+ return true
+ default:
+ return false
+ }
+}
+
+// omniIsTimeType checks if the data type is DATETIME or TIMESTAMP.
+func omniIsTimeType(dt *ast.DataType) bool {
+ if dt == nil {
+ return false
+ }
+ switch strings.ToUpper(dt.Name) {
+ case "DATETIME", "TIMESTAMP":
+ return true
+ default:
+ return false
+ }
+}
+
+// omniIsDefaultCurrentTime checks if a column has DEFAULT CURRENT_TIMESTAMP / NOW().
+func omniIsDefaultCurrentTime(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ return isCurrentTimeFuncCall(col.DefaultValue)
+}
+
+// omniIsOnUpdateCurrentTime checks if a column has ON UPDATE CURRENT_TIMESTAMP / NOW().
+func omniIsOnUpdateCurrentTime(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ return isCurrentTimeFuncCall(col.OnUpdate)
+}
+
+// isCurrentTimeFuncCall checks if an expression is a CURRENT_TIMESTAMP/NOW() call.
+func isCurrentTimeFuncCall(expr ast.ExprNode) bool {
+ if expr == nil {
+ return false
+ }
+ fc, ok := expr.(*ast.FuncCallExpr)
+ if !ok {
+ return false
+ }
+ switch strings.ToUpper(fc.Name) {
+ case "NOW", "CURRENT_TIMESTAMP", "LOCALTIME", "LOCALTIMESTAMP":
+ return true
+ default:
+ return false
+ }
+}
+
+// omniGetColumnsFromCmd extracts column definitions from an AlterTableCmd.
+func omniGetColumnsFromCmd(cmd *ast.AlterTableCmd) []*ast.ColumnDef {
+ if cmd == nil {
+ return nil
+ }
+ switch cmd.Type {
+ case ast.ATAddColumn:
+ if cmd.Column != nil {
+ return []*ast.ColumnDef{cmd.Column}
+ }
+ return cmd.Columns
+ case ast.ATModifyColumn, ast.ATChangeColumn:
+ if cmd.Column != nil {
+ return []*ast.ColumnDef{cmd.Column}
+ }
+ default:
+ }
+ return nil
+}
+
+// nolint:unused
+// omniColumnName returns the effective column name for a command.
+func omniColumnName(cmd *ast.AlterTableCmd) string {
+ if cmd.Column != nil {
+ return cmd.Column.Name
+ }
+ return cmd.Name
+}
+
+func omniRenameTableName(cmd *ast.AlterTableCmd) string {
+ if cmd == nil || cmd.Type != ast.ATRenameTable {
+ return ""
+ }
+ if cmd.NewTable != nil {
+ return cmd.NewTable.Name
+ }
+ return cmd.NewName
+}
+
+// omniIsPrimaryKey checks if a column has a PRIMARY KEY constraint.
+func omniIsPrimaryKey(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ for _, c := range col.Constraints {
+ if c.Type == ast.ColConstrPrimaryKey {
+ return true
+ }
+ }
+ return false
+}
+
+// omniPKColumnNames returns a set of column names that are part of a primary key.
+func omniPKColumnNames(columns []*ast.ColumnDef, constraints []*ast.Constraint) map[string]bool {
+ result := make(map[string]bool)
+ for _, col := range columns {
+ if omniIsPrimaryKey(col) {
+ result[col.Name] = true
+ }
+ }
+ for _, c := range constraints {
+ if c.Type == ast.ConstrPrimaryKey {
+ for _, name := range c.Columns {
+ result[name] = true
+ }
+ }
+ }
+ return result
+}
+
+// omniColumnNeedDefault checks if a column is NOT NULL and needs a DEFAULT.
+// nolint:unused
+func omniColumnNeedDefault(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ return !omniIsNullable(col) && !omniHasDefault(col) && !omniIsPrimaryKey(col)
+}
+
+// omniIsDefaultExemptType checks if a column type is exempt from requiring DEFAULT
+// (BLOB, TEXT, JSON, GEOMETRY and spatial types).
+func omniIsDefaultExemptType(col *ast.ColumnDef) bool {
+ if col == nil || col.TypeName == nil {
+ return false
+ }
+ switch strings.ToUpper(col.TypeName.Name) {
+ case "BLOB", "TINYBLOB", "MEDIUMBLOB", "LONGBLOB",
+ "TEXT", "TINYTEXT", "MEDIUMTEXT", "LONGTEXT",
+ "JSON", "GEOMETRY", "POINT", "LINESTRING", "POLYGON",
+ "MULTIPOINT", "MULTILINESTRING", "MULTIPOLYGON", "GEOMETRYCOLLECTION",
+ "GEOMCOLLECTION":
+ return true
+ default:
+ return false
+ }
+}
+
+// omniColumnNeedDefaultNotNull checks if a NOT NULL column needs a DEFAULT value
+// (excludes BLOB, TEXT, JSON, GEOMETRY, and AUTO_INCREMENT columns).
+func omniColumnNeedDefaultNotNull(col *ast.ColumnDef) bool {
+ if col == nil {
+ return false
+ }
+ if omniIsNullable(col) || omniHasDefault(col) || omniIsPrimaryKey(col) || col.AutoIncrement {
+ return false
+ }
+ if col.TypeName != nil {
+ switch strings.ToUpper(col.TypeName.Name) {
+ case "BLOB", "TINYBLOB", "MEDIUMBLOB", "LONGBLOB",
+ "TEXT", "TINYTEXT", "MEDIUMTEXT", "LONGTEXT",
+ "JSON", "GEOMETRY", "SERIAL":
+ return false
+ }
+ }
+ return true
+}
+
+// contentStartIndex returns the offset of the first non-whitespace byte of text,
+// which is where a statement's own text begins after any leading blank lines.
+func contentStartIndex(text string) int {
+ for i, c := range text {
+ if c != ' ' && c != '\t' && c != '\n' && c != '\r' {
+ return i
+ }
+ }
+ return 0
+}
diff --git a/backend/plugin/db/mysql/mysql.go b/backend/plugin/db/mysql/mysql.go
index 8e984eab00..39e984a158 100644
--- a/backend/plugin/db/mysql/mysql.go
+++ b/backend/plugin/db/mysql/mysql.go
@@ -43,8 +43,6 @@ var (
// MariaDB-only TABLE_TYPE values. Both kinds share the table namespace.
mariaDBSystemVersionedTableType = "SYSTEM VERSIONED"
mariaDBSequenceTableType = "SEQUENCE"
- // OceanBase-only TABLE_TYPE value; the kind shares the table namespace.
- oceanBaseExternalTableType = "EXTERNAL TABLE"
_ db.Driver = (*Driver)(nil)
)
@@ -52,7 +50,6 @@ var (
func init() {
db.Register(storepb.Engine_MYSQL, newDriver)
db.Register(storepb.Engine_MARIADB, newDriver)
- db.Register(storepb.Engine_OCEANBASE, newDriver)
}
// validateMySQLExtraConnectionParameters validates that no dangerous parameters are present.
diff --git a/backend/plugin/db/mysql/stats.go b/backend/plugin/db/mysql/stats.go
index 6835dca530..28e6eaede6 100644
--- a/backend/plugin/db/mysql/stats.go
+++ b/backend/plugin/db/mysql/stats.go
@@ -13,7 +13,6 @@ import (
"github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/common/log"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
)
@@ -23,19 +22,6 @@ const erUnknownSystemVariable = 1193
// CountAffectedRows returns the planner's estimate of the rows the INSERT, UPDATE, or DELETE
// statement modifies.
func (d *Driver) CountAffectedRows(ctx context.Context, statement string) (int64, error) {
- if d.dbType == storepb.Engine_OCEANBASE {
- rows, err := d.db.QueryContext(ctx, "EXPLAIN FORMAT=JSON "+statement)
- if err != nil {
- return 0, err
- }
- defer rows.Close()
- plan, err := readExplainJSON(rows)
- if err != nil {
- return 0, err
- }
- return mysqlparser.EstimateAffectedRowsFromOceanBaseExplainJSON(plan)
- }
-
list, err := mysqlparser.ParseMySQL(statement)
if err != nil {
return 0, errors.Wrap(err, "failed to parse statement")
@@ -150,7 +136,7 @@ func ExplainJSON(ctx context.Context, db *sql.DB, statement string) (string, err
return readExplainJSON(rows)
}
-// readExplainJSON concatenates the plan rows; OceanBase splits its JSON plan across rows.
+// readExplainJSON concatenates the plan rows into one JSON document.
func readExplainJSON(rows *sql.Rows) (string, error) {
var plan strings.Builder
for rows.Next() {
diff --git a/backend/plugin/db/mysql/stats_test.go b/backend/plugin/db/mysql/stats_test.go
index f13615ba78..8181eeea16 100644
--- a/backend/plugin/db/mysql/stats_test.go
+++ b/backend/plugin/db/mysql/stats_test.go
@@ -15,8 +15,6 @@ import (
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
)
-var testOceanBaseExplainRows [][]driver.Value
-
var (
// testMySQLExplainJSON is the plan the fake MySQL server returns for EXPLAIN FORMAT=JSON.
testMySQLExplainJSON string
@@ -36,34 +34,9 @@ type testMySQLStatement struct {
}
func init() {
- sql.Register("test_oceanbase_explain", testOceanBaseExplainDriver{})
sql.Register("test_mysql_explain", testMySQLExplainDriver{})
}
-type testOceanBaseExplainDriver struct{}
-
-func (testOceanBaseExplainDriver) Open(string) (driver.Conn, error) {
- return testOceanBaseExplainConn{}, nil
-}
-
-type testOceanBaseExplainConn struct{}
-
-func (testOceanBaseExplainConn) Prepare(string) (driver.Stmt, error) {
- return nil, driver.ErrSkip
-}
-
-func (testOceanBaseExplainConn) Close() error {
- return nil
-}
-
-func (testOceanBaseExplainConn) Begin() (driver.Tx, error) {
- return nil, driver.ErrSkip
-}
-
-func (testOceanBaseExplainConn) QueryContext(context.Context, string, []driver.NamedValue) (driver.Rows, error) {
- return &testExplainResultRows{rows: testOceanBaseExplainRows}, nil
-}
-
type testMySQLExplainDriver struct{}
func (testMySQLExplainDriver) Open(string) (driver.Conn, error) {
@@ -345,41 +318,3 @@ func TestCountAffectedRowsReportsUninterpretablePlan(t *testing.T) {
_, err := d.CountAffectedRows(context.Background(), "INSERT INTO t2 SELECT id, ROW_NUMBER() OVER () FROM t;")
require.ErrorContains(t, err, `table "t2" in the plan has no row estimate`)
}
-
-func TestCountAffectedRowsForOceanBase(t *testing.T) {
- db, err := sql.Open("test_oceanbase_explain", "")
- require.NoError(t, err)
- defer db.Close()
- d := &Driver{dbType: storepb.Engine_OCEANBASE, db: db}
-
- // OceanBase splits the JSON plan across rows.
- testOceanBaseExplainRows = [][]driver.Value{
- {`{`},
- {` "ID":0,`},
- {` "OPERATOR":"UPDATE",`},
- {` "NAME":"",`},
- {` "EST.ROWS":1000,`},
- {` "EST.TIME(us)":7680,`},
- {` "output":"",`},
- {` "CHILD_1": {`},
- {` "ID":1,`},
- {` "OPERATOR":"TABLE RANGE SCAN",`},
- {` "NAME":"dba_test_1",`},
- {` "EST.ROWS":1000,`},
- {` "EST.TIME(us)":91,`},
- {` "output":"output([dba_test_1.id], [dba_test_1.log_id])"`},
- {` }`},
- {`}`},
- }
- got, err := d.CountAffectedRows(context.Background(), "update dba_test_1 set log_id=1 where id < 1000;")
- require.NoError(t, err)
- require.Equal(t, int64(1000), got)
-
- testOceanBaseExplainRows = [][]driver.Value{{`{"ID":0,"OPERATOR":"UPDATE","NAME":""}`}}
- _, err = d.CountAffectedRows(context.Background(), "update dba_test_1 set log_id=1 where id < 1000;")
- require.ErrorContains(t, err, `operator "UPDATE" has no EST.ROWS`)
-
- testOceanBaseExplainRows = nil
- _, err = d.CountAffectedRows(context.Background(), "update dba_test_1 set log_id=1 where id < 1000;")
- require.Error(t, err)
-}
diff --git a/backend/plugin/db/mysql/sync.go b/backend/plugin/db/mysql/sync.go
index 6d6d1b2b7e..9985ed4724 100644
--- a/backend/plugin/db/mysql/sync.go
+++ b/backend/plugin/db/mysql/sync.go
@@ -17,7 +17,6 @@ import (
metadatapb "github.com/bytebase/omni/metadata"
"golang.org/x/text/encoding/charmap"
"golang.org/x/text/transform"
- "google.golang.org/protobuf/proto"
"github.com/blang/semver/v4"
"github.com/pkg/errors"
@@ -587,7 +586,6 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMe
// Keyed on the registered engine, not the server: an instance registered as MySQL
// keeps its MySQL sync result even when the server is MariaDB.
mariaDBInstance := d.dbType == storepb.Engine_MARIADB
- oceanBaseInstance := d.dbType == storepb.Engine_OCEANBASE
var sequences []*metadatapb.SequenceMetadata
for tableRows.Next() {
var tableName, tableType, engine, collation, createOptions, comment, charset string
@@ -671,11 +669,6 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMe
DataType: mariaDBSequenceDataType(columnMap[key]),
Comment: comment,
})
- case oceanBaseInstance && tableType == oceanBaseExternalTableType:
- schemaMetadata.ExternalTables = append(schemaMetadata.ExternalTables, &metadatapb.ExternalTableMetadata{
- Name: tableName,
- Columns: columnMap[key],
- })
default:
// Unknown table type, skip
}
@@ -687,13 +680,6 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMe
return nil, err
}
schemaMetadata.Sequences = sequences
- if oceanBaseInstance {
- materializedViews, err := d.listOceanBaseMaterializedViews(ctx, d.databaseName, schemaMetadata.Tables)
- if err != nil {
- return nil, err
- }
- schemaMetadata.MaterializedViews = materializedViews
- }
databaseMetadata := &metadatapb.DatabaseSchemaMetadata{
Name: d.databaseName,
@@ -762,60 +748,7 @@ func (d *Driver) readMariaDBSequenceAttributes(ctx context.Context, databaseName
return nil
}
-// listOceanBaseMaterializedViews reads the database's materialized views. OceanBase lists one
-// in neither information_schema.TABLES nor VIEWS, only its storage table __mv_container_<id>,
-// which carries the view's comment and indexes and stays synced as a table. A failed read, such
-// as one without SELECT on the oceanbase database, leaves the list empty; a caller can tell,
-// because a container table is then synced without its materialized view.
-func (d *Driver) listOceanBaseMaterializedViews(ctx context.Context, databaseName string, tables []*metadatapb.TableMetadata) ([]*metadatapb.MaterializedViewMetadata, error) {
- query := `
- SELECT MVIEW_NAME, CONTAINER_NAME, QUERY
- FROM oceanbase.DBA_MVIEWS
- WHERE OWNER = ?
- ORDER BY MVIEW_NAME`
- rows, err := d.db.QueryContext(ctx, query, databaseName)
- if err != nil {
- if ctx.Err() != nil {
- return nil, ctx.Err()
- }
- slog.Warn("failed to list OceanBase materialized views", slog.String("database", databaseName), log.BBError(err))
- return nil, nil
- }
- defer rows.Close()
- containers := make(map[string]*metadatapb.TableMetadata, len(tables))
- for _, table := range tables {
- containers[table.Name] = table
- }
- var views []*metadatapb.MaterializedViewMetadata
- for rows.Next() {
- var name, containerName, definition string
- if err := rows.Scan(&name, &containerName, &definition); err != nil {
- return nil, err
- }
- view := &metadatapb.MaterializedViewMetadata{
- Name: name,
- Definition: definition,
- // No MySQL-family DDL writer renders OceanBase's CREATE MATERIALIZED VIEW.
- SkipDump: true,
- }
- if container, ok := containers[containerName]; ok {
- view.Comment = container.Comment
- for _, index := range container.Indexes {
- view.Indexes = append(view.Indexes, proto.CloneOf(index))
- }
- }
- views = append(views, view)
- }
- if err := rows.Err(); err != nil {
- return nil, util.FormatErrorWithQuery(err, query)
- }
- return views, nil
-}
-
func (d *Driver) getEventList(ctx context.Context, databaseName string) ([]*metadatapb.EventMetadata, error) {
- if d.dbType == storepb.Engine_OCEANBASE {
- return d.listOceanBaseEvents(ctx, databaseName)
- }
listEventsQuery := `
SELECT
EVENT_NAME,
@@ -865,39 +798,6 @@ func (d *Driver) getEventList(ctx context.Context, databaseName string) ([]*meta
return events, nil
}
-// listOceanBaseEvents lists the database's events by name only. OceanBase rejects SHOW CREATE
-// EVENT, and information_schema.EVENTS cannot rebuild it: it shows the schedule in the session
-// time zone, flattens a BEGIN...END body, and does not record the creating session's time zone,
-// SQL mode, or character set. The definition stays empty, so the DDL writers in
-// backend/plugin/schema/mysql skip the event.
-//
-// A database created under a dropped one's name also lists the dropped one's events, which
-// information_schema cannot tell from its own; DISTINCT lists a name both have once.
-func (d *Driver) listOceanBaseEvents(ctx context.Context, databaseName string) ([]*metadatapb.EventMetadata, error) {
- query := `
- SELECT DISTINCT EVENT_NAME
- FROM information_schema.EVENTS
- WHERE EVENT_SCHEMA = ?
- ORDER BY EVENT_NAME`
- rows, err := d.db.QueryContext(ctx, query, databaseName)
- if err != nil {
- return nil, util.FormatErrorWithQuery(err, query)
- }
- defer rows.Close()
- var events []*metadatapb.EventMetadata
- for rows.Next() {
- event := &metadatapb.EventMetadata{}
- if err := rows.Scan(&event.Name); err != nil {
- return nil, err
- }
- events = append(events, event)
- }
- if err := rows.Err(); err != nil {
- return nil, util.FormatErrorWithQuery(err, query)
- }
- return events, nil
-}
-
func (d *Driver) getCreateEventStmt(ctx context.Context, databaseName string, name string) (string, error) {
query := fmt.Sprintf("SHOW CREATE EVENT `%s`.`%s`", databaseName, name)
rows, err := d.db.QueryContext(ctx, query)
diff --git a/backend/plugin/db/oceanbase/dump.go b/backend/plugin/db/oceanbase/dump.go
new file mode 100644
index 0000000000..129591f74c
--- /dev/null
+++ b/backend/plugin/db/oceanbase/dump.go
@@ -0,0 +1,25 @@
+package oceanbase
+
+import (
+ "context"
+ "io"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/schema"
+)
+
+// Dump dumps the database.
+func (*Driver) Dump(_ context.Context, out io.Writer, dbMetadata *metadatapb.DatabaseSchemaMetadata) error {
+ text, err := schema.GetDatabaseDefinition(storepb.Engine_OCEANBASE, schema.GetDefinitionContext{
+ PrintHeader: true,
+ }, dbMetadata)
+ if err != nil {
+ return errors.Wrapf(err, "failed to get database definition")
+ }
+
+ _, err = out.Write([]byte(text))
+ return err
+}
diff --git a/backend/plugin/db/oceanbase/main_test.go b/backend/plugin/db/oceanbase/main_test.go
new file mode 100644
index 0000000000..5fecc12543
--- /dev/null
+++ b/backend/plugin/db/oceanbase/main_test.go
@@ -0,0 +1,9 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/bytebase/bytebase/backend/common/testcontainer"
+)
+
+func TestMain(m *testing.M) { testcontainer.Main(m) }
diff --git a/backend/plugin/db/oceanbase/oceanbase.go b/backend/plugin/db/oceanbase/oceanbase.go
new file mode 100644
index 0000000000..5b37692b74
--- /dev/null
+++ b/backend/plugin/db/oceanbase/oceanbase.go
@@ -0,0 +1,691 @@
+// Package oceanbase is the plugin for the OceanBase driver. OceanBase speaks the
+// MySQL wire protocol but its information_schema and EXPLAIN differ, so it syncs
+// and plans on its own.
+package oceanbase
+
+import (
+ "context"
+ "crypto/tls"
+ "crypto/x509"
+ "database/sql"
+ "database/sql/driver"
+ "fmt"
+ "io"
+ "log/slog"
+ "net"
+ "net/http"
+ "regexp"
+ "strings"
+ "sync/atomic"
+ "time"
+
+ "github.com/aws/aws-sdk-go-v2/feature/rds/auth"
+ "github.com/go-sql-driver/mysql"
+ "github.com/google/uuid"
+ "github.com/pkg/errors"
+ "go.uber.org/multierr"
+ "golang.org/x/crypto/ssh"
+ "golang.org/x/sync/singleflight"
+ "google.golang.org/protobuf/types/known/durationpb"
+
+ "github.com/bytebase/bytebase/backend/common"
+ "github.com/bytebase/bytebase/backend/common/log"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
+ "github.com/bytebase/bytebase/backend/plugin/db"
+ "github.com/bytebase/bytebase/backend/plugin/db/transaction"
+ "github.com/bytebase/bytebase/backend/plugin/db/util"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+var (
+ baseTableType = "BASE TABLE"
+ viewTableType = "VIEW"
+ // OceanBase-only TABLE_TYPE value; the kind shares the table namespace.
+ externalTableType = "EXTERNAL TABLE"
+
+ _ db.Driver = (*Driver)(nil)
+)
+
+func init() {
+ db.Register(storepb.Engine_OCEANBASE, newDriver)
+}
+
+// validateExtraConnectionParameters validates that no dangerous parameters are present.
+func validateExtraConnectionParameters(params map[string]string) error {
+ for key := range params {
+ // Normalize key to lowercase for case-insensitive comparison
+ normalizedKey := strings.ToLower(strings.TrimSpace(key))
+ if normalizedKey == "allowallfiles" {
+ // Disables file allowlist for LOAD DATA LOCAL INFILE and allows all files (might be insecure)
+ return errors.Errorf("connection parameter %q is not allowed for security reasons", key)
+ }
+ }
+ return nil
+}
+
+// Driver is the OceanBase driver.
+type Driver struct {
+ db *sql.DB
+ databaseName string
+ sshClient *ssh.Client
+
+ // Called upon driver.Open() finishes.
+ openCleanUp []func()
+}
+
+func newDriver() db.Driver {
+ return &Driver{}
+}
+
+// Open opens an OceanBase driver.
+func (d *Driver) Open(ctx context.Context, _ storepb.Engine, connCfg db.ConnectionConfig) (db.Driver, error) {
+ defer func() {
+ for _, f := range d.openCleanUp {
+ f()
+ }
+ }()
+
+ var dsn string
+ var err error
+ switch connCfg.DataSource.GetAuthenticationType() {
+ case storepb.DataSource_GOOGLE_CLOUD_SQL_IAM:
+ dsn, err = getCloudSQLConnection(ctx, connCfg)
+ case storepb.DataSource_AWS_RDS_IAM:
+ dsn, err = d.getRDSConnection(ctx, connCfg)
+ default:
+ dsn, err = d.getConnection(connCfg)
+ }
+ if err != nil {
+ return nil, err
+ }
+
+ db, err := sql.Open("mysql", dsn)
+ if err != nil {
+ return nil, err
+ }
+ d.db = db
+ // TODO(d): remove the work-around once we have clean-up the migration connection hack.
+ db.SetConnMaxLifetime(2 * time.Hour)
+ db.SetMaxOpenConns(50)
+ db.SetMaxIdleConns(15)
+ d.databaseName = connCfg.ConnectionContext.DatabaseName
+
+ return d, nil
+}
+
+func (d *Driver) getConnection(connCfg db.ConnectionConfig) (string, error) {
+ protocol := "tcp"
+ if strings.HasPrefix(connCfg.DataSource.Host, "/") {
+ protocol = "unix"
+ }
+
+ params := []string{"multiStatements=true", "maxAllowedPacket=0"}
+ if err := validateExtraConnectionParameters(connCfg.DataSource.GetExtraConnectionParameters()); err != nil {
+ return "", err
+ }
+ for key, value := range connCfg.DataSource.GetExtraConnectionParameters() {
+ params = append(params, fmt.Sprintf("%s=%s", key, value))
+ }
+ if connCfg.DataSource.GetSshHost() != "" {
+ sshClient, err := util.GetSSHClient(connCfg.DataSource)
+ if err != nil {
+ return "", err
+ }
+ d.sshClient = sshClient
+ protocol = "mysql-tcp-" + uuid.NewString()[:8]
+ // Now we register the dialer with the ssh connection as a parameter.
+ mysql.RegisterDialContext(protocol, func(_ context.Context, addr string) (net.Conn, error) {
+ return sshClient.Dial("tcp", addr)
+ })
+ }
+
+ tlscfg, err := util.GetTLSConfig(connCfg.DataSource)
+ if err != nil {
+ return "", errors.Wrap(err, "sql: tls config error")
+ }
+ tlsKey := uuid.NewString()
+ if tlscfg != nil {
+ if err := mysql.RegisterTLSConfig(tlsKey, tlscfg); err != nil {
+ return "", errors.Wrap(err, "sql: failed to register tls config")
+ }
+ // TLS config is only used during sql.Open, so should be safe to deregister afterwards.
+ d.openCleanUp = append(d.openCleanUp, func() { mysql.DeregisterTLSConfig(tlsKey) })
+ params = append(params, fmt.Sprintf("tls=%s", tlsKey))
+ }
+ return fmt.Sprintf("%s:%s@%s(%s:%s)/%s?%s", connCfg.DataSource.Username, connCfg.Password, protocol, connCfg.DataSource.Host, connCfg.DataSource.Port, connCfg.ConnectionContext.DatabaseName, strings.Join(params, "&")), nil
+}
+
+// rdsCertBundleURL is a variable so tests can point it at a local server.
+var rdsCertBundleURL = "https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem"
+
+// rdsCertFetchTimeout bounds the download so a stalled fetch cannot hold a
+// connection attempt open indefinitely.
+const rdsCertFetchTimeout = 30 * time.Second
+
+// maxRDSCertBundleSize bounds the downloaded bundle so a misbehaving endpoint
+// cannot stream unbounded data into memory (the real global bundle is ~165 KB).
+const maxRDSCertBundleSize int64 = 4 << 20
+
+// rdsCertPool caches the downloaded bundle for the process lifetime.
+var rdsCertPool atomic.Pointer[x509.CertPool]
+
+// rdsCertGroup collapses concurrent cold-start downloads into one request.
+var rdsCertGroup singleflight.Group
+
+// getRDSCertPool downloads and returns the RDS CA certificate pool.
+// AWS RDS connection with IAM require TLS connection.
+//
+// refs:
+// https://github.com/aws/aws-sdk-go/issues/1248
+// https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-ssl-connections.html
+func getRDSCertPool(ctx context.Context) (*x509.CertPool, error) {
+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, rdsCertBundleURL, nil)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to build request for rds cert")
+ }
+
+ client := &http.Client{Timeout: rdsCertFetchTimeout}
+ resp, err := client.Do(req)
+ if err != nil {
+ return nil, err
+ }
+ defer resp.Body.Close()
+
+ // Without this an error page would reach AppendCertsFromPEM and surface as
+ // "failed to parse RDS CA certificates", hiding the real cause.
+ if resp.StatusCode != http.StatusOK {
+ return nil, errors.Errorf("failed to download RDS CA certificates: %s", resp.Status)
+ }
+
+ pem, err := io.ReadAll(io.LimitReader(resp.Body, maxRDSCertBundleSize+1))
+ if err != nil {
+ return nil, err
+ }
+ if int64(len(pem)) > maxRDSCertBundleSize {
+ return nil, errors.Errorf("RDS CA bundle exceeds %d bytes", maxRDSCertBundleSize)
+ }
+
+ rootCertPool := x509.NewCertPool()
+ if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
+ return nil, errors.Errorf("failed to parse RDS CA certificates")
+ }
+
+ return rootCertPool, nil
+}
+
+// cachedRDSCertPool returns the AWS RDS CA bundle, downloading it once per
+// process. Only successes are cached, so a transient failure can still recover.
+func cachedRDSCertPool(ctx context.Context) (*x509.CertPool, error) {
+ if pool := rdsCertPool.Load(); pool != nil {
+ return pool, nil
+ }
+ // Collapse a cold-start burst into one download. The shared fetch does not
+ // inherit any one caller's context, so the caller that starts it cannot
+ // cancel it for everybody else; each caller waits on its own context below.
+ ch := rdsCertGroup.DoChan("", func() (any, error) {
+ // Double check after entering singleflight.
+ if pool := rdsCertPool.Load(); pool != nil {
+ return pool, nil
+ }
+ fetchCtx, cancel := context.WithTimeout(context.WithoutCancel(ctx), rdsCertFetchTimeout)
+ defer cancel()
+ pool, err := getRDSCertPool(fetchCtx)
+ if err != nil {
+ return nil, err
+ }
+ rdsCertPool.Store(pool)
+ return pool, nil
+ })
+ select {
+ case <-ctx.Done():
+ return nil, ctx.Err()
+ case res := <-ch:
+ if res.Err != nil {
+ return nil, res.Err
+ }
+ pool, ok := res.Val.(*x509.CertPool)
+ if !ok {
+ return nil, errors.Errorf("unexpected RDS cert pool type %T", res.Val)
+ }
+ return pool, nil
+ }
+}
+
+// rdsRootCAs prefers an operator-supplied CA, so a deployment can serve RDS IAM
+// connections without any outbound network access.
+func rdsRootCAs(ctx context.Context, dataSource *storepb.DataSource) (*x509.CertPool, error) {
+ if ca := dataSource.GetSslCa(); ca != "" {
+ pool := x509.NewCertPool()
+ if !pool.AppendCertsFromPEM([]byte(ca)) {
+ return nil, errors.Errorf("failed to parse ssl_ca certificates")
+ }
+ return pool, nil
+ }
+ return cachedRDSCertPool(ctx)
+}
+
+// rdsTLSConfig builds the TLS config for an RDS IAM connection. IAM auth always
+// requires TLS, so this always returns a config.
+func rdsTLSConfig(ctx context.Context, dataSource *storepb.DataSource) (*tls.Config, error) {
+ if !dataSource.GetVerifyTlsCertificate() {
+ // No verifier runs in this mode, so a root pool would never be consulted.
+ return &tls.Config{InsecureSkipVerify: true}, nil // NOSONAR(go:S4830,go:S5527) operator disabled verification (verify_tls_certificate=false)
+ }
+ rootCertPool, err := rdsRootCAs(ctx, dataSource)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to get RDS cert pool")
+ }
+ return &tls.Config{ // NOSONAR(go:S4830) VerifyPeerCertificate below verifies chain and hostname
+ RootCAs: rootCertPool,
+ InsecureSkipVerify: true, // superseded by VerifyPeerCertificate below
+ VerifyPeerCertificate: util.CreateCertificateVerifier(rootCertPool, dataSource.GetHost()),
+ }, nil
+}
+
+// getRDSConnection returns the connection string with IAM for AWS RDS.
+//
+// refs:
+// https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.Go.html
+// https://repost.aws/knowledge-center/rds-mysql-access-denied
+func (d *Driver) getRDSConnection(ctx context.Context, connCfg db.ConnectionConfig) (string, error) {
+ dbEndpoint := fmt.Sprintf("%s:%s", connCfg.DataSource.Host, connCfg.DataSource.Port)
+ cfg, err := util.GetAWSConnectionConfig(ctx, connCfg)
+ if err != nil {
+ return "", errors.Wrap(err, "load aws config failed")
+ }
+
+ // Handle cross-account role assumption if configured
+ if err := util.AssumeRoleIfNeeded(ctx, &cfg, connCfg.ConnectionContext, connCfg.DataSource.GetAwsCredential()); err != nil {
+ return "", err
+ }
+
+ authenticationToken, err := auth.BuildAuthToken(
+ ctx, dbEndpoint, connCfg.DataSource.GetRegion(), connCfg.DataSource.Username, cfg.Credentials)
+ if err != nil {
+ return "", errors.Wrap(err, "failed to create authentication token")
+ }
+
+ tlsConfig, err := rdsTLSConfig(ctx, connCfg.DataSource)
+ if err != nil {
+ return "", err
+ }
+
+ // Create TLS config with unique name for this connection
+ tlsKey := uuid.NewString()
+
+ // Register the TLS config with unique name
+ if err := mysql.RegisterTLSConfig(tlsKey, tlsConfig); err != nil {
+ return "", errors.Wrap(err, "failed to register RDS TLS config")
+ }
+
+ // Clean up the TLS config after connection
+ d.openCleanUp = append(d.openCleanUp, func() { mysql.DeregisterTLSConfig(tlsKey) })
+
+ return fmt.Sprintf("%s:%s@tcp(%s)/%s?tls=%s&allowCleartextPasswords=true&multiStatements=true&maxAllowedPacket=0",
+ connCfg.DataSource.Username, authenticationToken, dbEndpoint, connCfg.ConnectionContext.DatabaseName, tlsKey,
+ ), nil
+}
+
+func getCloudSQLConnection(ctx context.Context, connCfg db.ConnectionConfig) (string, error) {
+ d, err := util.GetGCPConnectionConfig(ctx, connCfg)
+ if err != nil {
+ return "", errors.Wrap(err, "load gcp config failed")
+ }
+
+ mysql.RegisterDialContext("cloudsqlconn",
+ func(ctx context.Context, _ string) (net.Conn, error) {
+ return d.Dial(ctx, connCfg.DataSource.Host)
+ })
+
+ return fmt.Sprintf("%s:empty@cloudsqlconn(localhost:3306)/%s?parseTime=true&multiStatements=true&maxAllowedPacket=0",
+ connCfg.DataSource.Username, connCfg.ConnectionContext.DatabaseName), nil
+}
+
+// Close closes the driver.
+func (d *Driver) Close(context.Context) error {
+ var err error
+ err = multierr.Append(err, d.db.Close())
+ if d.sshClient != nil {
+ err = multierr.Append(err, d.sshClient.Close())
+ }
+ return err
+}
+
+// Ping pings the database.
+func (d *Driver) Ping(ctx context.Context) error {
+ return d.db.PingContext(ctx)
+}
+
+// GetDB gets the database.
+func (d *Driver) GetDB() *sql.DB {
+ return d.db
+}
+
+// getVersion gets the version.
+func (d *Driver) getVersion(ctx context.Context) (string, string, error) {
+ query := "SELECT VERSION()"
+ var version string
+ if err := d.db.QueryRowContext(ctx, query).Scan(&version); err != nil {
+ if err == sql.ErrNoRows {
+ return "", "", common.FormatDBErrorEmptyRowWithQuery(query)
+ }
+ return "", "", util.FormatErrorWithQuery(err, query)
+ }
+
+ return parseVersion(version)
+}
+
+func parseVersion(version string) (string, string, error) {
+ if loc := regexp.MustCompile(`^\d+.\d+.\d+`).FindStringIndex(version); loc != nil {
+ return version[loc[0]:loc[1]], version[loc[1]:], nil
+ }
+ return "", "", errors.Errorf("failed to parse version %q", version)
+}
+
+func buildExecuteCommands(statement string) ([]base.Statement, error) {
+ if len(statement) > common.MaxSheetCheckSize {
+ return []base.Statement{{Text: statement}}, nil
+ }
+
+ commands, err := oceanbaseparser.SplitSQL(statement)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to split sql")
+ }
+ commands = base.FilterEmptyStatements(commands)
+ if len(commands) == 0 {
+ return nil, nil
+ }
+ if len(commands) > common.MaximumCommands {
+ return []base.Statement{{Text: statement}}, nil
+ }
+
+ return commands, nil
+}
+
+// Execute executes a SQL statement.
+func (d *Driver) Execute(ctx context.Context, statement string, opts db.ExecuteOptions) (int64, error) {
+ // Parse transaction configuration from the script
+ transactionConfig, cleanedStatement := base.ParseTransactionConfig(statement)
+ statement = cleanedStatement
+
+ // Apply default when transaction mode is not specified
+ if transactionConfig.Mode == transaction.ModeUnspecified {
+ transactionConfig.Mode = transaction.DefaultMode()
+ }
+
+ conn, err := d.db.Conn(ctx)
+ if err != nil {
+ return 0, err
+ }
+ defer conn.Close()
+
+ connectionID, err := getConnectionID(ctx, conn)
+ if err != nil {
+ return 0, err
+ }
+ slog.Debug("connectionID", slog.String("connectionID", connectionID))
+
+ commands, err := buildExecuteCommands(statement)
+ if err != nil {
+ return 0, err
+ }
+ if len(commands) == 0 {
+ return 0, nil
+ }
+
+ // Validate isolation level for MySQL if specified
+ if transactionConfig.Isolation != transaction.IsolationLevelDefault {
+ validLevels := map[transaction.IsolationLevel]bool{
+ transaction.IsolationLevelReadUncommitted: true,
+ transaction.IsolationLevelReadCommitted: true,
+ transaction.IsolationLevelRepeatableRead: true,
+ transaction.IsolationLevelSerializable: true,
+ }
+ if !validLevels[transactionConfig.Isolation] {
+ return 0, errors.Errorf("invalid isolation level for MySQL: %s. Supported levels: READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, SERIALIZABLE", transactionConfig.Isolation)
+ }
+ }
+
+ // Execute based on transaction mode
+ if transactionConfig.Mode == transaction.ModeOff {
+ return d.executeInAutoCommitMode(ctx, conn, commands, opts, connectionID)
+ }
+ return d.executeInTransactionMode(ctx, conn, commands, opts, connectionID, transactionConfig.Isolation)
+}
+
+// executeInTransactionMode executes statements within a single transaction
+func (d *Driver) executeInTransactionMode(ctx context.Context, conn *sql.Conn, commands []base.Statement, opts db.ExecuteOptions, connectionID string, isolationLevel transaction.IsolationLevel) (int64, error) {
+ var totalRowsAffected int64
+
+ if err := conn.Raw(func(driverConn any) error {
+ //nolint
+ exer := driverConn.(driver.ExecerContext)
+ //nolint
+ txer := driverConn.(driver.ConnBeginTx)
+
+ // Set isolation level if specified
+ txOptions := driver.TxOptions{}
+ if isolationLevel != transaction.IsolationLevelDefault {
+ txOptions.Isolation = driver.IsolationLevel(transaction.ToSQLIsolation(isolationLevel))
+ }
+
+ tx, err := txer.BeginTx(ctx, txOptions)
+ if err != nil {
+ opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_BEGIN, err.Error())
+ return err
+ } else {
+ opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_BEGIN, "")
+ }
+
+ committed := false
+ defer func() {
+ err := tx.Rollback()
+ if committed {
+ return
+ }
+ var rerr string
+ if err != nil {
+ rerr = err.Error()
+ }
+ opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_ROLLBACK, rerr)
+ }()
+
+ for _, command := range commands {
+ opts.LogCommandExecute(command.Range, command.Text)
+
+ sqlWithBytebaseAppComment := util.MySQLPrependBytebaseAppComment(command.Text)
+ sqlResult, err := exer.ExecContext(ctx, sqlWithBytebaseAppComment, nil)
+ if err != nil {
+ if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
+ slog.Info("cancel connection", slog.String("connectionID", connectionID))
+ if err := d.StopConnectionByID(connectionID); err != nil {
+ slog.Error("failed to cancel connection", slog.String("connectionID", connectionID), log.BBError(err))
+ }
+ }
+
+ opts.LogCommandResponse(0, nil, err.Error())
+
+ return err
+ }
+
+ allRowsAffected := sqlResult.(mysql.Result).AllRowsAffected()
+ var rowsAffected int64
+ var allRowsAffectedInt64 []int64
+ for _, a := range allRowsAffected {
+ rowsAffected += a
+ allRowsAffectedInt64 = append(allRowsAffectedInt64, a)
+ }
+ totalRowsAffected += rowsAffected
+
+ opts.LogCommandResponse(rowsAffected, allRowsAffectedInt64, "")
+ }
+
+ if err := tx.Commit(); err != nil {
+ opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_COMMIT, err.Error())
+ return errors.Wrapf(err, "failed to commit execute transaction")
+ } else {
+ opts.LogTransactionControl(storepb.TaskRunLog_TransactionControl_COMMIT, "")
+ committed = true
+ }
+ return nil
+ }); err != nil {
+ return 0, err
+ }
+
+ return totalRowsAffected, nil
+}
+
+// executeInAutoCommitMode executes statements sequentially in auto-commit mode
+func (d *Driver) executeInAutoCommitMode(ctx context.Context, conn *sql.Conn, commands []base.Statement, opts db.ExecuteOptions, connectionID string) (int64, error) {
+ var totalRowsAffected int64
+
+ if err := conn.Raw(func(driverConn any) error {
+ //nolint
+ exer := driverConn.(driver.ExecerContext)
+
+ for _, command := range commands {
+ opts.LogCommandExecute(command.Range, command.Text)
+
+ sqlWithBytebaseAppComment := util.MySQLPrependBytebaseAppComment(command.Text)
+ sqlResult, err := exer.ExecContext(ctx, sqlWithBytebaseAppComment, nil)
+ if err != nil {
+ if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
+ slog.Info("cancel connection", slog.String("connectionID", connectionID))
+ if err := d.StopConnectionByID(connectionID); err != nil {
+ slog.Error("failed to cancel connection", slog.String("connectionID", connectionID), log.BBError(err))
+ }
+ }
+
+ opts.LogCommandResponse(0, nil, err.Error())
+ // In auto-commit mode, we stop at the first error
+ // The database is left in a partially migrated state
+ return err
+ }
+
+ allRowsAffected := sqlResult.(mysql.Result).AllRowsAffected()
+ var rowsAffected int64
+ var allRowsAffectedInt64 []int64
+ for _, a := range allRowsAffected {
+ rowsAffected += a
+ allRowsAffectedInt64 = append(allRowsAffectedInt64, a)
+ }
+ totalRowsAffected += rowsAffected
+
+ opts.LogCommandResponse(rowsAffected, allRowsAffectedInt64, "")
+ }
+
+ return nil
+ }); err != nil {
+ return 0, err
+ }
+
+ return totalRowsAffected, nil
+}
+
+// QueryConn queries a SQL statement in a given connection.
+func (d *Driver) QueryConn(ctx context.Context, conn *sql.Conn, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {
+ singleSQLs, err := base.SplitMultiSQL(storepb.Engine_OCEANBASE, statement)
+ if err != nil {
+ return nil, err
+ }
+ singleSQLs = base.FilterEmptyStatements(singleSQLs)
+ if len(singleSQLs) == 0 {
+ return nil, nil
+ }
+
+ connectionID, err := getConnectionID(ctx, conn)
+ if err != nil {
+ return nil, err
+ }
+ slog.Debug("connectionID", slog.String("connectionID", connectionID))
+
+ var results []*v1pb.QueryResult
+ for _, singleSQL := range singleSQLs {
+ statement := singleSQL.Text
+ if queryContext.Explain {
+ explained, err := base.ExplainStatement(storepb.Engine_OCEANBASE, statement, db.ExplainFormat(queryContext.Option.GetExplainFormat()))
+ if err != nil {
+ return nil, err
+ }
+ statement = explained
+ } else if queryContext.Limit > 0 {
+ statement = base.StatementWithResultLimit(storepb.Engine_OCEANBASE, statement, queryContext.Limit, "")
+ }
+ sqlWithBytebaseAppComment := util.MySQLPrependBytebaseAppComment(statement)
+
+ _, allQuery, err := base.ValidateSQLForEditor(storepb.Engine_OCEANBASE, statement)
+ if err != nil {
+ slog.Error("failed to validate sql", slog.String("statement", statement), log.BBError(err))
+ allQuery = true
+ }
+ startTime := time.Now()
+ queryResult, err := func() (*v1pb.QueryResult, error) {
+ if allQuery {
+ rows, err := conn.QueryContext(ctx, sqlWithBytebaseAppComment)
+ if err != nil {
+ return nil, err
+ }
+ defer rows.Close()
+ r, err := util.RowsToQueryResult(rows, makeValueByTypeName, convertValue, queryContext.MaximumSQLResultSize)
+ if err != nil {
+ return nil, err
+ }
+ if err := rows.Err(); err != nil {
+ return nil, err
+ }
+ if !queryContext.Explain {
+ r.QueryPlan = db.TypedExplainPlan(oceanbaseparser.DescribeExplain(statement))
+ }
+ return r, nil
+ }
+
+ sqlResult, err := conn.ExecContext(ctx, statement)
+ if err != nil {
+ return nil, err
+ }
+ affectedRows, err := sqlResult.RowsAffected()
+ if err != nil {
+ slog.Info("rowsAffected returns error", log.BBError(err))
+ }
+ return util.BuildAffectedRowsResult(affectedRows, nil), nil
+ }()
+ stop := false
+ if err != nil {
+ if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
+ slog.Info("cancel connection", slog.String("connectionID", connectionID))
+ if err := d.StopConnectionByID(connectionID); err != nil {
+ slog.Error("failed to cancel connection", slog.String("connectionID", connectionID), log.BBError(err))
+ }
+ }
+ queryResult = &v1pb.QueryResult{
+ Error: err.Error(),
+ }
+ stop = true
+ }
+ queryResult.Statement = statement
+ queryResult.Latency = durationpb.New(time.Since(startTime))
+ queryResult.RowsCount = int64(len(queryResult.Rows))
+ results = append(results, queryResult)
+ if stop {
+ break
+ }
+ }
+
+ return results, nil
+}
+
+func (d *Driver) StopConnectionByID(id string) error {
+ // We cannot use placeholder parameter because TiDB doesn't accept it.
+ _, err := d.db.Exec(fmt.Sprintf("KILL QUERY %s", id))
+ return err
+}
+
+func getConnectionID(ctx context.Context, conn *sql.Conn) (string, error) {
+ var id string
+ if err := conn.QueryRowContext(ctx, `SELECT CONNECTION_ID();`).Scan(&id); err != nil {
+ return "", err
+ }
+ return id, nil
+}
diff --git a/backend/plugin/db/oceanbase/query.go b/backend/plugin/db/oceanbase/query.go
new file mode 100644
index 0000000000..b112cb6995
--- /dev/null
+++ b/backend/plugin/db/oceanbase/query.go
@@ -0,0 +1,78 @@
+package oceanbase
+
+import (
+ "database/sql"
+
+ v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
+ "github.com/bytebase/bytebase/backend/plugin/db/util"
+)
+
+func makeValueByTypeName(typeName string, _ *sql.ColumnType) any {
+ switch typeName {
+ case "VARCHAR", "TEXT", "UUID", "DATETIME", "TIMESTAMP":
+ return new(sql.NullString)
+ case "BOOL":
+ return new(sql.NullBool)
+ case "INT", "INTEGER", "TINYINT", "SMALLINT", "MEDIUMINT", "BIGINT", "INT2", "INT4", "INT8":
+ return new(sql.NullInt64)
+ case "FLOAT", "DOUBLE", "FLOAT4", "FLOAT8":
+ return new(sql.NullFloat64)
+ case "BIT", "VARBIT", "BINARY", "VARBINARY":
+ return new([]byte)
+ case "GEOMETRY", "POINT", "LINESTRING", "POLYGON", "MULTIPOINT", "MULTILINESTRING", "MULTIPOLYGON", "GEOMETRYCOLLECTION":
+ return new([]byte)
+ default:
+ return new(sql.NullString)
+ }
+}
+
+func convertValue(typeName string, columnType *sql.ColumnType, value any) *v1pb.RowValue {
+ switch raw := value.(type) {
+ case *sql.NullString:
+ if raw.Valid {
+ _, scale, _ := columnType.DecimalSize()
+ if typeName == "TIMESTAMP" || typeName == "DATETIME" {
+ return util.BuildTimestampOrStringRowValue(raw.String, scale)
+ }
+ return &v1pb.RowValue{
+ Kind: &v1pb.RowValue_StringValue{
+ StringValue: raw.String,
+ },
+ }
+ }
+ case *sql.NullInt64:
+ if raw.Valid {
+ return &v1pb.RowValue{
+ Kind: &v1pb.RowValue_Int64Value{
+ Int64Value: raw.Int64,
+ },
+ }
+ }
+ case *[]byte:
+ if len(*raw) > 0 {
+ return &v1pb.RowValue{
+ Kind: &v1pb.RowValue_BytesValue{
+ BytesValue: *raw,
+ },
+ }
+ }
+ case *sql.NullBool:
+ if raw.Valid {
+ return &v1pb.RowValue{
+ Kind: &v1pb.RowValue_BoolValue{
+ BoolValue: raw.Bool,
+ },
+ }
+ }
+ case *sql.NullFloat64:
+ if raw.Valid {
+ return &v1pb.RowValue{
+ Kind: &v1pb.RowValue_DoubleValue{
+ DoubleValue: raw.Float64,
+ },
+ }
+ }
+ default:
+ }
+ return util.NullRowValue
+}
diff --git a/backend/plugin/db/oceanbase/role.go b/backend/plugin/db/oceanbase/role.go
new file mode 100644
index 0000000000..75e46f836a
--- /dev/null
+++ b/backend/plugin/db/oceanbase/role.go
@@ -0,0 +1,136 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "log/slog"
+ "strings"
+
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common/log"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+)
+
+func (d *Driver) getInstanceRoles(ctx context.Context) []*storepb.InstanceRole {
+ var instanceRoles []*storepb.InstanceRole
+ var users []string
+ var err error
+ users, err = d.getUsersFromMySQLUser(ctx)
+ if err != nil {
+ slog.Info("failed to get users", log.BBError(err))
+ users, err = d.getUsersFromUserAttributes(ctx)
+ if err != nil {
+ slog.Info("failed to get users", log.BBError(err))
+ return nil
+ }
+ }
+
+ // Uses single quote instead of backtick to escape because this is a string
+ // instead of table (which should use backtick instead). MySQL actually works
+ // in both ways. On the other hand, some other MySQL compatible engines might not (OceanBase in this case).
+ for _, name := range users {
+ grantList, err := d.getGrantFromUser(ctx, name)
+ if err != nil {
+ slog.Info("failed to get grants for user", slog.String("user", name), log.BBError(err))
+ continue
+ }
+ attribute := strings.Join(grantList, "\n")
+ instanceRoles = append(instanceRoles, &storepb.InstanceRole{
+ Name: name,
+ Attribute: &attribute,
+ })
+ }
+ return instanceRoles
+}
+
+// getGrantFromUser reads grants for user with format "'<user>'@'<host>'".
+func (d *Driver) getGrantFromUser(ctx context.Context, name string) ([]string, error) {
+ grantQuery := fmt.Sprintf("SHOW GRANTS FOR %s", name)
+ grantRows, err := d.db.QueryContext(ctx,
+ grantQuery,
+ )
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to query grants for %s", name)
+ }
+ defer grantRows.Close()
+
+ grants := []string{}
+ for grantRows.Next() {
+ var grant string
+ if err := grantRows.Scan(&grant); err != nil {
+ return nil, errors.Wrapf(err, "failed to scan grants for %s", name)
+ }
+ grants = append(grants, grant)
+ }
+ if err := grantRows.Err(); err != nil {
+ return nil, errors.Wrapf(err, "failed to iterate grants for %s", name)
+ }
+ return grants, nil
+}
+
+// getUsersFromUserAttributes reads users from information_schema.user_attributes, returns the list of users with format "'<user>'@'<host>'".
+func (d *Driver) getUsersFromUserAttributes(ctx context.Context) ([]string, error) {
+ var users []string
+ query := `
+ SELECT
+ user,
+ host
+ FROM information_schema.user_attributes
+ WHERE user <> ''
+ AND user NOT LIKE 'mysql.%'
+ `
+ roleRows, err := d.db.QueryContext(ctx, query)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to query information_schema.user_attributes")
+ }
+ defer roleRows.Close()
+ for roleRows.Next() {
+ var user string
+ var host string
+ if err := roleRows.Scan(
+ &user,
+ &host,
+ ); err != nil {
+ return nil, err
+ }
+ users = append(users, fmt.Sprintf("'%s'@'%s'", user, host))
+ }
+ if err := roleRows.Err(); err != nil {
+ return nil, errors.Wrapf(err, "failed to iterate information_schema.user_attributes")
+ }
+ return users, nil
+}
+
+// getUsersFromMySQLUser reads users from mysql.user, returns the list of users with format "'<user>'@'<host>'".
+func (d *Driver) getUsersFromMySQLUser(ctx context.Context) ([]string, error) {
+ var users []string
+ query := `
+ SELECT
+ user,
+ host
+ FROM mysql.user
+ WHERE user <> ''
+ AND user NOT LIKE 'mysql.%'
+ `
+ roleRows, err := d.db.QueryContext(ctx, query)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to query mysql.user")
+ }
+ defer roleRows.Close()
+ for roleRows.Next() {
+ var user string
+ var host string
+ if err := roleRows.Scan(
+ &user,
+ &host,
+ ); err != nil {
+ return nil, err
+ }
+ users = append(users, fmt.Sprintf("'%s'@'%s'", user, host))
+ }
+ if err := roleRows.Err(); err != nil {
+ return nil, errors.Wrapf(err, "failed to iterate mysql.user")
+ }
+ return users, nil
+}
diff --git a/backend/plugin/db/oceanbase/stats.go b/backend/plugin/db/oceanbase/stats.go
new file mode 100644
index 0000000000..dfed6277ba
--- /dev/null
+++ b/backend/plugin/db/oceanbase/stats.go
@@ -0,0 +1,41 @@
+package oceanbase
+
+import (
+ "context"
+ "database/sql"
+ "strings"
+
+ oceanbaseparser "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
+)
+
+// CountAffectedRows returns the planner's estimate of the rows the INSERT, UPDATE, or DELETE
+// statement modifies. OceanBase reports it on the plan's root operator, so the statement needs
+// no rewrite into a SELECT of the rows it touches, as MySQL's estimate does.
+func (d *Driver) CountAffectedRows(ctx context.Context, statement string) (int64, error) {
+ rows, err := d.db.QueryContext(ctx, "EXPLAIN FORMAT=JSON "+statement)
+ if err != nil {
+ return 0, err
+ }
+ defer rows.Close()
+ plan, err := readExplainJSON(rows)
+ if err != nil {
+ return 0, err
+ }
+ return oceanbaseparser.EstimateAffectedRowsFromExplainJSON(plan)
+}
+
+// readExplainJSON concatenates the plan rows; OceanBase splits its JSON plan across rows.
+func readExplainJSON(rows *sql.Rows) (string, error) {
+ var plan strings.Builder
+ for rows.Next() {
+ var line sql.NullString
+ if err := rows.Scan(&line); err != nil {
+ return "", err
+ }
+ plan.WriteString(line.String)
+ }
+ if err := rows.Err(); err != nil {
+ return "", err
+ }
+ return plan.String(), nil
+}
diff --git a/backend/plugin/db/oceanbase/sync.go b/backend/plugin/db/oceanbase/sync.go
new file mode 100644
index 0000000000..a70b134fe8
--- /dev/null
+++ b/backend/plugin/db/oceanbase/sync.go
@@ -0,0 +1,1481 @@
+package oceanbase
+
+import (
+ "bytes"
+ "context"
+ "database/sql"
+ "encoding/hex"
+ "fmt"
+ "log/slog"
+ "regexp"
+ "slices"
+ "strconv"
+ "strings"
+ "unicode"
+ "unicode/utf8"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "golang.org/x/text/encoding/charmap"
+ "golang.org/x/text/transform"
+ "google.golang.org/protobuf/proto"
+
+ "github.com/blang/semver/v4"
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common"
+ "github.com/bytebase/bytebase/backend/common/log"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/db"
+ "github.com/bytebase/bytebase/backend/plugin/db/util"
+)
+
+const (
+ autoIncrementSymbol = "AUTO_INCREMENT"
+ autoRandSymbol = "AUTO_RANDOM"
+ pkAutoRandomBitsSymbol = "PK_AUTO_RANDOM_BITS"
+ virtualGenerated = "VIRTUAL GENERATED"
+ storedGenerated = "STORED GENERATED"
+)
+
+var (
+ systemDatabases = map[string]bool{
+ "information_schema": true,
+ "mysql": true,
+ "performance_schema": true,
+ "sys": true,
+ // OceanBase only
+ "oceanbase": true,
+ "SYS": true,
+ "LBACSYS": true,
+ "ORAAUDITOR": true,
+ "__public": true,
+ }
+ systemDatabaseClause = func() string {
+ var l []string
+ for k := range systemDatabases {
+ l = append(l, fmt.Sprintf("'%s'", k))
+ }
+ return strings.Join(l, ", ")
+ }()
+
+ // Matches SHOW CREATE VIEW output: optional `db`. qualifier on the view name and an
+ // optional explicit column list, which MySQL prints comma-separated: (`a`,`b`,`c`).
+ // Column-list identifiers are rendered with embedded backticks doubled (`a``b`), so
+ // each list segment matches doubling-aware atoms rather than [^`]+ — an identifier
+ // containing a backtick (or ", ") must not mis-split the list.
+ viewDefMatcher = regexp.MustCompile("CREATE ALGORITHM=(UNDEFINED|MERGE|TEMPTABLE) DEFINER=`([^`]+)`@`([^`]+)` SQL SECURITY (DEFINER|INVOKER) VIEW `([^`]+)`(?:\\.`([^`]+)`)?( \\(`(?:[^`]|``)+`(?:, ?`(?:[^`]|``)+`)*\\))? AS (?P<def>.+)")
+)
+
+// isStockMySQL reports whether the version suffix returned by getVersion (the text
+// after the numeric version, e.g. "-MariaDB", "-OceanBase-v4.2", "-TiDB-v7.5") denotes
+// a stock MySQL server. MySQL-compatible engines registered as MYSQL report MySQL-like
+// version numbers but do not implement every stock information_schema feature, so any
+// stock-only query or decode (SRS_ID column select, binary default encodings, column
+// INVISIBLE capture) must be gated on this single predicate.
+func isStockMySQL(versionSuffix string) bool {
+ return !strings.Contains(versionSuffix, "MariaDB") &&
+ !strings.Contains(versionSuffix, "OceanBase") &&
+ !strings.Contains(versionSuffix, "TiDB")
+}
+
+// SyncInstance syncs the instance.
+func (d *Driver) SyncInstance(ctx context.Context) (*db.InstanceMetadata, error) {
+ version, _, err := d.getVersion(ctx)
+ if err != nil {
+ return nil, err
+ }
+
+ var lowerCaseTableNames int32
+ lowerCaseTableNamesText, err := d.getServerVariable(ctx, "lower_case_table_names")
+ if err != nil {
+ slog.Debug("failed to get lower_case_table_names variable", log.BBError(err))
+ } else {
+ v, err := strconv.ParseInt(lowerCaseTableNamesText, 10, 32)
+ if err != nil {
+ slog.Debug("failed to parse lower_case_table_names variable", log.BBError(err))
+ } else {
+ lowerCaseTableNames = int32(v)
+ }
+ }
+
+ instanceRoles := d.getInstanceRoles(ctx)
+
+ // Query db info
+ where := fmt.Sprintf("LOWER(SCHEMA_NAME) NOT IN (%s)", systemDatabaseClause)
+ query := `
+ SELECT
+ SCHEMA_NAME,
+ DEFAULT_CHARACTER_SET_NAME,
+ DEFAULT_COLLATION_NAME
+ FROM information_schema.SCHEMATA
+ WHERE ` + where
+ rows, err := d.db.QueryContext(ctx, query)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, query)
+ }
+ defer rows.Close()
+
+ var databases []*metadatapb.DatabaseSchemaMetadata
+ for rows.Next() {
+ database := &metadatapb.DatabaseSchemaMetadata{}
+ if err := rows.Scan(
+ &database.Name,
+ &database.CharacterSet,
+ &database.Collation,
+ ); err != nil {
+ return nil, err
+ }
+ databases = append(databases, database)
+ }
+ if err := rows.Err(); err != nil {
+ return nil, err
+ }
+
+ return &db.InstanceMetadata{
+ Version: version,
+ Databases: databases,
+ Metadata: &storepb.Instance{
+ MysqlLowerCaseTableNames: lowerCaseTableNames,
+ Roles: instanceRoles,
+ },
+ }, nil
+}
+
+func (d *Driver) getServerVariable(ctx context.Context, varName string) (string, error) {
+ db := d.GetDB()
+ query := fmt.Sprintf("SHOW VARIABLES LIKE '%s'", varName)
+ var varNameFound, value string
+ if err := db.QueryRowContext(ctx, query).Scan(&varNameFound, &value); err != nil {
+ if err == sql.ErrNoRows {
+ return "", common.FormatDBErrorEmptyRowWithQuery(query)
+ }
+ return "", util.FormatErrorWithQuery(err, query)
+ }
+ if varName != varNameFound {
+ return "", errors.Errorf("expecting variable %s, but got %s", varName, varNameFound)
+ }
+ return value, nil
+}
+
+func containsInvisibleChars(data []byte) bool {
+ // Iterate over the byte slice as runes
+ for len(data) > 0 {
+ r, size := utf8.DecodeRune(data)
+ if r == utf8.RuneError && size == 1 {
+ // If the byte slice contains invalid UTF-8 characters, treat it as invisible
+ return true
+ }
+ // Check if the rune is not printable
+ if !unicode.IsPrint(r) {
+ return true
+ }
+ // Move to the next rune
+ data = data[size:]
+ }
+ return false
+}
+
+func utf8ToISO88591(utf8Str string) (string, error) {
+ // Create a transformer that encodes UTF-8 to ISO-8859-1
+ encoder := charmap.ISO8859_1.NewEncoder()
+
+ // Transform the input UTF-8 string into ISO-8859-1
+ isoBytes, _, err := transform.String(encoder, utf8Str)
+ if err != nil {
+ return "", err
+ }
+
+ return isoBytes, nil
+}
+
+// SyncDBSchema syncs a single database schema.
+func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMetadata, error) {
+ schemaMetadata := &metadatapb.SchemaMetadata{
+ Name: "",
+ }
+
+ // Query MySQL version
+ version, rest, err := d.getVersion(ctx)
+ if err != nil {
+ return nil, err
+ }
+ semVersion, err := semver.Make(version)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to parse MySQL version %s to semantic version", version)
+ }
+ atLeast800 := semVersion.GE(semver.MustParse("8.0.0"))
+ atLeast803 := semVersion.GE(semver.MustParse("8.0.3"))
+ atLeast8_0_13 := semVersion.GE(semver.MustParse("8.0.13"))
+ atLeast8_0_16 := semVersion.GE(semver.MustParse("8.0.16"))
+ atLeast5_7_0 := semVersion.GE(semver.MustParse("5.7.0"))
+ isMariaDB := strings.Contains(rest, "MariaDB")
+ // Some information_schema features exist only on stock MySQL: compatible engines
+ // (MariaDB, OceanBase, TiDB) registered as MYSQL report MySQL-like versions but
+ // lack them, so every stock-only query/decode must share this one predicate.
+ stockMySQL := isStockMySQL(rest)
+ // Binary-family (binary charset) literal defaults are reported by
+ // information_schema.COLUMNS in version-specific encodings that must be decoded to
+ // the canonical dump form (see canonicalBinaryDefault). The conventions are verified
+ // for stock MySQL only; MariaDB, OceanBase, and TiDB keep the legacy verbatim path.
+ binaryDefaultFmt := binaryDefaultVerbatim
+ if stockMySQL {
+ if atLeast800 {
+ binaryDefaultFmt = binaryDefaultHexNotation
+ } else {
+ binaryDefaultFmt = binaryDefaultRawBytes
+ }
+ }
+
+ // Query index info.
+ indexMap := make(map[db.TableKey]map[string]*metadatapb.IndexMetadata)
+ indexQuery := `
+ SELECT
+ TABLE_NAME,
+ INDEX_NAME,
+ COLUMN_NAME,
+ COLLATION,
+ IFNULL(SUB_PART, -1),
+ '',
+ SEQ_IN_INDEX,
+ INDEX_TYPE,
+ NON_UNIQUE,
+ 1,
+ INDEX_COMMENT
+ FROM information_schema.STATISTICS
+ WHERE TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME, INDEX_NAME, SEQ_IN_INDEX`
+ // MySQL 8.0.13 introduced the EXPRESSION column in the INFORMATION_SCHEMA.STATISTICS table.
+ // https://dev.mysql.com/doc/refman/8.0/en/information-schema-statistics-table.html
+ // MariaDB doesn't have the EXPRESSION column.
+ // https://mariadb.com/docs/server/ref/mdb/information-schema/STATISTICS
+ if atLeast8_0_13 && !isMariaDB {
+ indexQuery = `
+ SELECT
+ TABLE_NAME,
+ INDEX_NAME,
+ COLUMN_NAME,
+ COLLATION,
+ IFNULL(SUB_PART, -1),
+ EXPRESSION,
+ SEQ_IN_INDEX,
+ INDEX_TYPE,
+ NON_UNIQUE,
+ CASE IS_VISIBLE WHEN 'YES' THEN 1 ELSE 0 END,
+ INDEX_COMMENT
+ FROM information_schema.STATISTICS
+ WHERE TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME, INDEX_NAME, SEQ_IN_INDEX`
+ }
+ indexRows, err := d.db.QueryContext(ctx, indexQuery, d.databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, indexQuery)
+ }
+ defer indexRows.Close()
+ for indexRows.Next() {
+ var tableName, indexName, indexType, comment, expression string
+ var columnName sql.NullString
+ var expressionName sql.NullString
+ var collation sql.NullString
+ var position int
+ var subPart int64
+ var nonUnique, visible bool
+ if err := indexRows.Scan(
+ &tableName,
+ &indexName,
+ &columnName,
+ &collation,
+ &subPart,
+ &expressionName,
+ &position,
+ &indexType,
+ &nonUnique,
+ &visible,
+ &comment,
+ ); err != nil {
+ return nil, err
+ }
+ if columnName.Valid {
+ expression = columnName.String
+ } else if expressionName.Valid {
+ // It's a bit late or not necessary to differentiate the column name or expression.
+ // We add parentheses around expression.
+ expression = fmt.Sprintf("(%s)", expressionName.String)
+ }
+
+ desc := false
+ if collation.Valid && collation.String == "D" {
+ desc = true
+ }
+
+ key := db.TableKey{Schema: "", Table: tableName}
+ if _, ok := indexMap[key]; !ok {
+ indexMap[key] = make(map[string]*metadatapb.IndexMetadata)
+ }
+ if _, ok := indexMap[key][indexName]; !ok {
+ indexMap[key][indexName] = &metadatapb.IndexMetadata{
+ Name: indexName,
+ Type: indexType,
+ Unique: !nonUnique,
+ Primary: indexName == "PRIMARY",
+ Visible: visible,
+ Comment: comment,
+ }
+ }
+ indexMap[key][indexName].Expressions = append(indexMap[key][indexName].Expressions, expression)
+ indexMap[key][indexName].KeyLength = append(indexMap[key][indexName].KeyLength, subPart)
+ indexMap[key][indexName].Descending = append(indexMap[key][indexName].Descending, desc)
+ }
+ if err := indexRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, indexQuery)
+ }
+
+ // Query column info.
+ // SRS_ID (spatial reference id) was added to information_schema.COLUMNS in stock
+ // MySQL 8.0.3 (the same version encoded by the /*!80003 SRID */ renderer). Stock
+ // 8.0.0–8.0.2 lack it, as do 5.7/5.6, MariaDB, OceanBase, and TiDB (which may report
+ // an 8.x MySQL-compat version), so selecting it there would fail the whole sync —
+ // they select NULL instead.
+ columnMap := make(map[db.TableKey][]*metadatapb.ColumnMetadata)
+ sridSelect := "NULL"
+ if atLeast803 && stockMySQL {
+ sridSelect = "SRS_ID"
+ }
+ columnQuery := fmt.Sprintf(`
+ SELECT
+ TABLE_NAME,
+ IFNULL(COLUMN_NAME, ''),
+ ORDINAL_POSITION,
+ CASE WHEN COLUMN_DEFAULT is NULL THEN NULL ELSE QUOTE(COLUMN_DEFAULT) END,
+ IS_NULLABLE,
+ COLUMN_TYPE,
+ IFNULL(CHARACTER_SET_NAME, ''),
+ IFNULL(COLLATION_NAME, ''),
+ QUOTE(COLUMN_COMMENT),
+ convert(GENERATION_EXPRESSION using BINARY),
+ EXTRA,
+ %s
+ FROM information_schema.COLUMNS
+ WHERE TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME, ORDINAL_POSITION`, sridSelect)
+ if !atLeast5_7_0 {
+ // GENERATION_EXPRESSION does not exist in MySQL 5.6.
+ columnQuery = fmt.Sprintf(`
+ SELECT
+ TABLE_NAME,
+ IFNULL(COLUMN_NAME, ''),
+ ORDINAL_POSITION,
+ CASE WHEN COLUMN_DEFAULT is NULL THEN NULL ELSE QUOTE(COLUMN_DEFAULT) END,
+ IS_NULLABLE,
+ COLUMN_TYPE,
+ IFNULL(CHARACTER_SET_NAME, ''),
+ IFNULL(COLLATION_NAME, ''),
+ QUOTE(COLUMN_COMMENT),
+ NULL,
+ EXTRA,
+ %s
+ FROM information_schema.COLUMNS
+ WHERE TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME, ORDINAL_POSITION`, sridSelect)
+ }
+ columnRows, err := d.db.QueryContext(ctx, columnQuery, d.databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, columnQuery)
+ }
+ defer columnRows.Close()
+ for columnRows.Next() {
+ column := &metadatapb.ColumnMetadata{}
+ var tableName, nullable, extra, tp string
+ var defaultStr sql.NullString
+ var generationExpr []byte
+ var srid sql.NullInt64
+ if err := columnRows.Scan(
+ &tableName,
+ &column.Name,
+ &column.Position,
+ &defaultStr,
+ &nullable,
+ &tp,
+ &column.CharacterSet,
+ &column.Collation,
+ &column.Comment,
+ &generationExpr,
+ &extra,
+ &srid,
+ ); err != nil {
+ return nil, err
+ }
+ // Quoted string has a single quote around it and is escaped by QUOTE().
+ column.Comment = stripSingleQuote(column.Comment)
+ nullableBool, err := util.ConvertYesNo(nullable)
+ if err != nil {
+ return nil, err
+ }
+ column.Type = GetColumnTypeCanonicalSynonym(tp)
+ column.Nullable = nullableBool
+ setColumnMetadataDefault(column, defaultStr, nullableBool, extra, binaryDefaultFmt)
+ // SRID presence tracks SRS_ID being non-NULL: spatial columns with an explicit
+ // SRID (MySQL 8.0), INCLUDING the valid SRID 0. SRS_IDs are unsigned 32-bit, so
+ // the value must not be squeezed through int32 (custom SRSs may be >= 2^31).
+ if srid.Valid {
+ v := uint32(srid.Int64)
+ column.Srid = &v
+ }
+ // A user-declared INVISIBLE column surfaces as the INVISIBLE token in EXTRA
+ // (MySQL 8.0.23+). Captured on stock MySQL only: MariaDB 10.3+ also reports
+ // INVISIBLE in EXTRA, but the writers emit the MySQL-versioned
+ // /*!80023 INVISIBLE */ form, which MariaDB ignores — capturing there would
+ // yield a permanently non-converging diff. On stock MySQL the dumper re-emits
+ // the attribute and the declarative diff stays a no-op.
+ if stockMySQL && isInvisibleColumnExtra(extra) {
+ column.IsInvisible = true
+ }
+ key := db.TableKey{Schema: "", Table: tableName}
+ columnMap[key] = append(columnMap[key], column)
+ invisible := containsInvisibleChars(generationExpr)
+ iso88591Text, convertedErr := utf8ToISO88591(string(generationExpr))
+ text := string(generationExpr)
+ if invisible && convertedErr == nil {
+ text = iso88591Text
+ }
+ // MySQL server returns the generation expression with an escaped single quote.
+ // I have no idea why it does that. But we need to unescape it. -_-
+ text = strings.ReplaceAll(text, `\'`, `'`)
+ if extra != "" && strings.Contains(strings.ToUpper(extra), virtualGenerated) && len(generationExpr) != 0 {
+ column.Generation = &metadatapb.GenerationMetadata{
+ Type: metadatapb.GenerationMetadata_TYPE_VIRTUAL,
+ Expression: text,
+ }
+ } else if extra != "" && strings.Contains(strings.ToUpper(extra), storedGenerated) && len(generationExpr) != 0 {
+ column.Generation = &metadatapb.GenerationMetadata{
+ Type: metadatapb.GenerationMetadata_TYPE_STORED,
+ Expression: text,
+ }
+ }
+ }
+ if err := columnRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, columnQuery)
+ }
+
+ // Check constraints info.
+ checkMap := make(map[db.TableKey][]*metadatapb.CheckConstraintMetadata)
+ if atLeast8_0_16 {
+ checkQuery := getCheckConstraintQuery(isMariaDB)
+ checkRows, err := d.db.QueryContext(ctx, checkQuery, d.databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, checkQuery)
+ }
+ defer checkRows.Close()
+ for checkRows.Next() {
+ check := &metadatapb.CheckConstraintMetadata{}
+ var tableName string
+ if err := checkRows.Scan(
+ &tableName,
+ &check.Name,
+ &check.Expression,
+ ); err != nil {
+ return nil, err
+ }
+ check.Expression = unescapeCheckClause(check.Expression)
+ key := db.TableKey{Schema: "", Table: tableName}
+ checkMap[key] = append(checkMap[key], check)
+ }
+ if err := checkRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, checkQuery)
+ }
+ }
+
+ // Query view info.
+ viewMap := make(map[db.TableKey]*metadatapb.ViewMetadata)
+ viewQuery := `
+ SELECT
+ TABLE_NAME,
+ VIEW_DEFINITION
+ FROM information_schema.VIEWS
+ WHERE TABLE_SCHEMA = ?`
+ viewRows, err := d.db.QueryContext(ctx, viewQuery, d.databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, viewQuery)
+ }
+ defer viewRows.Close()
+ for viewRows.Next() {
+ view := &metadatapb.ViewMetadata{}
+ if err := viewRows.Scan(
+ &view.Name,
+ &view.Definition,
+ ); err != nil {
+ return nil, err
+ }
+ // Note: MySQL's information_schema.VIEWS doesn't have a comment column
+ // View comments are not supported in MySQL
+ view.Comment = ""
+ key := db.TableKey{Schema: "", Table: view.Name}
+ view.Columns = columnMap[key]
+ viewMap[key] = view
+ }
+ if err := viewRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, viewQuery)
+ }
+ for key := range viewMap {
+ def, err := d.reconcileViewDefinition(ctx, d.databaseName, key.Table)
+ if err != nil {
+ return nil, err
+ }
+ if def != "" {
+ viewMap[key].Definition = def
+ }
+ }
+
+ // Query triggers.
+ triggerMap, err := d.getTriggerList(ctx, d.databaseName)
+ if err != nil {
+ return nil, err
+ }
+
+ // Query events.
+ eventList, err := d.getEventList(ctx, d.databaseName)
+ if err != nil {
+ return nil, err
+ }
+ schemaMetadata.Events = eventList
+
+ // Query foreign key info.
+ foreignKeysMap, err := d.getForeignKeyList(ctx, d.databaseName)
+ if err != nil {
+ return nil, err
+ }
+
+ // OceanBase's information_schema.PARTITIONS does not describe its partitions in the
+ // shape SHOW CREATE TABLE prints, so the sync claims none.
+ partitionTables := make(map[db.TableKey][]*metadatapb.TablePartitionMetadata)
+
+ functions, procedures, err := d.syncRoutines(ctx, d.databaseName)
+ if err != nil {
+ return nil, err
+ }
+ schemaMetadata.Functions = functions
+ schemaMetadata.Procedures = procedures
+
+ // Query table info.
+ tableQuery := `
+ SELECT
+ TABLES.TABLE_NAME,
+ TABLES.TABLE_TYPE,
+ IFNULL(TABLES.ENGINE, ''),
+ IFNULL(TABLES.TABLE_COLLATION, ''),
+ IFNULL(TABLES.TABLE_ROWS, 0),
+ IFNULL(TABLES.DATA_LENGTH, 0),
+ IFNULL(TABLES.INDEX_LENGTH, 0),
+ IFNULL(TABLES.DATA_FREE, 0),
+ IFNULL(TABLES.CREATE_OPTIONS, ''),
+ QUOTE(IFNULL(TABLES.TABLE_COMMENT, '')),
+ IFNULL(CCSA.CHARACTER_SET_NAME, '')
+ FROM information_schema.TABLES TABLES
+ LEFT JOIN information_schema.COLLATION_CHARACTER_SET_APPLICABILITY CCSA
+ ON TABLES.TABLE_COLLATION = CCSA.COLLATION_NAME
+ WHERE TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME`
+ tableRows, err := d.db.QueryContext(ctx, tableQuery, d.databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, tableQuery)
+ }
+ defer tableRows.Close()
+ for tableRows.Next() {
+ var tableName, tableType, engine, collation, createOptions, comment, charset string
+ var rowCount, dataSize, indexSize, dataFree int64
+ // Workaround TiDB bug https://github.com/pingcap/tidb/issues/27970
+ var tableCollation sql.NullString
+ if err := tableRows.Scan(
+ &tableName,
+ &tableType,
+ &engine,
+ &collation,
+ &rowCount,
+ &dataSize,
+ &indexSize,
+ &dataFree,
+ &createOptions,
+ &comment,
+ &charset,
+ ); err != nil {
+ return nil, err
+ }
+ // Quoted string has a single quote around it and is escaped by QUOTE().
+ comment = stripSingleQuote(comment)
+
+ // Note: We should NOT skip partitioned tables here.
+ // The CREATE_OPTIONS might contain 'partitioned' for partitioned tables,
+ // but we still need to include them in the table list.
+ // The partition details are fetched separately by listPartitionTables.
+
+ key := db.TableKey{Schema: "", Table: tableName}
+ switch tableType {
+ case baseTableType:
+ columns := columnMap[key]
+ tableMetadata := &metadatapb.TableMetadata{
+ Name: tableName,
+ Columns: columns,
+ ForeignKeys: foreignKeysMap[key],
+ Engine: engine,
+ Collation: collation,
+ RowCount: rowCount,
+ DataSize: dataSize,
+ IndexSize: indexSize,
+ DataFree: dataFree,
+ CreateOptions: createOptions,
+ Comment: comment,
+ Partitions: partitionTables[key],
+ CheckConstraints: checkMap[key],
+ Charset: charset,
+ Triggers: triggerMap[key],
+ }
+ if tableCollation.Valid {
+ tableMetadata.Collation = tableCollation.String
+ }
+ var indexNames []string
+ if indexes, ok := indexMap[key]; ok {
+ for indexName := range indexes {
+ indexNames = append(indexNames, indexName)
+ }
+ slices.Sort(indexNames)
+ for _, indexName := range indexNames {
+ tableMetadata.Indexes = append(tableMetadata.Indexes, indexes[indexName])
+ }
+ }
+
+ schemaMetadata.Tables = append(schemaMetadata.Tables, tableMetadata)
+ case viewTableType:
+ if view, ok := viewMap[key]; ok {
+ schemaMetadata.Views = append(schemaMetadata.Views, view)
+ }
+ case externalTableType:
+ schemaMetadata.ExternalTables = append(schemaMetadata.ExternalTables, &metadatapb.ExternalTableMetadata{
+ Name: tableName,
+ Columns: columnMap[key],
+ })
+ default:
+ // Unknown table type, skip
+ }
+ }
+ if err := tableRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, tableQuery)
+ }
+ materializedViews, err := d.listMaterializedViews(ctx, d.databaseName, schemaMetadata.Tables)
+ if err != nil {
+ return nil, err
+ }
+ schemaMetadata.MaterializedViews = materializedViews
+
+ databaseMetadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: d.databaseName,
+ Schemas: []*metadatapb.SchemaMetadata{schemaMetadata},
+ }
+ // Query db info.
+ databaseQuery := `
+ SELECT
+ DEFAULT_CHARACTER_SET_NAME,
+ DEFAULT_COLLATION_NAME
+ FROM information_schema.SCHEMATA
+ WHERE SCHEMA_NAME = ?`
+ if err := d.db.QueryRowContext(ctx, databaseQuery, d.databaseName).Scan(
+ &databaseMetadata.CharacterSet,
+ &databaseMetadata.Collation,
+ ); err != nil {
+ if err == sql.ErrNoRows {
+ return nil, common.Errorf(common.NotFound, "database %q not found", d.databaseName)
+ }
+ return nil, err
+ }
+
+ return databaseMetadata, err
+}
+
+// listMaterializedViews reads the database's materialized views. OceanBase lists one
+// in neither information_schema.TABLES nor VIEWS, only its storage table __mv_container_<id>,
+// which carries the view's comment and indexes and stays synced as a table. A failed read, such
+// as one without SELECT on the oceanbase database, leaves the list empty; a caller can tell,
+// because a container table is then synced without its materialized view.
+func (d *Driver) listMaterializedViews(ctx context.Context, databaseName string, tables []*metadatapb.TableMetadata) ([]*metadatapb.MaterializedViewMetadata, error) {
+ query := `
+ SELECT MVIEW_NAME, CONTAINER_NAME, QUERY
+ FROM oceanbase.DBA_MVIEWS
+ WHERE OWNER = ?
+ ORDER BY MVIEW_NAME`
+ rows, err := d.db.QueryContext(ctx, query, databaseName)
+ if err != nil {
+ if ctx.Err() != nil {
+ return nil, ctx.Err()
+ }
+ slog.Warn("failed to list OceanBase materialized views", slog.String("database", databaseName), log.BBError(err))
+ return nil, nil
+ }
+ defer rows.Close()
+ containers := make(map[string]*metadatapb.TableMetadata, len(tables))
+ for _, table := range tables {
+ containers[table.Name] = table
+ }
+ var views []*metadatapb.MaterializedViewMetadata
+ for rows.Next() {
+ var name, containerName, definition string
+ if err := rows.Scan(&name, &containerName, &definition); err != nil {
+ return nil, err
+ }
+ view := &metadatapb.MaterializedViewMetadata{
+ Name: name,
+ Definition: definition,
+ // No MySQL-family DDL writer renders OceanBase's CREATE MATERIALIZED VIEW.
+ SkipDump: true,
+ }
+ if container, ok := containers[containerName]; ok {
+ view.Comment = container.Comment
+ for _, index := range container.Indexes {
+ view.Indexes = append(view.Indexes, proto.CloneOf(index))
+ }
+ }
+ views = append(views, view)
+ }
+ if err := rows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, query)
+ }
+ return views, nil
+}
+
+// getEventList lists the database's events by name only. OceanBase rejects SHOW CREATE
+// EVENT, and information_schema.EVENTS cannot rebuild it: it shows the schedule in the session
+// time zone, flattens a BEGIN...END body, and does not record the creating session's time zone,
+// SQL mode, or character set. The definition stays empty, so the DDL writers in
+// backend/plugin/schema/mysql skip the event.
+//
+// A database created under a dropped one's name also lists the dropped one's events, which
+// information_schema cannot tell from its own; DISTINCT lists a name both have once.
+func (d *Driver) getEventList(ctx context.Context, databaseName string) ([]*metadatapb.EventMetadata, error) {
+ query := `
+ SELECT DISTINCT EVENT_NAME
+ FROM information_schema.EVENTS
+ WHERE EVENT_SCHEMA = ?
+ ORDER BY EVENT_NAME`
+ rows, err := d.db.QueryContext(ctx, query, databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, query)
+ }
+ defer rows.Close()
+ var events []*metadatapb.EventMetadata
+ for rows.Next() {
+ event := &metadatapb.EventMetadata{}
+ if err := rows.Scan(&event.Name); err != nil {
+ return nil, err
+ }
+ events = append(events, event)
+ }
+ if err := rows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, query)
+ }
+ return events, nil
+}
+
+func (d *Driver) getTriggerList(ctx context.Context, databaseName string) (map[db.TableKey][]*metadatapb.TriggerMetadata, error) {
+ // Prune to a single database on MariaDB: filter by EVENT_OBJECT_SCHEMA (the
+ // trigger's table schema), not TRIGGER_SCHEMA, which scans every database's
+ // table metadata. A trigger lives in its table's schema, so they are equivalent.
+ triggersQuery := `
+ SELECT
+ TRIGGER_NAME,
+ EVENT_OBJECT_TABLE,
+ EVENT_MANIPULATION,
+ ACTION_TIMING,
+ ACTION_STATEMENT,
+ SQL_MODE,
+ CHARACTER_SET_CLIENT,
+ COLLATION_CONNECTION
+ FROM INFORMATION_SCHEMA.TRIGGERS
+ WHERE EVENT_OBJECT_SCHEMA = ?
+ ORDER BY EVENT_OBJECT_TABLE ASC, EVENT_MANIPULATION ASC, ACTION_TIMING ASC, ACTION_ORDER ASC;
+ `
+ triggerRows, err := d.db.QueryContext(ctx, triggersQuery, databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, triggersQuery)
+ }
+ defer triggerRows.Close()
+ triggerMap := make(map[db.TableKey][]*metadatapb.TriggerMetadata)
+ for triggerRows.Next() {
+ var name, table, event, timing, statement, sqlMode, charsetClient, collationConnection string
+ if err := triggerRows.Scan(
+ &name,
+ &table,
+ &event,
+ &timing,
+ &statement,
+ &sqlMode,
+ &charsetClient,
+ &collationConnection,
+ ); err != nil {
+ return nil, err
+ }
+ trigger := &metadatapb.TriggerMetadata{
+ Name: name,
+ Event: event,
+ Timing: timing,
+ Body: statement,
+ SqlMode: sqlMode,
+ CharacterSetClient: charsetClient,
+ CollationConnection: collationConnection,
+ Comment: "", // MySQL doesn't support trigger comments via information_schema
+ }
+ tableKey := db.TableKey{Schema: "", Table: table}
+ triggerMap[tableKey] = append(triggerMap[tableKey], trigger)
+ }
+ if err := triggerRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, triggersQuery)
+ }
+ return triggerMap, nil
+}
+
+func (d *Driver) syncRoutines(ctx context.Context, databaseName string) ([]*metadatapb.FunctionMetadata, []*metadatapb.ProcedureMetadata, error) {
+ // Query functions and procedure info.
+ routinesQuery := `
+ SELECT
+ ROUTINE_NAME,
+ ROUTINE_TYPE,
+ SQL_MODE,
+ CHARACTER_SET_CLIENT,
+ COLLATION_CONNECTION,
+ DATABASE_COLLATION,
+ IFNULL(ROUTINE_COMMENT, '')
+ FROM
+ INFORMATION_SCHEMA.ROUTINES
+ WHERE ROUTINE_SCHEMA = ? AND ROUTINE_TYPE IN ('FUNCTION', 'PROCEDURE')
+ ORDER BY ROUTINE_TYPE, ROUTINE_NAME;
+ `
+ routineRows, err := d.db.QueryContext(ctx, routinesQuery, d.databaseName)
+ if err != nil {
+ return nil, nil, util.FormatErrorWithQuery(err, routinesQuery)
+ }
+ defer routineRows.Close()
+ var functions []*metadatapb.FunctionMetadata
+ var procedures []*metadatapb.ProcedureMetadata
+ for routineRows.Next() {
+ var name, routineType, routineComment string
+ var sqlMode, charsetClient, collationConnection, databaseCollation sql.NullString
+ if err := routineRows.Scan(
+ &name,
+ &routineType,
+ &sqlMode,
+ &charsetClient,
+ &collationConnection,
+ &databaseCollation,
+ &routineComment,
+ ); err != nil {
+ return nil, nil, err
+ }
+ if strings.EqualFold(routineType, "PROCEDURE") {
+ procedureDef, err := d.getCreateProcedureStmt(ctx, databaseName, name)
+ if err != nil {
+ return nil, nil, err
+ }
+ procedures = append(procedures, &metadatapb.ProcedureMetadata{
+ Name: name,
+ Definition: procedureDef,
+ SqlMode: sqlMode.String,
+ CharacterSetClient: charsetClient.String,
+ CollationConnection: collationConnection.String,
+ DatabaseCollation: databaseCollation.String,
+ Comment: routineComment,
+ })
+ } else {
+ functionDef, err := d.getCreateFunctionStmt(ctx, databaseName, name)
+ if err != nil {
+ return nil, nil, err
+ }
+ functions = append(functions, &metadatapb.FunctionMetadata{
+ Name: name,
+ Definition: functionDef,
+ SqlMode: sqlMode.String,
+ CharacterSetClient: charsetClient.String,
+ CollationConnection: collationConnection.String,
+ DatabaseCollation: databaseCollation.String,
+ Comment: routineComment,
+ })
+ }
+ }
+ if err := routineRows.Err(); err != nil {
+ return nil, nil, util.FormatErrorWithQuery(err, routinesQuery)
+ }
+
+ return functions, procedures, nil
+}
+
+func (d *Driver) getCreateFunctionStmt(ctx context.Context, databaseName, functionName string) (string, error) {
+ query := fmt.Sprintf("SHOW CREATE FUNCTION `%s`.`%s`", databaseName, functionName)
+ rows, err := d.db.QueryContext(ctx, query)
+ if err != nil {
+ return "", util.FormatErrorWithQuery(err, query)
+ }
+ defer rows.Close()
+
+ var createFunction sql.NullString
+
+ columns, err := rows.Columns()
+ if err != nil {
+ return "", err
+ }
+ defIdx := -1
+ for i, column := range columns {
+ if strings.EqualFold(column, "Create Function") {
+ defIdx = i
+ break
+ }
+ }
+
+ if defIdx == -1 {
+ return "", errors.Errorf("failed to find column Create Function")
+ }
+
+ for rows.Next() {
+ dests := make([]any, len(columns))
+ for i := 0; i < len(columns); i++ {
+ if i == defIdx {
+ dests[i] = &createFunction
+ continue
+ }
+ dests[i] = new(string)
+ }
+
+ if err := rows.Scan(dests...); err != nil {
+ return "", err
+ }
+ }
+
+ if err := rows.Err(); err != nil {
+ return "", err
+ }
+
+ if createFunction.Valid {
+ f := createFunction.String
+
+ functionSymbolIdx := strings.Index(f, " FUNCTION ")
+ if functionSymbolIdx >= 0 {
+ f = fmt.Sprintf("CREATE%s", f[functionSymbolIdx:])
+ }
+
+ f = stripReturnsCharset(f)
+
+ return f, nil
+ }
+ return "", nil
+}
+
+// unescapeCheckClause unescapes the check constraint clause stored in
+// information_schema.CHECK_CONSTRAINTS.CHECK_CLAUSE, which escapes single
+// quotes as \' (e.g. (`type` = _utf8mb4\'A\')). The escaped form is not valid
+// SQL and must be unescaped before being written back into DDL.
+func unescapeCheckClause(clause string) string {
+ return strings.ReplaceAll(clause, `\'`, `'`)
+}
+
+func getCheckConstraintQuery(isMariaDB bool) string {
+ if isMariaDB {
+ // MariaDB includes TABLE_NAME in CHECK_CONSTRAINTS. Joining TABLE_CONSTRAINTS
+ // by constraint name/schema is both slower and incorrect because MariaDB check
+ // names are scoped to a table, not the whole schema.
+ return `
+ SELECT
+ TABLE_NAME,
+ CONSTRAINT_NAME,
+ CHECK_CLAUSE
+ FROM information_schema.CHECK_CONSTRAINTS
+ WHERE CONSTRAINT_SCHEMA = ?
+ `
+ }
+
+ return `
+ SELECT
+ tc.TABLE_NAME,
+ cc.CONSTRAINT_NAME,
+ cc.CHECK_CLAUSE
+ FROM information_schema.CHECK_CONSTRAINTS cc
+ JOIN information_schema.TABLE_CONSTRAINTS tc
+ ON cc.CONSTRAINT_NAME = tc.CONSTRAINT_NAME
+ AND cc.CONSTRAINT_SCHEMA = tc.CONSTRAINT_SCHEMA
+ WHERE tc.CONSTRAINT_TYPE = 'CHECK' AND tc.TABLE_SCHEMA = ?
+ `
+}
+
+// stripReturnsCharset removes the " CHARSET ... [COLLATE ...]" attributes that
+// SHOW CREATE FUNCTION appends to the RETURNS clause. The search is anchored to
+// the RETURNS line because the parameter list is preserved verbatim from the
+// original definition: it can span multiple lines and may itself contain
+// CHARSET attributes.
+func stripReturnsCharset(def string) string {
+ returnsIdx := strings.Index(def, " RETURNS ")
+ if returnsIdx == -1 {
+ return def
+ }
+ lineEnd := strings.Index(def[returnsIdx:], "\n")
+ if lineEnd == -1 {
+ return def
+ }
+ charsetIdx := strings.Index(def[returnsIdx:returnsIdx+lineEnd], " CHARSET ")
+ if charsetIdx == -1 {
+ return def
+ }
+ return def[:returnsIdx+charsetIdx] + def[returnsIdx+lineEnd:]
+}
+
+func (d *Driver) getCreateProcedureStmt(ctx context.Context, databaseName, functionName string) (string, error) {
+ query := fmt.Sprintf("SHOW CREATE PROCEDURE `%s`.`%s`", databaseName, functionName)
+ rows, err := d.db.QueryContext(ctx, query)
+ if err != nil {
+ return "", util.FormatErrorWithQuery(err, query)
+ }
+ defer rows.Close()
+
+ var createProcedure sql.NullString
+
+ columns, err := rows.Columns()
+ if err != nil {
+ return "", err
+ }
+ defIdx := -1
+ for i, column := range columns {
+ if strings.EqualFold(column, "Create Procedure") {
+ defIdx = i
+ break
+ }
+ }
+
+ if defIdx == -1 {
+ return "", errors.Errorf("failed to find column Create Procedure")
+ }
+
+ for rows.Next() {
+ dests := make([]any, len(columns))
+ for i := 0; i < len(columns); i++ {
+ if i == defIdx {
+ dests[i] = &createProcedure
+ continue
+ }
+ dests[i] = new(string)
+ }
+
+ if err := rows.Scan(dests...); err != nil {
+ return "", err
+ }
+ }
+
+ if err := rows.Err(); err != nil {
+ return "", err
+ }
+
+ if createProcedure.Valid {
+ p := createProcedure.String
+
+ procedureSymbolIdx := strings.Index(p, " PROCEDURE ")
+ if procedureSymbolIdx >= 0 {
+ p = fmt.Sprintf("CREATE%s", p[procedureSymbolIdx:])
+ }
+
+ return p, nil
+ }
+ return "", nil
+}
+
+// binaryDefaultFormat says how the connected server reports binary-family (binary
+// charset) literal column defaults in information_schema.COLUMNS.COLUMN_DEFAULT.
+// Verified live against MySQL 5.7.25 and 8.0.32; SHOW CREATE TABLE on both versions
+// prints the full raw value as a quoted string, but information_schema does not.
+type binaryDefaultFormat int
+
+const (
+ // binaryDefaultVerbatim keeps the legacy verbatim static-default path. Used for
+ // MariaDB and OceanBase, whose information_schema conventions are not verified.
+ binaryDefaultVerbatim binaryDefaultFormat = iota
+ // binaryDefaultRawBytes: MySQL < 8.0 reports the raw value bytes — padded with
+ // trailing NULs to the declared length for binary(N), and truncated at the first
+ // byte that does not convert to the information_schema character set (e.g. 0xFF).
+ binaryDefaultRawBytes
+ // binaryDefaultHexNotation: MySQL >= 8.0 reports hexadecimal notation text
+ // ("0xABCD"), built from the value truncated at its first NUL byte (which also
+ // strips binary(N) padding).
+ binaryDefaultHexNotation
+)
+
+func setColumnMetadataDefault(column *metadatapb.ColumnMetadata, defaultStr sql.NullString, nullableBool bool, extra string, binaryFormat binaryDefaultFormat) {
+ if defaultStr.Valid {
+ // MySQL handles these defaults differently:
+ // 1. CURRENT_TIMESTAMP functions - stored as function names, need QUOTE() unescaping only
+ // 2. Expression defaults - stored as escaped expression strings, need double unescaping
+ // 3. Binary-family literal defaults - version-specific information_schema encodings,
+ // decoded to one canonical form (never CURRENT_TIMESTAMP: binary types do not
+ // support it, so raw bytes that merely spell it stay a literal)
+ // 4. Static defaults - stored as literal values, keep quoted for mysqldump compatibility
+
+ // First, remove QUOTE() escaping that was added by our SQL query
+ unquotedDefault := UnquoteMySQLString(defaultStr.String)
+ isBinaryDefault := binaryFormat != binaryDefaultVerbatim && isBinaryFamilyColumnType(column.Type)
+ switch {
+ case IsCurrentTimestampLike(unquotedDefault) && !isBinaryDefault:
+ // CURRENT_TIMESTAMP, CURRENT_DATE, etc. - these are function names, not expressions
+ // MySQL stores them without quotes in the catalog, so we just need QUOTE() unescaping
+ column.Default = unquotedDefault
+ case strings.Contains(extra, "DEFAULT_GENERATED"):
+ // Expression defaults like DEFAULT (UUID()) or DEFAULT (JSON_OBJECT('key', value))
+ // MySQL stores the expression as an escaped string in the catalog, then QUOTE() adds another layer
+ // We need both QUOTE() unescaping and catalog storage unescaping
+ unescapedDefault := UnescapeExpressionDefault(unquotedDefault)
+ column.Default = fmt.Sprintf("(%s)", unescapedDefault)
+ case isBinaryDefault:
+ if canonical, ok := canonicalBinaryDefault(unquotedDefault, column.Type, binaryFormat); ok {
+ column.Default = canonical
+ } else {
+ // Unexpected shape for this server version — keep the legacy verbatim form.
+ column.Default = defaultStr.String
+ }
+ default:
+ // Static defaults like DEFAULT 'hello' or DEFAULT 42
+ // MySQL evaluates these at DDL time and stores them as literal values
+ // Preserve quotes for mysqldump compatibility (mysqldump expects quoted literals)
+ column.Default = defaultStr.String
+ }
+ } else if strings.Contains(strings.ToUpper(extra), autoIncrementSymbol) {
+ // TODO(zp): refactor column default value.
+ // Use the upper case to consistent with MySQL Dump.
+ column.Default = autoIncrementSymbol
+ } else if nullableBool {
+ // This is NULL if the column has an explicit default of NULL,
+ // or if the column definition includes no DEFAULT clause.
+ // https://dev.mysql.com/doc/refman/8.0/en/information-schema-columns-table.html
+ column.Default = "NULL"
+ }
+
+ if strings.Contains(extra, "on update CURRENT_TIMESTAMP") {
+ re := regexp.MustCompile(`CURRENT_TIMESTAMP\((\d+)\)`)
+ match := re.FindStringSubmatch(extra)
+ if len(match) > 0 {
+ digits := match[1]
+ column.OnUpdate = fmt.Sprintf("CURRENT_TIMESTAMP(%s)", digits)
+ } else {
+ column.OnUpdate = "CURRENT_TIMESTAMP"
+ }
+ }
+}
+
+// isBinaryFamilyColumnType reports whether an information_schema COLUMN_TYPE spelling
+// denotes a binary-charset string type (binary / varbinary / blob family), whose
+// literal defaults information_schema reports in version-specific encodings.
+func isBinaryFamilyColumnType(columnType string) bool {
+ lower := strings.ToLower(strings.TrimSpace(columnType))
+ switch {
+ case lower == "binary" || strings.HasPrefix(lower, "binary("):
+ return true
+ case lower == "varbinary" || strings.HasPrefix(lower, "varbinary("):
+ return true
+ case lower == "tinyblob" || lower == "mediumblob" || lower == "longblob":
+ return true
+ case lower == "blob" || strings.HasPrefix(lower, "blob("):
+ return true
+ default:
+ return false
+ }
+}
+
+// isFixedBinaryColumnType reports whether COLUMN_TYPE is the fixed-length binary(N)
+// type, whose values (including the stored default on 5.7) are right-padded with NUL
+// bytes to the declared length. The padding is not part of the declared default.
+func isFixedBinaryColumnType(columnType string) bool {
+ lower := strings.ToLower(strings.TrimSpace(columnType))
+ return lower == "binary" || strings.HasPrefix(lower, "binary(")
+}
+
+// canonicalBinaryDefault decodes a binary-family literal column default from the
+// version-specific information_schema encoding (see binaryDefaultFormat) and renders
+// it in the one canonical dump form shared by every version:
+//
+// - an empty string literal (two single quotes) for the empty value (SHOW CREATE
+// prints binary(N) defaults NUL-padded; the padding is dropped because it is
+// reapplied on write and NUL bytes cannot live in the UTF-8 metadata/SDL text),
+// - the SHOW CREATE-style quoted string ('ab', with QUOTE()-style backslash escaping
+// of \ and ') when the bytes are clean printable text,
+// - an unquoted hex literal (0x610062) otherwise — value-equivalent input syntax that
+// both versions accept and that stays representable in UTF-8.
+//
+// Without this, 8.0's hex NOTATION text was re-quoted as a string (DEFAULT '0x6162'),
+// which never converges: cross-version diffs phantom-MODIFY every binary default and
+// re-applying a dump double-encodes it ('0x6162' -> '0x307836313632').
+//
+// The ok result is false when the text does not match the declared encoding (not hex
+// notation on a >= 8.0 server); the caller falls back to the legacy verbatim form.
+func canonicalBinaryDefault(unquoted, columnType string, format binaryDefaultFormat) (string, bool) {
+ var value []byte
+ switch {
+ case format == binaryDefaultHexNotation && unquoted == "":
+ // varbinary DEFAULT '' is reported as an empty string, not as "0x".
+ value = nil
+ case format == binaryDefaultHexNotation:
+ if len(unquoted) < 2 || unquoted[0] != '0' || (unquoted[1] != 'x' && unquoted[1] != 'X') {
+ return "", false
+ }
+ decoded, err := hex.DecodeString(unquoted[2:])
+ if err != nil {
+ return "", false
+ }
+ value = decoded
+ default:
+ value = []byte(unquoted)
+ }
+ if isFixedBinaryColumnType(columnType) {
+ value = bytes.TrimRight(value, "\x00")
+ }
+ if len(value) == 0 {
+ return "''", true
+ }
+ if isCleanDefaultText(value) {
+ escaped := strings.ReplaceAll(string(value), `\`, `\\`)
+ escaped = strings.ReplaceAll(escaped, `'`, `\'`)
+ return "'" + escaped + "'", true
+ }
+ return "0x" + hex.EncodeToString(value), true
+}
+
+// isCleanDefaultText reports whether value can be embedded as a plain quoted string in
+// UTF-8 SDL text: valid UTF-8 with no control bytes (NUL bytes in particular — the
+// information_schema encodings differ on them and SDL must stay NUL-free).
+func isCleanDefaultText(value []byte) bool {
+ if !utf8.Valid(value) {
+ return false
+ }
+ for _, b := range value {
+ if b < 0x20 || b == 0x7F {
+ return false
+ }
+ }
+ return true
+}
+
+// isInvisibleColumnExtra reports whether the information_schema.COLUMNS.EXTRA value
+// carries the standalone INVISIBLE token (MySQL 8.0.23+; MariaDB 10.3+ reports the
+// same token, but the capture site gates on isStockMySQL — see SyncDBSchema). EXTRA
+// can hold several space-separated tokens (e.g. "VIRTUAL GENERATED INVISIBLE" or
+// "DEFAULT_GENERATED on update CURRENT_TIMESTAMP INVISIBLE"), so the token is matched
+// as a whole field rather than a substring.
+func isInvisibleColumnExtra(extra string) bool {
+ for _, tok := range strings.Fields(extra) {
+ if strings.EqualFold(tok, "INVISIBLE") {
+ return true
+ }
+ }
+ return false
+}
+
+// UnescapeExpressionDefault unescapes the default expression for MySQL.
+// This handles the second layer of escaping that MySQL applies when storing
+// expression defaults (like DEFAULT (UUID())) in system catalogs.
+// MySQL stores expressions as escaped strings internally, separate from QUOTE() escaping.
+func UnescapeExpressionDefault(s string) string {
+ s = strings.ReplaceAll(s, `\'`, `'`) // unescape single quote
+ s = strings.ReplaceAll(s, `\\`, `\`) // unescape backslash
+ return s
+}
+
+func IsCurrentTimestampLike(s string) bool {
+ upper := strings.ToUpper(s)
+ if strings.HasPrefix(upper, "CURRENT_TIMESTAMP") {
+ return true
+ }
+ if strings.HasPrefix(upper, "CURRENT_DATE") {
+ return true
+ }
+ return false
+}
+
+func (d *Driver) reconcileViewDefinition(ctx context.Context, databaseName, viewName string) (string, error) {
+ query := fmt.Sprintf("SHOW CREATE VIEW `%s`.`%s`", databaseName, viewName)
+ var createStmt, unused string
+ if err := d.db.QueryRowContext(ctx, query).Scan(&unused, &createStmt, &unused, &unused); err != nil {
+ if noRows := errors.Is(err, sql.ErrNoRows); noRows {
+ slog.Warn("no rows return for query show create view", slog.String("viewName", viewName), slog.String("databaseName", databaseName))
+ return "", nil
+ }
+ return "", errors.Wrapf(err, "failed to scan row for query: %s", query)
+ }
+
+ def, err := getViewDefFromCreateView(createStmt)
+ if err != nil {
+ slog.Warn("failed to get view definition", slog.String("viewName", viewName), slog.String("databaseName", databaseName), log.BBError(err))
+ return "", nil
+ }
+
+ return def, nil
+}
+
+func getViewDefFromCreateView(createView string) (string, error) {
+ viewDefMatching := viewDefMatcher.FindStringSubmatch(createView)
+ if len(viewDefMatching) == 0 {
+ return "", errors.Errorf("failed to match view definition, %s", createView)
+ }
+ for i, name := range viewDefMatcher.SubexpNames() {
+ if name == "def" && i < len(viewDefMatching) {
+ return viewDefMatching[i], nil
+ }
+ }
+ return "", errors.Errorf("failed to match view definition, %s", createView)
+}
+
+func (d *Driver) getForeignKeyList(ctx context.Context, databaseName string) (map[db.TableKey][]*metadatapb.ForeignKeyMetadata, error) {
+ // Prune to a single database on MariaDB instead of opening every database's
+ // table metadata (Error 1969 on large instances). REFERENTIAL_CONSTRAINTS prunes
+ // on CONSTRAINT_SCHEMA; KEY_COLUMN_USAGE prunes only on TABLE_SCHEMA. A foreign
+ // key lives in its table's schema, so the predicates are equivalent. Never wrap
+ // the column in LOWER() -- it defeats the pruning.
+ fkQuery := `
+ SELECT
+ TABLE_NAME,
+ CONSTRAINT_NAME,
+ REFERENCED_TABLE_NAME,
+ DELETE_RULE,
+ UPDATE_RULE,
+ MATCH_OPTION
+ FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS
+ WHERE CONSTRAINT_SCHEMA = ?;
+ `
+
+ kcuQuery := `
+ SELECT
+ TABLE_NAME,
+ CONSTRAINT_NAME,
+ COLUMN_NAME,
+ REFERENCED_COLUMN_NAME
+ FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE
+ WHERE POSITION_IN_UNIQUE_CONSTRAINT IS NOT NULL AND TABLE_SCHEMA = ?
+ ORDER BY TABLE_NAME, CONSTRAINT_NAME, ORDINAL_POSITION;
+ `
+
+ fkRows, err := d.db.QueryContext(ctx, fkQuery, databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, fkQuery)
+ }
+ defer fkRows.Close()
+ fkMap := make(map[db.IndexKey]*metadatapb.ForeignKeyMetadata)
+ for fkRows.Next() {
+ var tableName string
+ var fk metadatapb.ForeignKeyMetadata
+ if err := fkRows.Scan(
+ &tableName,
+ &fk.Name,
+ &fk.ReferencedTable,
+ &fk.OnDelete,
+ &fk.OnUpdate,
+ &fk.MatchType,
+ ); err != nil {
+ return nil, err
+ }
+ key := db.IndexKey{Schema: "", Table: tableName, Index: fk.Name}
+ fkMap[key] = &fk
+ }
+ if err := fkRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, fkQuery)
+ }
+
+ kcuQueryRows, err := d.db.QueryContext(ctx, kcuQuery, databaseName)
+ if err != nil {
+ return nil, util.FormatErrorWithQuery(err, kcuQuery)
+ }
+ defer kcuQueryRows.Close()
+ for kcuQueryRows.Next() {
+ var tableName, fkName, column, referencedColumn string
+ if err := kcuQueryRows.Scan(
+ &tableName,
+ &fkName,
+ &column,
+ &referencedColumn,
+ ); err != nil {
+ return nil, err
+ }
+ key := db.IndexKey{Schema: "", Table: tableName, Index: fkName}
+ if fk, ok := fkMap[key]; ok {
+ fk.Columns = append(fk.Columns, column)
+ fk.ReferencedColumns = append(fk.ReferencedColumns, referencedColumn)
+ }
+ }
+ if err := kcuQueryRows.Err(); err != nil {
+ return nil, util.FormatErrorWithQuery(err, kcuQuery)
+ }
+ unordered := make(map[db.TableKey][]*metadatapb.ForeignKeyMetadata)
+ for key, fk := range fkMap {
+ tableKey := db.TableKey{Schema: "", Table: key.Table}
+ unordered[tableKey] = append(unordered[tableKey], fk)
+ }
+
+ orderedResult := make(map[db.TableKey][]*metadatapb.ForeignKeyMetadata)
+ for key, fks := range unordered {
+ slices.SortFunc(fks, func(x, y *metadatapb.ForeignKeyMetadata) int {
+ if x.Name < y.Name {
+ return -1
+ } else if x.Name > y.Name {
+ return 1
+ }
+ return 0
+ })
+ orderedResult[key] = fks
+ }
+ return orderedResult, nil
+}
+
+func stripSingleQuote(s string) string {
+ if len(s) >= 2 && s[0] == '\'' && s[len(s)-1] == '\'' {
+ return s[1 : len(s)-1]
+ }
+ return s
+}
+
+// UnquoteMySQLString unescapes a string that was escaped by MySQL's QUOTE() function.
+// MySQL's QUOTE() function escapes:
+// - \ → \\
+// - ' → \'
+// - ASCII NUL (0x00) → \0
+// - Control-Z (0x1A) → \Z
+func UnquoteMySQLString(s string) string {
+ if len(s) == 0 {
+ return s
+ }
+
+ // First remove surrounding quotes if present
+ s = stripSingleQuote(s)
+
+ // Now unescape the content
+ result := make([]byte, 0, len(s))
+ for i := 0; i < len(s); i++ {
+ if s[i] == '\\' && i+1 < len(s) {
+ switch s[i+1] {
+ case '\\':
+ result = append(result, '\\')
+ i++ // skip next character
+ case '\'':
+ result = append(result, '\'')
+ i++ // skip next character
+ case '0':
+ result = append(result, 0) // ASCII NUL
+ i++ // skip next character
+ case 'Z':
+ result = append(result, 0x1A) // Control-Z
+ i++ // skip next character
+ case 'n':
+ result = append(result, '\n') // newline
+ i++ // skip next character
+ case 't':
+ result = append(result, '\t') // tab
+ i++ // skip next character
+ case 'r':
+ result = append(result, '\r') // carriage return
+ i++ // skip next character
+ case 'b':
+ result = append(result, '\b') // backspace
+ i++ // skip next character
+ default:
+ // Unknown escape sequence, keep the backslash
+ result = append(result, s[i])
+ }
+ } else {
+ result = append(result, s[i])
+ }
+ }
+ return string(result)
+}
diff --git a/backend/plugin/db/mysql/sync_oceanbase_test.go b/backend/plugin/db/oceanbase/sync_test.go
similarity index 85%
rename from backend/plugin/db/mysql/sync_oceanbase_test.go
rename to backend/plugin/db/oceanbase/sync_test.go
index f863a3fa70..ccef3f5e68 100644
--- a/backend/plugin/db/mysql/sync_oceanbase_test.go
+++ b/backend/plugin/db/oceanbase/sync_test.go
@@ -1,4 +1,4 @@
-package mysql
+package oceanbase
import (
"context"
@@ -50,9 +50,9 @@ func newOceanBaseTestServer(t *testing.T) oceanBaseTestServer {
return oceanBaseTestServer{host: host, port: port, user: cfg.User, password: cfg.Passwd, tenant: tenant}
}
-func (s oceanBaseTestServer) open(ctx context.Context, t *testing.T, engine storepb.Engine, user, password, database string) *Driver {
+func (s oceanBaseTestServer) open(ctx context.Context, t *testing.T, user, password, database string) *Driver {
t.Helper()
- d, err := newDriver().Open(ctx, engine, db.ConnectionConfig{
+ d, err := newDriver().Open(ctx, storepb.Engine_OCEANBASE, db.ConnectionConfig{
DataSource: &storepb.DataSource{
Type: storepb.DataSourceType_ADMIN,
Username: user,
@@ -69,17 +69,17 @@ func (s oceanBaseTestServer) open(ctx context.Context, t *testing.T, engine stor
return driver
}
-// TestSyncOceanBaseTableNamespace covers the OceanBase objects that share the table namespace
+// TestSyncTableNamespace covers the OceanBase objects that share the table namespace
// with base tables. A consumer can only conclude that a table name is free if sync lists every
// one of them.
-func TestSyncOceanBaseTableNamespace(t *testing.T) {
+func TestSyncTableNamespace(t *testing.T) {
server := newOceanBaseTestServer(t)
ctx := context.Background()
startNano := time.Now().UnixNano()
database := fmt.Sprintf("sync_namespace_%d", startNano)
reader := fmt.Sprintf("sync_reader_%d", startNano)
- admin := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, "")
+ admin := server.open(ctx, t, server.user, server.password, "")
_, err := admin.db.ExecContext(ctx, fmt.Sprintf("CREATE DATABASE `%s`", database))
require.NoError(t, err)
t.Cleanup(func() {
@@ -89,7 +89,7 @@ func TestSyncOceanBaseTableNamespace(t *testing.T) {
require.NoError(t, err)
})
- driver := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, database)
+ driver := server.open(ctx, t, server.user, server.password, database)
for _, statement := range []string{
"CREATE TABLE t (id INT PRIMARY KEY, a INT) COMMENT 'base'",
"CREATE VIEW v AS SELECT id, a FROM t",
@@ -153,27 +153,19 @@ func TestSyncOceanBaseTableNamespace(t *testing.T) {
require.NoError(t, err)
_, err = admin.db.ExecContext(ctx, fmt.Sprintf("GRANT SELECT, SHOW VIEW ON `%s`.* TO '%s'@'%%'", database, reader))
require.NoError(t, err)
- asReader := server.open(ctx, t, storepb.Engine_OCEANBASE, reader+"@"+server.tenant, "Reader_pw1", database)
+ asReader := server.open(ctx, t, reader+"@"+server.tenant, "Reader_pw1", database)
metadata, err = asReader.SyncDBSchema(ctx)
require.NoError(t, err)
require.Empty(t, metadata.Schemas[0].MaterializedViews)
require.ElementsMatch(t, []string{"t", "v", "ext", "mlog$_t", container}, syncedRelationNames(metadata.Schemas[0]))
-
- // The same server registered as a MySQL instance keeps the MySQL sync result.
- asMySQL := server.open(ctx, t, storepb.Engine_MYSQL, server.user, server.password, database)
- metadata, err = asMySQL.SyncDBSchema(ctx)
- require.NoError(t, err)
- require.Empty(t, metadata.Schemas[0].ExternalTables)
- require.Empty(t, metadata.Schemas[0].MaterializedViews)
- require.ElementsMatch(t, []string{"t", "v", "mlog$_t", container}, syncedRelationNames(metadata.Schemas[0]))
}
-func TestSyncOceanBaseEvents(t *testing.T) {
+func TestSyncEvents(t *testing.T) {
server := newOceanBaseTestServer(t)
ctx := context.Background()
database := fmt.Sprintf("sync_events_%d", time.Now().UnixNano())
- admin := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, "")
+ admin := server.open(ctx, t, server.user, server.password, "")
_, err := admin.db.ExecContext(ctx, fmt.Sprintf("CREATE DATABASE `%s`", database))
require.NoError(t, err)
t.Cleanup(func() {
@@ -181,7 +173,7 @@ func TestSyncOceanBaseEvents(t *testing.T) {
require.NoError(t, err)
})
- driver := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, database)
+ driver := server.open(ctx, t, server.user, server.password, database)
for _, statement := range []string{
"CREATE TABLE t (id INT)",
"CREATE EVENT e_every ON SCHEDULE EVERY 1 DAY STARTS '2030-01-01 00:00:00' ON COMPLETION PRESERVE DISABLE DO INSERT INTO t VALUES (1)",
@@ -199,22 +191,16 @@ func TestSyncOceanBaseEvents(t *testing.T) {
{Name: "e_at"},
{Name: "e_every"},
}, schema.Events, protocmp.Transform()))
-
- // The same server registered as a MySQL instance keeps the MySQL event sync, which cannot
- // read OceanBase's events.
- asMySQL := server.open(ctx, t, storepb.Engine_MYSQL, server.user, server.password, database)
- _, err = asMySQL.SyncDBSchema(ctx)
- require.ErrorContains(t, err, "CHARACTER_SET_CLIENT")
}
// OceanBase keeps listing a dropped database's events under its name, so a database created
// again under that name lists an event created again twice.
-func TestSyncOceanBaseEventsOfRecreatedDatabase(t *testing.T) {
+func TestSyncEventsOfRecreatedDatabase(t *testing.T) {
server := newOceanBaseTestServer(t)
ctx := context.Background()
database := fmt.Sprintf("sync_recreated_%d", time.Now().UnixNano())
- admin := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, "")
+ admin := server.open(ctx, t, server.user, server.password, "")
t.Cleanup(func() {
_, err := admin.db.ExecContext(ctx, fmt.Sprintf("DROP DATABASE IF EXISTS `%s`", database))
require.NoError(t, err)
@@ -225,7 +211,7 @@ func TestSyncOceanBaseEventsOfRecreatedDatabase(t *testing.T) {
require.NoError(t, err)
_, err = admin.db.ExecContext(ctx, fmt.Sprintf("CREATE DATABASE `%s`", database))
require.NoError(t, err)
- driver := server.open(ctx, t, storepb.Engine_OCEANBASE, server.user, server.password, database)
+ driver := server.open(ctx, t, server.user, server.password, database)
for _, statement := range []string{
"CREATE TABLE t (id INT)",
"CREATE EVENT e ON SCHEDULE EVERY 1 DAY STARTS '2030-01-01 00:00:00' DO DELETE FROM t",
@@ -331,10 +317,10 @@ func newTestOceanBaseMViewDriver(t *testing.T, rows [][]driver.Value, queryErr e
db, err := sql.Open("test_oceanbase_mviews", "")
require.NoError(t, err)
t.Cleanup(func() { _ = db.Close() })
- return &Driver{dbType: storepb.Engine_OCEANBASE, db: db}
+ return &Driver{db: db}
}
-func TestListOceanBaseMaterializedViews(t *testing.T) {
+func TestListMaterializedViews(t *testing.T) {
ctx := context.Background()
containerIndex := &metadatapb.IndexMetadata{Name: "idx_a", Type: "BTREE", Expressions: []string{"a"}, KeyLength: []int64{-1}, Descending: []bool{false}, Visible: true}
tables := []*metadatapb.TableMetadata{
@@ -346,7 +332,7 @@ func TestListOceanBaseMaterializedViews(t *testing.T) {
{"mv", "__mv_container_500006", "select `db`.`t`.`a` AS `a` from `db`.`t`"},
{"mv_unlisted_container", "__mv_container_500009", "select 1 AS `1`"},
}, nil)
- views, err := d.listOceanBaseMaterializedViews(ctx, "db", tables)
+ views, err := d.listMaterializedViews(ctx, "db", tables)
require.NoError(t, err)
require.Empty(t, cmp.Diff([]*metadatapb.MaterializedViewMetadata{
{Name: "mv", Definition: "select `db`.`t`.`a` AS `a` from `db`.`t`", Comment: "materialized", Indexes: []*metadatapb.IndexMetadata{containerIndex}, SkipDump: true},
@@ -356,12 +342,12 @@ func TestListOceanBaseMaterializedViews(t *testing.T) {
// A failed read, such as one without SELECT on the oceanbase database, does not fail the sync.
d = newTestOceanBaseMViewDriver(t, nil, &mysql.MySQLError{Number: 1142, Message: "SELECT command denied to user 'reader'@'%' for table 'dba_mviews'"})
- views, err = d.listOceanBaseMaterializedViews(ctx, "db", tables)
+ views, err = d.listMaterializedViews(ctx, "db", tables)
require.NoError(t, err)
require.Empty(t, views)
canceled, cancel := context.WithCancel(ctx)
cancel()
- _, err = d.listOceanBaseMaterializedViews(canceled, "db", tables)
+ _, err = d.listMaterializedViews(canceled, "db", tables)
require.ErrorIs(t, err, context.Canceled)
}
diff --git a/backend/plugin/db/oceanbase/synonyms.go b/backend/plugin/db/oceanbase/synonyms.go
new file mode 100644
index 0000000000..5cdfb68df6
--- /dev/null
+++ b/backend/plugin/db/oceanbase/synonyms.go
@@ -0,0 +1,33 @@
+package oceanbase
+
+import "strings"
+
+var columnTypeCanonicalSynonyms = map[string]string{
+ // Display width default, the display width attribute is deprecated for integer data types, but exist in
+ // MySQL 5.7.
+ "tinyint(4)": "tinyint",
+ "smallint(6)": "smallint",
+ "mediumint(9)": "mediumint",
+ "int(11)": "int",
+ "bigint(20)": "bigint",
+ "char(1)": "char",
+
+ // Numeric Data Type Synonyms.
+ "integer": "int",
+ "boolean": "tinyint(1)",
+ "decimal(10, 0)": "decimal",
+ "dec": "decimal",
+
+ // TODO(zp): handle other column type synonyms and considering handling
+ // variant display width match, for example, dec(20, 0) are equivalent with decimal(20, 0).
+}
+
+// GetColumnTypeCanonicalSynonym returns the canonical synonyms of the given column types,
+// returns the original one if no synonym was found.
+func GetColumnTypeCanonicalSynonym(columnType string) string {
+ if canonical, ok := columnTypeCanonicalSynonyms[strings.ToLower(columnType)]; ok {
+ return canonical
+ }
+
+ return columnType
+}
diff --git a/backend/plugin/db/oceanbase/testutil_test.go b/backend/plugin/db/oceanbase/testutil_test.go
new file mode 100644
index 0000000000..00b3c2d2cf
--- /dev/null
+++ b/backend/plugin/db/oceanbase/testutil_test.go
@@ -0,0 +1,45 @@
+package oceanbase
+
+import (
+ "database/sql/driver"
+ "io"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+)
+
+func columnNames(columns []*metadatapb.ColumnMetadata) []string {
+ var names []string
+ for _, column := range columns {
+ names = append(names, column.Name)
+ }
+ return names
+}
+
+// testExplainResultRows is a fake result set for the EXPLAIN FORMAT=JSON plans the
+// sync and stats tests feed through a registered test driver.
+type testExplainResultRows struct {
+ // columns defaults to the single EXPLAIN column of a JSON plan.
+ columns []string
+ rows [][]driver.Value
+ idx int
+}
+
+func (r *testExplainResultRows) Columns() []string {
+ if r.columns != nil {
+ return r.columns
+ }
+ return []string{"EXPLAIN"}
+}
+
+func (*testExplainResultRows) Close() error {
+ return nil
+}
+
+func (r *testExplainResultRows) Next(dest []driver.Value) error {
+ if r.idx >= len(r.rows) {
+ return io.EOF
+ }
+ copy(dest, r.rows[r.idx])
+ r.idx++
+ return nil
+}
diff --git a/backend/plugin/parser/mysql/completion.go b/backend/plugin/parser/mysql/completion.go
index fcda9dece0..8d2bf6aca2 100644
--- a/backend/plugin/parser/mysql/completion.go
+++ b/backend/plugin/parser/mysql/completion.go
@@ -19,7 +19,6 @@ import (
func init() {
base.RegisterCompleteFunc(storepb.Engine_MYSQL, Completion)
base.RegisterCompleteFunc(storepb.Engine_MARIADB, Completion)
- base.RegisterCompleteFunc(storepb.Engine_OCEANBASE, Completion)
base.RegisterCompleteFunc(storepb.Engine_CLICKHOUSE, Completion)
base.RegisterCompleteFunc(storepb.Engine_STARROCKS, Completion)
base.RegisterCompleteFunc(storepb.Engine_DORIS, Completion)
diff --git a/backend/plugin/parser/mysql/diagnose.go b/backend/plugin/parser/mysql/diagnose.go
index 23f96480a2..8f0ba0a60c 100644
--- a/backend/plugin/parser/mysql/diagnose.go
+++ b/backend/plugin/parser/mysql/diagnose.go
@@ -14,7 +14,6 @@ import (
func init() {
base.RegisterDiagnoseFunc(storepb.Engine_MYSQL, Diagnose)
- base.RegisterDiagnoseFunc(storepb.Engine_OCEANBASE, Diagnose)
base.RegisterDiagnoseFunc(storepb.Engine_CLICKHOUSE, Diagnose)
}
diff --git a/backend/plugin/parser/mysql/explain.go b/backend/plugin/parser/mysql/explain.go
index 1aaa0dd996..9ac25055bd 100644
--- a/backend/plugin/parser/mysql/explain.go
+++ b/backend/plugin/parser/mysql/explain.go
@@ -13,7 +13,6 @@ import (
func init() {
base.RegisterExplainStatementFunc(storepb.Engine_MYSQL, explainStatement)
base.RegisterExplainStatementFunc(storepb.Engine_MARIADB, explainStatement)
- base.RegisterExplainStatementFunc(storepb.Engine_OCEANBASE, explainStatement)
}
// explainStatement implements base.ExplainStatement. MySQL and MariaDB both
diff --git a/backend/plugin/parser/mysql/explain_plan.go b/backend/plugin/parser/mysql/explain_plan.go
index 943703e439..11b5cd190a 100644
--- a/backend/plugin/parser/mysql/explain_plan.go
+++ b/backend/plugin/parser/mysql/explain_plan.go
@@ -171,47 +171,6 @@ func CapAffectedRowsByLimit(stmt ast.Node, rows float64) int64 {
return count
}
-// EstimateAffectedRowsFromOceanBaseExplainJSON returns the EST.ROWS estimate from OceanBase
-// `EXPLAIN FORMAT=JSON` output: the root operator's, or the largest child operator's when the
-// root has no operator.
-func EstimateAffectedRowsFromOceanBaseExplainJSON(plan string) (int64, error) {
- var root map[string]any
- if err := json.Unmarshal([]byte(plan), &root); err != nil {
- return 0, errors.Wrap(err, "failed to parse EXPLAIN FORMAT=JSON output")
- }
- if operator, ok := root["OPERATOR"].(string); ok && operator != "" {
- rows, ok := planNumber(root["EST.ROWS"])
- if !ok {
- return 0, errors.Errorf("operator %q has no EST.ROWS", operator)
- }
- return common.RoundRows(rows), nil
- }
- var maxRows float64
- found := false
- for key, value := range root {
- child, ok := value.(map[string]any)
- if !ok || !strings.HasPrefix(key, "CHILD_") {
- continue
- }
- operator, ok := child["OPERATOR"].(string)
- if !ok || operator == "" {
- continue
- }
- rows, ok := planNumber(child["EST.ROWS"])
- if !ok {
- return 0, errors.Errorf("operator %q has no EST.ROWS", operator)
- }
- if !found || rows > maxRows {
- maxRows = rows
- found = true
- }
- }
- if !found {
- return 0, errors.New("the plan has no operator")
- }
- return common.RoundRows(maxRows), nil
-}
-
// queryBlockRows returns the planner's estimate of the rows a query block produces. A UNION sums its
// branches, an INTERSECT takes the fewest, and an EXCEPT, or a parenthesized query with its own
// ORDER BY or LIMIT, takes its first.
diff --git a/backend/plugin/parser/mysql/explain_plan_test.go b/backend/plugin/parser/mysql/explain_plan_test.go
index be4d289cd5..5f61cf988b 100644
--- a/backend/plugin/parser/mysql/explain_plan_test.go
+++ b/backend/plugin/parser/mysql/explain_plan_test.go
@@ -506,68 +506,6 @@ func TestEstimateAffectedRowsFromExplainJSONError(t *testing.T) {
}
}
-func TestEstimateAffectedRowsFromOceanBaseExplainJSON(t *testing.T) {
- for _, tc := range []struct {
- name string
- plan string
- want int64
- }{
- {
- name: "root operator",
- plan: `{"ID":0,"OPERATOR":"UPDATE","NAME":"","EST.ROWS":1000,"EST.TIME(us)":7680,"output":"","CHILD_1":{"ID":1,"OPERATOR":"TABLE RANGE SCAN","NAME":"dba_test_1","EST.ROWS":1200,"EST.TIME(us)":91}}`,
- want: 1000,
- },
- {
- name: "fractional estimate",
- plan: `{"ID":0,"OPERATOR":"DELETE","NAME":"","EST.ROWS":2.6,"EST.TIME(us)":20}`,
- want: 3,
- },
- {
- name: "largest child operator without a root operator",
- plan: `{"CHILD_1":{"ID":1,"OPERATOR":"TABLE FULL SCAN","NAME":"t1","EST.ROWS":40},"CHILD_2":{"ID":2,"OPERATOR":"TABLE FULL SCAN","NAME":"t2","EST.ROWS":70}}`,
- want: 70,
- },
- } {
- t.Run(tc.name, func(t *testing.T) {
- got, err := EstimateAffectedRowsFromOceanBaseExplainJSON(tc.plan)
- require.NoError(t, err)
- require.Equal(t, tc.want, got)
- })
- }
-
- for _, tc := range []struct {
- name string
- plan string
- wantErr string
- }{
- {
- name: "root operator without an estimate",
- plan: `{"ID":0,"OPERATOR":"UPDATE","NAME":""}`,
- wantErr: `operator "UPDATE" has no EST.ROWS`,
- },
- {
- name: "child operator without an estimate",
- plan: `{"CHILD_1":{"ID":1,"OPERATOR":"TABLE FULL SCAN","NAME":"t1"}}`,
- wantErr: `operator "TABLE FULL SCAN" has no EST.ROWS`,
- },
- {
- name: "no operator",
- plan: `{}`,
- wantErr: "the plan has no operator",
- },
- {
- name: "empty output",
- plan: "",
- wantErr: "failed to parse EXPLAIN FORMAT=JSON output",
- },
- } {
- t.Run(tc.name, func(t *testing.T) {
- _, err := EstimateAffectedRowsFromOceanBaseExplainJSON(tc.plan)
- require.ErrorContains(t, err, tc.wantErr)
- })
- }
-}
-
func readExplainPlanFixture(t *testing.T, fixture string) string {
t.Helper()
plan, err := os.ReadFile(filepath.Join("test-data", "explain-plan", fixture))
diff --git a/backend/plugin/parser/mysql/limit.go b/backend/plugin/parser/mysql/limit.go
index 6388c41fec..98a08f709c 100644
--- a/backend/plugin/parser/mysql/limit.go
+++ b/backend/plugin/parser/mysql/limit.go
@@ -18,11 +18,10 @@ import (
func init() {
base.RegisterResultLimitFunc(storepb.Engine_MYSQL, statementWithResultLimit)
base.RegisterResultLimitFunc(storepb.Engine_MARIADB, statementWithResultLimit)
- base.RegisterResultLimitFunc(storepb.Engine_OCEANBASE, statementWithResultLimit)
}
-// statementWithResultLimit implements base.ResultLimitFunc for MySQL, MariaDB
-// and OceanBase, which share this grammar. None takes an engineVersion.
+// statementWithResultLimit implements base.ResultLimitFunc for MySQL and MariaDB,
+// which share this grammar. Neither takes an engineVersion.
func statementWithResultLimit(statement string, limit int, _ string) string {
stmt, err := statementWithResultLimitInline(statement, limit)
if err != nil {
diff --git a/backend/plugin/parser/mysql/mysql.go b/backend/plugin/parser/mysql/mysql.go
index da81d0feb2..7615a0d125 100644
--- a/backend/plugin/parser/mysql/mysql.go
+++ b/backend/plugin/parser/mysql/mysql.go
@@ -15,13 +15,11 @@ import (
func init() {
base.RegisterParseStatementsFunc(storepb.Engine_MYSQL, parseMySQLStatements)
base.RegisterParseStatementsFunc(storepb.Engine_MARIADB, parseMariaDBStatements)
- base.RegisterParseStatementsFunc(storepb.Engine_OCEANBASE, parseMySQLStatements)
base.RegisterGetStatementTypes(storepb.Engine_MYSQL, GetStatementTypes)
base.RegisterGetStatementTypes(storepb.Engine_MARIADB, GetStatementTypes)
- base.RegisterGetStatementTypes(storepb.Engine_OCEANBASE, GetStatementTypes)
}
-// parseMySQLStatements is the ParseStatementsFunc for MySQL and OceanBase.
+// parseMySQLStatements is the ParseStatementsFunc for MySQL.
// Returns []ParsedStatement with both text and AST populated.
func parseMySQLStatements(statement string) ([]base.ParsedStatement, error) {
return parseStatements(statement, false /* mariaDBFallback */)
diff --git a/backend/plugin/parser/mysql/mysql_test.go b/backend/plugin/parser/mysql/mysql_test.go
index 334bcf779a..1eb3d720f0 100644
--- a/backend/plugin/parser/mysql/mysql_test.go
+++ b/backend/plugin/parser/mysql/mysql_test.go
@@ -76,7 +76,7 @@ func TestParseStatementsSyntaxErrorColumnOnSharedLine(t *testing.T) {
}
func TestParseMySQLStatementsRejectsMariaDBSyntax(t *testing.T) {
- for _, engine := range []storepb.Engine{storepb.Engine_MYSQL, storepb.Engine_OCEANBASE} {
+ for _, engine := range []storepb.Engine{storepb.Engine_MYSQL} {
_, err := base.ParseStatements(engine, "CREATE OR REPLACE TABLE t (a INT);")
var syntaxErr *base.SyntaxError
diff --git a/backend/plugin/parser/mysql/omni.go b/backend/plugin/parser/mysql/omni.go
index fb0312dde6..ef43801146 100644
--- a/backend/plugin/parser/mysql/omni.go
+++ b/backend/plugin/parser/mysql/omni.go
@@ -20,6 +20,12 @@ type OmniAST struct {
StartPosition *storepb.Position
}
+// ASTSource returns the statement's own text, which consumers shared with the other
+// MySQL-family engines read to re-derive a node.
+func (a *OmniAST) ASTSource() string {
+ return a.Text
+}
+
// ASTStartPosition implements base.AST.
func (a *OmniAST) ASTStartPosition() *storepb.Position {
return a.StartPosition
diff --git a/backend/plugin/parser/mysql/query.go b/backend/plugin/parser/mysql/query.go
index 749ee1a2f7..29f965520d 100644
--- a/backend/plugin/parser/mysql/query.go
+++ b/backend/plugin/parser/mysql/query.go
@@ -10,7 +10,6 @@ import (
func init() {
base.RegisterQueryValidator(storepb.Engine_MYSQL, validateQuery)
base.RegisterQueryValidator(storepb.Engine_MARIADB, validateQuery)
- base.RegisterQueryValidator(storepb.Engine_OCEANBASE, validateQuery)
}
// validateQuery validates the SQL statement for SQL editor.
diff --git a/backend/plugin/parser/mysql/query_span.go b/backend/plugin/parser/mysql/query_span.go
index dc0624252a..a6335c3ab6 100644
--- a/backend/plugin/parser/mysql/query_span.go
+++ b/backend/plugin/parser/mysql/query_span.go
@@ -10,7 +10,6 @@ import (
func init() {
base.RegisterGetQuerySpan(storepb.Engine_MYSQL, GetQuerySpan)
base.RegisterGetQuerySpan(storepb.Engine_MARIADB, GetQuerySpan)
- base.RegisterGetQuerySpan(storepb.Engine_OCEANBASE, GetQuerySpan)
}
// GetQuerySpan returns the query span for the given statement.
diff --git a/backend/plugin/parser/mysql/resource_change.go b/backend/plugin/parser/mysql/resource_change.go
index f2c1fe782d..0109f58852 100644
--- a/backend/plugin/parser/mysql/resource_change.go
+++ b/backend/plugin/parser/mysql/resource_change.go
@@ -15,7 +15,6 @@ import (
func init() {
base.RegisterExtractChangedResourcesFunc(storepb.Engine_MYSQL, extractChangedResources)
base.RegisterExtractChangedResourcesFunc(storepb.Engine_MARIADB, extractChangedResources)
- base.RegisterExtractChangedResourcesFunc(storepb.Engine_OCEANBASE, extractChangedResources)
base.RegisterExtractChangedResourcesFunc(storepb.Engine_STARROCKS, extractChangedResources)
base.RegisterExtractChangedResourcesFunc(storepb.Engine_DORIS, extractChangedResources)
}
diff --git a/backend/plugin/parser/mysql/split.go b/backend/plugin/parser/mysql/split.go
index c51bf93d46..4afac2224a 100644
--- a/backend/plugin/parser/mysql/split.go
+++ b/backend/plugin/parser/mysql/split.go
@@ -10,7 +10,6 @@ import (
func init() {
base.RegisterSplitterFunc(storepb.Engine_MYSQL, SplitSQL)
base.RegisterSplitterFunc(storepb.Engine_MARIADB, SplitSQL)
- base.RegisterSplitterFunc(storepb.Engine_OCEANBASE, SplitSQL)
}
// SplitSQL splits the given SQL statement into multiple SQL statements.
diff --git a/backend/plugin/parser/mysql/statement_type_test.go b/backend/plugin/parser/mysql/statement_type_test.go
index 07fd1419b3..2a23617b62 100644
--- a/backend/plugin/parser/mysql/statement_type_test.go
+++ b/backend/plugin/parser/mysql/statement_type_test.go
@@ -19,8 +19,8 @@ type statementTypeTest struct {
}
// TestGetStatementType runs the fixture under every engine this package
-// registers the classifier for, so MariaDB and OceanBase cannot silently
-// diverge from MySQL (BYT-10136).
+// registers the classifier for, so MariaDB cannot silently diverge from MySQL
+// (BYT-10136).
func TestGetStatementType(t *testing.T) {
tests := []statementTypeTest{}
@@ -44,7 +44,6 @@ func TestGetStatementType(t *testing.T) {
engines := []storepb.Engine{
storepb.Engine_MYSQL,
storepb.Engine_MARIADB,
- storepb.Engine_OCEANBASE,
}
for _, engine := range engines {
t.Run(engine.String(), func(t *testing.T) {
diff --git a/backend/plugin/parser/oceanbase/completion.go b/backend/plugin/parser/oceanbase/completion.go
new file mode 100644
index 0000000000..4f3f2f15f5
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/completion.go
@@ -0,0 +1,1264 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "slices"
+ "strings"
+ "unicode"
+ "unicode/utf8"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ omniparser "github.com/bytebase/omni/oceanbase/parser"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+func init() {
+ base.RegisterCompleteFunc(storepb.Engine_OCEANBASE, Completion)
+}
+
+func Completion(ctx context.Context, cCtx base.CompletionContext, statement string, caretLine int, caretOffset int) ([]base.Candidate, error) {
+ completer := NewStandardCompleter(ctx, cCtx, statement, caretLine, caretOffset)
+ result, err := completer.completion()
+ if err != nil {
+ return nil, err
+ }
+ if len(result) > 0 {
+ return result, nil
+ }
+
+ trickyCompleter := NewTrickyCompleter(ctx, cCtx, statement, caretLine, caretOffset)
+ return trickyCompleter.completion()
+}
+
+func computeSQLAndByteOffset(statement string, caretLine int, caretOffset int, tricky bool) (string, int) {
+ var sql string
+ var newLine, newOffset int
+ if tricky {
+ sql, newLine, newOffset = skipHeadingSQLs(statement, caretLine, caretOffset)
+ sql, newLine, newOffset = skipHeadingSQLWithoutSemicolon(sql, newLine, newOffset)
+ } else {
+ sql, newLine, newOffset = skipHeadingSQLs(statement, caretLine, caretOffset)
+ }
+ return sql, lineColumnToByteOffset(sql, newLine, newOffset)
+}
+
+func lineColumnToByteOffset(sql string, line, column int) int {
+ currentLine := 1
+ for i := 0; i < len(sql); i++ {
+ if currentLine == line {
+ pos := i
+ for c := 0; c < column && pos < len(sql); c++ {
+ _, size := utf8.DecodeRuneInString(sql[pos:])
+ pos += size
+ }
+ if pos > len(sql) {
+ return len(sql)
+ }
+ return pos
+ }
+ if sql[i] == '\n' {
+ currentLine++
+ }
+ }
+ return len(sql)
+}
+
+func isNoSeparatorRequired(tokenType int) bool {
+ switch tokenType {
+ case '.', '(', ')', ',', ';', '=', '<', '>', '+', '-', '*', '/', '%', '^', '~', '!', '@':
+ return true
+ }
+ return false
+}
+
+type Completer struct {
+ ctx context.Context
+ scene base.SceneType
+ sql string
+ cursorByteOffset int
+ tokens []omniparser.Token
+ caretTokenIndex int
+ instanceID string
+ defaultDatabase string
+ getMetadata base.GetDatabaseMetadataFunc
+ listDatabaseNames base.ListDatabaseNamesFunc
+ metadataCache map[string]*model.DatabaseMetadata
+ referencesStack [][]base.TableReference
+ references []base.TableReference
+ cteCache map[int][]*base.VirtualTableReference
+ cteTables []*base.VirtualTableReference
+ caretTokenIsQuoted bool
+}
+
+func NewStandardCompleter(ctx context.Context, cCtx base.CompletionContext, statement string, caretLine int, caretOffset int) *Completer {
+ sql, byteOffset := computeSQLAndByteOffset(statement, caretLine, caretOffset, false)
+ tokens := omniparser.Tokenize(sql)
+ caretTokenIndex := findCaretTokenIndex(tokens, byteOffset)
+ return &Completer{
+ ctx: ctx,
+ scene: cCtx.Scene,
+ sql: sql,
+ cursorByteOffset: byteOffset,
+ tokens: tokens,
+ caretTokenIndex: caretTokenIndex,
+ instanceID: cCtx.InstanceID,
+ defaultDatabase: cCtx.DefaultDatabase,
+ getMetadata: cCtx.Metadata,
+ listDatabaseNames: cCtx.ListDatabaseNames,
+ metadataCache: make(map[string]*model.DatabaseMetadata),
+ cteCache: make(map[int][]*base.VirtualTableReference),
+ }
+}
+
+func NewTrickyCompleter(ctx context.Context, cCtx base.CompletionContext, statement string, caretLine int, caretOffset int) *Completer {
+ sql, byteOffset := computeSQLAndByteOffset(statement, caretLine, caretOffset, true)
+ tokens := omniparser.Tokenize(sql)
+ caretTokenIndex := findCaretTokenIndex(tokens, byteOffset)
+ return &Completer{
+ ctx: ctx,
+ scene: cCtx.Scene,
+ sql: sql,
+ cursorByteOffset: byteOffset,
+ tokens: tokens,
+ caretTokenIndex: caretTokenIndex,
+ instanceID: cCtx.InstanceID,
+ defaultDatabase: cCtx.DefaultDatabase,
+ getMetadata: cCtx.Metadata,
+ listDatabaseNames: cCtx.ListDatabaseNames,
+ metadataCache: make(map[string]*model.DatabaseMetadata),
+ cteCache: make(map[int][]*base.VirtualTableReference),
+ }
+}
+
+func findCaretTokenIndex(tokens []omniparser.Token, byteOffset int) int {
+ for i, tok := range tokens {
+ if tok.Loc >= byteOffset {
+ return i
+ }
+ }
+ return len(tokens)
+}
+
+func (c *Completer) completion() ([]base.Candidate, error) {
+ // Check if the caret is inside or at the start of a backtick-quoted identifier.
+ // caretTokenIndex points to the first token at or after cursorByteOffset, so
+ // the containing token (when the cursor is inside one) is at index-1.
+ checkTokenQuoted := func(idx int) bool {
+ if idx < 0 || idx >= len(c.tokens) {
+ return false
+ }
+ tok := c.tokens[idx]
+ return omniparser.IsIdentTokenType(tok.Type) && tok.Loc < len(c.sql) && c.sql[tok.Loc] == '`'
+ }
+ if checkTokenQuoted(c.caretTokenIndex) {
+ c.caretTokenIsQuoted = true
+ } else if c.caretTokenIndex > 0 {
+ prev := c.tokens[c.caretTokenIndex-1]
+ if prev.End >= c.cursorByteOffset && checkTokenQuoted(c.caretTokenIndex-1) {
+ c.caretTokenIsQuoted = true
+ }
+ }
+
+ caretIndex := c.caretTokenIndex
+ if caretIndex > 0 && !isNoSeparatorRequired(c.tokens[caretIndex-1].Type) {
+ caretIndex--
+ }
+ c.referencesStack = append([][]base.TableReference{{}}, c.referencesStack...)
+
+ candidates := omniparser.Collect(c.sql, c.cursorByteOffset)
+
+ if len(candidates.Rules) == 0 {
+ if prefixTok, ok := c.prefixToken(); ok {
+ candidates = omniparser.Collect(c.sql, prefixTok.Loc)
+ }
+ }
+
+ for _, rc := range candidates.Rules {
+ if rc.Rule == "columnref" {
+ c.collectLeadingTableReferences(caretIndex)
+ c.takeReferencesSnapshot()
+ c.collectRemainingTableReferences()
+ c.takeReferencesSnapshot()
+ break
+ }
+ }
+
+ return c.convertCandidates(candidates)
+}
+
+func (c *Completer) prefixToken() (omniparser.Token, bool) {
+ idx := c.caretTokenIndex
+ if idx < len(c.tokens) {
+ tok := c.tokens[idx]
+ if tok.Loc < c.cursorByteOffset && c.cursorByteOffset <= tok.End && omniparser.IsIdentTokenType(tok.Type) {
+ return tok, true
+ }
+ }
+ if idx > 0 {
+ tok := c.tokens[idx-1]
+ if tok.End == c.cursorByteOffset && omniparser.IsIdentTokenType(tok.Type) {
+ return tok, true
+ }
+ }
+ return omniparser.Token{}, false
+}
+
+type CompletionMap map[string]base.Candidate
+
+func (m CompletionMap) Insert(entry base.Candidate) {
+ m[entry.String()] = entry
+}
+
+func (m CompletionMap) insertFunctions() {
+ for _, name := range getMySQLBuiltinFunctions() {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeFunction,
+ Text: name + "()",
+ })
+ }
+}
+
+func (m CompletionMap) insertDatabases(c *Completer) {
+ for _, database := range c.listAllDatabases() {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeDatabase,
+ Text: database,
+ })
+ }
+}
+
+func (m CompletionMap) insertTables(c *Completer, schemas map[string]bool) {
+ for schema := range schemas {
+ if len(schema) == 0 {
+ for _, table := range c.cteTables {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeTable,
+ Text: c.quotedIdentifierIfNeeded(table.Table),
+ })
+ }
+ continue
+ }
+ for _, table := range c.listTables(schema) {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeTable,
+ Text: c.quotedIdentifierIfNeeded(table),
+ })
+ }
+ }
+}
+
+func (m CompletionMap) insertViews(c *Completer, schemas map[string]bool) {
+ for schema := range schemas {
+ for _, view := range c.listViews(schema) {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeView,
+ Text: c.quotedIdentifierIfNeeded(view),
+ })
+ }
+ }
+}
+
+func (m CompletionMap) insertColumns(c *Completer, databases, tables map[string]bool) {
+ for database := range databases {
+ if len(database) == 0 {
+ for _, table := range c.cteTables {
+ if tables[table.Table] {
+ for _, column := range table.Columns {
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(column),
+ })
+ }
+ }
+ }
+ continue
+ }
+ if _, exists := c.metadataCache[database]; !exists {
+ _, metadata, err := c.getMetadata(c.ctx, c.instanceID, database)
+ if err != nil || metadata == nil {
+ continue
+ }
+ c.metadataCache[database] = metadata
+ }
+
+ for table := range tables {
+ tableMeta := c.metadataCache[database].GetSchemaMetadata("").GetTable(table)
+ if tableMeta == nil {
+ continue
+ }
+ for _, column := range tableMeta.GetProto().GetColumns() {
+ definition := fmt.Sprintf("%s | %s", table, column.Type)
+ if !column.Nullable {
+ definition += ", NOT NULL"
+ }
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(column.Name),
+ Definition: definition,
+ Comment: column.Comment,
+ })
+ }
+ }
+ }
+}
+
+func (m CompletionMap) insertAllColumns(c *Completer) {
+ if _, exists := c.metadataCache[c.defaultDatabase]; !exists {
+ _, metadata, err := c.getMetadata(c.ctx, c.instanceID, c.defaultDatabase)
+ if err != nil || metadata == nil {
+ return
+ }
+ c.metadataCache[c.defaultDatabase] = metadata
+ }
+
+ metadata := c.metadataCache[c.defaultDatabase]
+ for _, schema := range metadata.ListSchemaNames() {
+ schemaMeta := metadata.GetSchemaMetadata(schema)
+ if schemaMeta == nil {
+ continue
+ }
+ for _, table := range schemaMeta.ListTableNames() {
+ tableMeta := schemaMeta.GetTable(table)
+ if tableMeta == nil {
+ continue
+ }
+ for _, column := range tableMeta.GetProto().GetColumns() {
+ definition := fmt.Sprintf("%s | %s", table, column.Type)
+ if !column.Nullable {
+ definition += ", NOT NULL"
+ }
+ m.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(column.Name),
+ Definition: definition,
+ Comment: column.Comment,
+ })
+ }
+ }
+ }
+}
+
+func (m CompletionMap) toSlice() []base.Candidate {
+ var result []base.Candidate
+ for _, candidate := range m {
+ result = append(result, candidate)
+ }
+ slices.SortFunc(result, func(a, b base.Candidate) int {
+ if a.Type != b.Type {
+ if a.Type < b.Type {
+ return -1
+ }
+ return 1
+ }
+ if a.Text < b.Text {
+ return -1
+ }
+ if a.Text > b.Text {
+ return 1
+ }
+ return 0
+ })
+ return result
+}
+
+func (c *Completer) convertCandidates(candidates *omniparser.CandidateSet) ([]base.Candidate, error) {
+ keywordEntries := make(CompletionMap)
+ runtimeFunctionEntries := make(CompletionMap)
+ databaseEntries := make(CompletionMap)
+ tableEntries := make(CompletionMap)
+ columnEntries := make(CompletionMap)
+ viewEntries := make(CompletionMap)
+
+ // Token candidates → keywords.
+ for _, tok := range candidates.Tokens {
+ if tok > 0 && tok < 256 {
+ continue
+ }
+ name := omniparser.TokenName(tok)
+ if name == "" {
+ continue
+ }
+ keywordEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeKeyword,
+ Text: name,
+ })
+ }
+
+ for _, rc := range candidates.Rules {
+ c.fetchCommonTableExpression(candidates.CTEPositions)
+
+ switch rc.Rule {
+ case "func_name":
+ runtimeFunctionEntries.insertFunctions()
+ case "database_ref":
+ databaseEntries.insertDatabases(c)
+ case "table_ref":
+ qualifier, flags := c.determineQualifier()
+
+ if flags&ObjectFlagsShowFirst != 0 {
+ databaseEntries.insertDatabases(c)
+ }
+
+ if flags&ObjectFlagsShowSecond != 0 {
+ schemas := make(map[string]bool)
+ if len(qualifier) == 0 {
+ schemas[c.defaultDatabase] = true
+ schemas[""] = true // CTE tables
+ } else {
+ schemas[qualifier] = true
+ }
+ tableEntries.insertTables(c, schemas)
+ viewEntries.insertViews(c, schemas)
+ }
+ case "view_ref":
+ qualifier, flags := c.determineQualifier()
+ if flags&ObjectFlagsShowFirst != 0 {
+ databaseEntries.insertDatabases(c)
+ }
+ if flags&ObjectFlagsShowSecond != 0 {
+ schemas := make(map[string]bool)
+ if len(qualifier) == 0 {
+ schemas[c.defaultDatabase] = true
+ } else {
+ schemas[qualifier] = true
+ }
+ viewEntries.insertViews(c, schemas)
+ }
+ case "index_ref":
+ // Indexes are scoped to tables; without table context just suggest tables.
+ qualifier, flags := c.determineQualifier()
+ if flags&ObjectFlagsShowFirst != 0 {
+ databaseEntries.insertDatabases(c)
+ }
+ if flags&ObjectFlagsShowSecond != 0 {
+ schemas := make(map[string]bool)
+ if len(qualifier) == 0 {
+ schemas[c.defaultDatabase] = true
+ } else {
+ schemas[qualifier] = true
+ }
+ tableEntries.insertTables(c, schemas)
+ }
+ case "columnref":
+ schema, table, flags := c.determineColumnRef()
+
+ if flags&ObjectFlagsShowSchemas != 0 {
+ databaseEntries.insertDatabases(c)
+ }
+
+ databases := make(map[string]bool)
+ if len(schema) != 0 {
+ databases[schema] = true
+ } else if len(c.references) > 0 {
+ for _, reference := range c.references {
+ if physicalTable, ok := reference.(*base.PhysicalTableReference); ok {
+ if len(physicalTable.Database) > 0 {
+ databases[physicalTable.Database] = true
+ }
+ }
+ }
+ }
+
+ if len(schema) == 0 {
+ // Only fall back to default database when references didn't
+ // supply any explicit database. Otherwise we'd mix unrelated
+ // tables from default db with cross-database queries.
+ if len(databases) == 0 {
+ databases[c.defaultDatabase] = true
+ }
+ databases[""] = true // CTE tables
+ }
+
+ if flags&ObjectFlagsShowTables != 0 {
+ tableEntries.insertTables(c, databases)
+ viewEntries.insertViews(c, databases)
+
+ for _, reference := range c.references {
+ switch reference := reference.(type) {
+ case *base.PhysicalTableReference:
+ if len(schema) == 0 && len(reference.Database) == 0 || databases[reference.Database] {
+ if len(reference.Alias) == 0 {
+ tableEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeTable,
+ Text: c.quotedIdentifierIfNeeded(reference.Table),
+ })
+ } else {
+ tableEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeTable,
+ Text: c.quotedIdentifierIfNeeded(reference.Alias),
+ })
+ }
+ }
+ case *base.VirtualTableReference:
+ if len(schema) > 0 {
+ continue
+ }
+ tableEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeTable,
+ Text: c.quotedIdentifierIfNeeded(reference.Table),
+ })
+ default:
+ }
+ }
+ }
+
+ if flags&ObjectFlagsShowColumns != 0 {
+ // determineColumnRef returns schema==table when the user typed
+ // "table.col" — we don't yet know if 'table' is actually a table
+ // or schema, so search both. (Skip when both are empty — that's
+ // the unqualified case.)
+ if schema != "" && schema == table {
+ databases[c.defaultDatabase] = true
+ databases[""] = true
+ }
+
+ tables := make(map[string]bool)
+ if len(table) != 0 {
+ tables[table] = true
+
+ for _, reference := range c.references {
+ switch reference := reference.(type) {
+ case *base.PhysicalTableReference:
+ if strings.EqualFold(reference.Alias, table) {
+ tables[reference.Table] = true
+ databases[reference.Database] = true
+ }
+ case *base.VirtualTableReference:
+ if strings.EqualFold(reference.Table, table) {
+ for _, column := range reference.Columns {
+ columnEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(column),
+ })
+ }
+ }
+ default:
+ }
+ }
+ } else if len(c.references) > 0 {
+ if c.isInAliasAllowedContext() {
+ list := c.fetchSelectItemAliases(candidates.SelectAliasPositions)
+ for _, alias := range list {
+ columnEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(alias),
+ })
+ }
+ }
+ for _, reference := range c.references {
+ switch reference := reference.(type) {
+ case *base.PhysicalTableReference:
+ databases[reference.Database] = true
+ tables[reference.Table] = true
+ case *base.VirtualTableReference:
+ for _, column := range reference.Columns {
+ columnEntries.Insert(base.Candidate{
+ Type: base.CandidateTypeColumn,
+ Text: c.quotedIdentifierIfNeeded(column),
+ })
+ }
+ default:
+ }
+ }
+ } else {
+ columnEntries.insertAllColumns(c)
+ }
+
+ if len(tables) > 0 {
+ columnEntries.insertColumns(c, databases, tables)
+ }
+ }
+ default:
+ }
+ }
+
+ var result []base.Candidate
+ result = append(result, keywordEntries.toSlice()...)
+ result = append(result, runtimeFunctionEntries.toSlice()...)
+ result = append(result, databaseEntries.toSlice()...)
+ result = append(result, tableEntries.toSlice()...)
+ result = append(result, viewEntries.toSlice()...)
+ result = append(result, columnEntries.toSlice()...)
+
+ return result, nil
+}
+
+func (c *Completer) fetchCommonTableExpression(ctePositions []int) {
+ c.cteTables = nil
+ for _, pos := range ctePositions {
+ c.cteTables = append(c.cteTables, c.extractCTETables(pos)...)
+ }
+}
+
+func (c *Completer) extractCTETables(pos int) []*base.VirtualTableReference {
+ if metadata, exists := c.cteCache[pos]; exists {
+ return metadata
+ }
+ if pos >= len(c.sql) {
+ return nil
+ }
+ followingText := c.statementBoundedTextFromByte(pos)
+ if len(followingText) == 0 {
+ return nil
+ }
+
+ const suffix = " SELECT 1"
+ tokens := omniparser.Tokenize(followingText)
+
+ var selStmt *ast.SelectStmt
+ var wrappedSQL string
+ for end := len(tokens); end > 0; end-- {
+ if end < len(tokens) {
+ lastTok := tokens[end-1]
+ wrappedSQL = followingText[:lastTok.End] + suffix
+ } else {
+ wrappedSQL = followingText + suffix
+ }
+ parsed, err := ParseOceanBase(wrappedSQL)
+ if err != nil || parsed == nil || len(parsed.Items) == 0 {
+ continue
+ }
+ sel, ok := parsed.Items[0].(*ast.SelectStmt)
+ if ok && len(sel.CTEs) > 0 {
+ selStmt = sel
+ break
+ }
+ }
+ if selStmt == nil {
+ c.cteCache[pos] = nil
+ return nil
+ }
+
+ var tables []*base.VirtualTableReference
+ for _, cte := range selStmt.CTEs {
+ table := &base.VirtualTableReference{
+ Table: cte.Name,
+ }
+ if len(cte.Columns) > 0 {
+ table.Columns = cte.Columns
+ } else if cte.Select != nil {
+ // Extract query text from wrappedSQL using Loc.
+ loc := cte.Select.Loc
+ if loc.Start >= 0 && loc.End > loc.Start && loc.End <= len(wrappedSQL) {
+ queryText := wrappedSQL[loc.Start:loc.End]
+ if span, err := GetQuerySpan(
+ c.ctx,
+ base.GetQuerySpanContext{
+ InstanceID: c.instanceID,
+ GetDatabaseMetadataFunc: c.getMetadata,
+ ListDatabaseNamesFunc: c.listDatabaseNames,
+ },
+ base.Statement{Text: queryText},
+ c.defaultDatabase,
+ "",
+ false,
+ ); err == nil && span.NotFoundError == nil {
+ for _, column := range span.Results {
+ table.Columns = append(table.Columns, column.Name)
+ }
+ }
+ }
+ }
+ tables = append(tables, table)
+ }
+
+ c.cteCache[pos] = tables
+ return tables
+}
+
+func (c *Completer) isInAliasAllowedContext() bool {
+ level := 0
+ for i := c.caretTokenIndex - 1; i >= 0; i-- {
+ switch c.tokens[i].Type {
+ case ')':
+ level++
+ case '(':
+ if level > 0 {
+ level--
+ } else {
+ return false
+ }
+ default:
+ }
+ if level > 0 {
+ continue
+ }
+ switch c.tokens[i].Type {
+ case omniparser.ORDER, omniparser.GROUP, omniparser.HAVING:
+ return true
+ case omniparser.WHERE, omniparser.ON, omniparser.FROM, omniparser.SELECT,
+ omniparser.LIMIT, omniparser.FOR:
+ return false
+ }
+ }
+ return false
+}
+
+func (c *Completer) fetchSelectItemAliases(aliasPositions []int) []string {
+ aliasMap := make(map[string]bool)
+ for _, pos := range aliasPositions {
+ if aliasText := c.extractAliasText(pos); len(aliasText) > 0 {
+ aliasMap[aliasText] = true
+ }
+ }
+ var result []string
+ for alias := range aliasMap {
+ result = append(result, alias)
+ }
+ slices.Sort(result)
+ return result
+}
+
+func (c *Completer) extractAliasText(pos int) string {
+ if pos >= len(c.sql) {
+ return ""
+ }
+ followingText := c.sql[pos:]
+ if len(followingText) == 0 {
+ return ""
+ }
+
+ tokens := omniparser.Tokenize(followingText)
+ if len(tokens) == 0 {
+ return ""
+ }
+ idx := 0
+ if tokens[0].Type == omniparser.AS && len(tokens) > 1 {
+ idx = 1
+ }
+ if idx >= len(tokens) {
+ return ""
+ }
+ tok := tokens[idx]
+ // Accept identifier tokens (IDENT, backtick-quoted, non-reserved keyword).
+ if omniparser.IsIdentTokenType(tok.Type) {
+ return unquote(tok.Str)
+ }
+ // Accept string literal aliases (e.g., AS 'eid' or AS "eid"). The omni
+ // tokenizer strips the quotes from Str for string literals; detect by
+ // checking the raw source text starts with a quote.
+ if tok.Loc < len(followingText) {
+ ch := followingText[tok.Loc]
+ if ch == '\'' || ch == '"' {
+ return tok.Str
+ }
+ }
+ return ""
+}
+
+type ObjectFlags int
+
+const (
+ ObjectFlagsShowSchemas ObjectFlags = 1 << iota
+ ObjectFlagsShowTables
+ ObjectFlagsShowColumns
+ ObjectFlagsShowFirst
+ ObjectFlagsShowSecond
+)
+
+func (c *Completer) determineQualifier() (string, ObjectFlags) {
+ idx := c.caretTokenIndex
+ if idx < len(c.tokens) && !omniparser.IsIdentTokenType(c.tokens[idx].Type) {
+ idx--
+ } else if idx >= len(c.tokens) {
+ idx = len(c.tokens) - 1
+ }
+
+ if idx < 0 {
+ return "", ObjectFlagsShowFirst | ObjectFlagsShowSecond
+ }
+
+ if idx >= 2 && omniparser.IsIdentTokenType(c.tokens[idx].Type) &&
+ c.tokens[idx-1].Type == '.' &&
+ omniparser.IsIdentTokenType(c.tokens[idx-2].Type) {
+ qualifier := unquote(c.tokens[idx-2].Str)
+ return qualifier, ObjectFlagsShowSecond
+ }
+
+ if idx >= 1 && c.tokens[idx].Type == '.' &&
+ omniparser.IsIdentTokenType(c.tokens[idx-1].Type) {
+ qualifier := unquote(c.tokens[idx-1].Str)
+ return qualifier, ObjectFlagsShowSecond
+ }
+
+ return "", ObjectFlagsShowFirst | ObjectFlagsShowSecond
+}
+
+func (c *Completer) determineColumnRef() (schema, table string, flags ObjectFlags) {
+ idx := c.caretTokenIndex
+ if idx < len(c.tokens) {
+ tt := c.tokens[idx].Type
+ if tt != '.' && !omniparser.IsIdentTokenType(tt) {
+ idx--
+ }
+ } else {
+ idx = len(c.tokens) - 1
+ }
+
+ if idx < 0 {
+ return "", "", ObjectFlagsShowSchemas | ObjectFlagsShowTables | ObjectFlagsShowColumns
+ }
+
+ parts := []string{}
+ pos := idx
+
+ if pos >= 0 && omniparser.IsIdentTokenType(c.tokens[pos].Type) {
+ parts = append(parts, unquote(c.tokens[pos].Str))
+ pos--
+ }
+
+ for pos >= 1 && c.tokens[pos].Type == '.' && omniparser.IsIdentTokenType(c.tokens[pos-1].Type) {
+ parts = append(parts, unquote(c.tokens[pos-1].Str))
+ pos -= 2
+ }
+
+ if idx >= 0 && c.tokens[idx].Type == '.' {
+ switch len(parts) {
+ case 0:
+ return "", "", ObjectFlagsShowSchemas | ObjectFlagsShowTables | ObjectFlagsShowColumns
+ case 1:
+ return parts[0], parts[0], ObjectFlagsShowTables | ObjectFlagsShowColumns
+ default:
+ return parts[1], parts[0], ObjectFlagsShowColumns
+ }
+ }
+
+ switch len(parts) {
+ case 0:
+ return "", "", ObjectFlagsShowSchemas | ObjectFlagsShowTables | ObjectFlagsShowColumns
+ case 1:
+ return "", "", ObjectFlagsShowSchemas | ObjectFlagsShowTables | ObjectFlagsShowColumns
+ case 2:
+ return parts[1], parts[1], ObjectFlagsShowTables | ObjectFlagsShowColumns
+ default:
+ return parts[len(parts)-1], parts[len(parts)-2], ObjectFlagsShowColumns
+ }
+}
+
+func (c *Completer) takeReferencesSnapshot() {
+ for _, references := range c.referencesStack {
+ c.references = append(c.references, references...)
+ }
+}
+
+// statementBoundedText returns the text of c.sql starting at token i and
+// truncated at the next ';' token. Fragment re-parsing (parseTableReferences,
+// extractCTETables) tries progressively shorter token prefixes, so feeding it
+// text past the end of the current statement makes its cost quadratic in the
+// size of the whole sheet instead of the current statement (BYT-9886).
+func (c *Completer) statementBoundedText(i int) string {
+ return c.statementBoundedTextFromByte(c.tokens[i].Loc)
+}
+
+// statementBoundedTextFromByte is statementBoundedText for a byte offset.
+func (c *Completer) statementBoundedTextFromByte(pos int) string {
+ return base.TruncateAtSemicolonToken(c.sql, pos, c.tokens,
+ func(t omniparser.Token) int { return t.Loc },
+ func(t omniparser.Token) int { return t.Type })
+}
+
+func (c *Completer) collectRemainingTableReferences() {
+ level := 0
+ for i := c.caretTokenIndex; i < len(c.tokens); i++ {
+ switch c.tokens[i].Type {
+ case '(':
+ level++
+ case ')':
+ if level > 0 {
+ level--
+ }
+ case ';':
+ // End of the caret's statement: later statements' tables are not
+ // in scope for the caret and must not leak into its completion.
+ return
+ case omniparser.FROM:
+ if level == 0 {
+ c.parseTableReferences(c.statementBoundedText(i))
+ }
+ default:
+ }
+ }
+}
+
+func (c *Completer) collectLeadingTableReferences(caretIndex int) {
+ level := 0
+ for i := 0; i < len(c.tokens) && i < caretIndex; i++ {
+ switch c.tokens[i].Type {
+ case '(':
+ level++
+ c.referencesStack = append([][]base.TableReference{{}}, c.referencesStack...)
+ case ')':
+ if level == 0 {
+ return
+ }
+ level--
+ c.referencesStack = c.referencesStack[1:]
+ case omniparser.FROM:
+ c.parseTableReferences(c.statementBoundedText(i))
+ case omniparser.INSERT, omniparser.INTO:
+ c.parseInsertTableReferences(c.statementBoundedText(i))
+ default:
+ // ALTER TABLE / TRUNCATE TABLE / DROP TABLE / UPDATE / DELETE FROM
+ // — bind the target table for column completion in DDL/DML contexts.
+ if name := omniparser.TokenName(c.tokens[i].Type); name == "ALTER" || name == "TRUNCATE" {
+ c.parseDDLTableReference(i)
+ }
+ }
+ }
+}
+
+// parseDDLTableReference extracts the target table from a DDL statement
+// like "ALTER TABLE t1 ..." or "TRUNCATE TABLE t1".
+func (c *Completer) parseDDLTableReference(startIdx int) {
+ // Skip the ALTER/TRUNCATE keyword.
+ idx := startIdx + 1
+ // Skip optional TABLE keyword.
+ if idx < len(c.tokens) && omniparser.TokenName(c.tokens[idx].Type) == "TABLE" {
+ idx++
+ }
+ // Expect the table name (identifier).
+ if idx >= len(c.tokens) || !omniparser.IsIdentTokenType(c.tokens[idx].Type) {
+ return
+ }
+ ref := &base.PhysicalTableReference{}
+ ref.Table = unquote(c.tokens[idx].Str)
+ idx++
+ // Check for db.table pattern.
+ if idx+1 < len(c.tokens) && c.tokens[idx].Type == '.' && omniparser.IsIdentTokenType(c.tokens[idx+1].Type) {
+ ref.Database = ref.Table
+ ref.Table = unquote(c.tokens[idx+1].Str)
+ }
+ if ref.Database == "" {
+ ref.Database = c.defaultDatabase
+ }
+ c.referencesStack[0] = append(c.referencesStack[0], ref)
+}
+
+func (c *Completer) parseTableReferences(fromClause string) {
+ const prefix = "SELECT * "
+ tokens := omniparser.Tokenize(fromClause)
+
+ var selStmt *ast.SelectStmt
+ var wrappedSQL string
+ for end := len(tokens); end > 0; end-- {
+ if end < len(tokens) {
+ lastTok := tokens[end-1]
+ wrappedSQL = prefix + fromClause[:lastTok.End]
+ } else {
+ wrappedSQL = prefix + fromClause
+ }
+ parsed, err := ParseOceanBase(wrappedSQL)
+ if err != nil || parsed == nil || len(parsed.Items) == 0 {
+ continue
+ }
+ sel, ok := parsed.Items[0].(*ast.SelectStmt)
+ if ok && len(sel.From) > 0 {
+ selStmt = sel
+ break
+ }
+ }
+ if selStmt == nil {
+ return
+ }
+
+ for _, item := range selStmt.From {
+ c.extractFromItem(item, wrappedSQL)
+ }
+}
+
+func (c *Completer) parseInsertTableReferences(insertClause string) {
+ tokens := omniparser.Tokenize(insertClause)
+ idx := 0
+
+ // Skip INSERT or REPLACE keyword.
+ if idx < len(tokens) && (tokens[idx].Type == omniparser.INSERT || tokens[idx].Type == omniparser.REPLACE) {
+ idx++
+ }
+ // Skip optional INSERT modifiers: LOW_PRIORITY, DELAYED, HIGH_PRIORITY, IGNORE.
+ for idx < len(tokens) {
+ name := omniparser.TokenName(tokens[idx].Type)
+ if name == "LOW_PRIORITY" || name == "DELAYED" || name == "HIGH_PRIORITY" || name == "IGNORE" {
+ idx++
+ continue
+ }
+ break
+ }
+ // Skip optional INTO keyword.
+ if idx < len(tokens) && tokens[idx].Type == omniparser.INTO {
+ idx++
+ }
+ if idx >= len(tokens) || !omniparser.IsIdentTokenType(tokens[idx].Type) {
+ return
+ }
+
+ ref := &base.PhysicalTableReference{}
+ ref.Table = unquote(tokens[idx].Str)
+ idx++
+
+ if idx+1 < len(tokens) && tokens[idx].Type == '.' && omniparser.IsIdentTokenType(tokens[idx+1].Type) {
+ ref.Database = ref.Table
+ ref.Table = unquote(tokens[idx+1].Str)
+ }
+
+ if ref.Database == "" {
+ ref.Database = c.defaultDatabase
+ }
+ c.referencesStack[0] = append(c.referencesStack[0], ref)
+}
+
+func (c *Completer) extractFromItem(item ast.TableExpr, wrappedSQL string) {
+ switch v := item.(type) {
+ case *ast.TableRef:
+ ref := &base.PhysicalTableReference{
+ Database: v.Schema,
+ Table: v.Name,
+ Alias: v.Alias,
+ }
+ if ref.Database == "" {
+ ref.Database = c.defaultDatabase
+ }
+ c.referencesStack[0] = append(c.referencesStack[0], ref)
+
+ case *ast.JoinClause:
+ if v.Left != nil {
+ c.extractFromItem(v.Left, wrappedSQL)
+ }
+ if v.Right != nil {
+ c.extractFromItem(v.Right, wrappedSQL)
+ }
+
+ case *ast.SubqueryExpr:
+ if v.Alias == "" {
+ return
+ }
+ virtualRef := &base.VirtualTableReference{
+ Table: v.Alias,
+ }
+ if len(v.Columns) > 0 {
+ virtualRef.Columns = v.Columns
+ } else if v.Select != nil {
+ loc := v.Select.Loc
+ if loc.Start >= 0 && loc.End > loc.Start && loc.End <= len(wrappedSQL) {
+ subqueryText := wrappedSQL[loc.Start:loc.End]
+ if span, err := GetQuerySpan(
+ c.ctx,
+ base.GetQuerySpanContext{
+ InstanceID: c.instanceID,
+ GetDatabaseMetadataFunc: c.getMetadata,
+ ListDatabaseNamesFunc: c.listDatabaseNames,
+ },
+ base.Statement{Text: fmt.Sprintf("SELECT * FROM (%s) AS %s;", subqueryText, v.Alias)},
+ c.defaultDatabase,
+ "",
+ false,
+ ); err == nil && span.NotFoundError == nil {
+ for _, column := range span.Results {
+ virtualRef.Columns = append(virtualRef.Columns, column.Name)
+ }
+ }
+ }
+ }
+ c.referencesStack[0] = append(c.referencesStack[0], virtualRef)
+
+ default:
+ }
+}
+
+// caretLine is 1-based and caretOffset is 0-based.
+func skipHeadingSQLs(statement string, caretLine int, caretOffset int) (string, int, int) {
+ newCaretLine, newCaretOffset := caretLine, caretOffset
+ list, err := SplitSQL(statement)
+ if err != nil || len(base.FilterEmptyStatements(list)) <= 1 {
+ return statement, caretLine, caretOffset
+ }
+
+ start := 0
+ for i, sql := range list {
+ sqlEndLine := int(sql.End.GetLine())
+ sqlEndColumn := int(sql.End.GetColumn())
+ if sqlEndLine > caretLine || (sqlEndLine == caretLine && sqlEndColumn > caretOffset) {
+ start = i
+ if i == 0 {
+ break
+ }
+ previousSQLEndLine := int(list[i-1].End.GetLine())
+ previousSQLEndColumn := int(list[i-1].End.GetColumn())
+ newCaretLine = caretLine - previousSQLEndLine + 1
+ if caretLine == previousSQLEndLine {
+ newCaretOffset = caretOffset - previousSQLEndColumn + 1
+ }
+ break
+ }
+ }
+
+ var buf strings.Builder
+ for i := start; i < len(list); i++ {
+ if _, err := buf.WriteString(list[i].Text); err != nil {
+ return statement, caretLine, caretOffset
+ }
+ }
+
+ return buf.String(), newCaretLine, newCaretOffset
+}
+
+// caretLine is 1-based and caretOffset is 0-based.
+func skipHeadingSQLWithoutSemicolon(statement string, caretLine int, caretOffset int) (string, int, int) {
+ tokens := omniparser.Tokenize(statement)
+ caretByteOff := lineColumnToByteOffset(statement, caretLine, caretOffset)
+
+ latestSelectOffset := -1
+ newCaretLine, newCaretOffset := caretLine, caretOffset
+
+ for _, tok := range tokens {
+ if tok.Loc >= caretByteOff {
+ break
+ }
+ if tok.Type == omniparser.SELECT {
+ atColumn0 := tok.Loc == 0 || statement[tok.Loc-1] == '\n'
+ if atColumn0 {
+ latestSelectOffset = tok.Loc
+ line := 1
+ for j := 0; j < tok.Loc; j++ {
+ if statement[j] == '\n' {
+ line++
+ }
+ }
+ newCaretLine = caretLine - line + 1
+ newCaretOffset = caretOffset
+ }
+ }
+ }
+
+ if latestSelectOffset < 0 {
+ return statement, caretLine, caretOffset
+ }
+
+ return statement[latestSelectOffset:], newCaretLine, newCaretOffset
+}
+
+func unquote(s string) string {
+ if len(s) < 2 {
+ return s
+ }
+ if (s[0] == '`' || s[0] == '\'' || s[0] == '"') && s[0] == s[len(s)-1] {
+ return s[1 : len(s)-1]
+ }
+ return s
+}
+
+func (c *Completer) listAllDatabases() []string {
+ var result []string
+ if c.defaultDatabase != "" {
+ result = append(result, c.defaultDatabase)
+ }
+ for databaseName := range c.metadataCache {
+ if databaseName != c.defaultDatabase {
+ result = append(result, databaseName)
+ }
+ }
+ return result
+}
+
+func (c *Completer) listTables(database string) []string {
+ if _, exists := c.metadataCache[database]; !exists {
+ _, metadata, err := c.getMetadata(c.ctx, c.instanceID, database)
+ if err != nil || metadata == nil {
+ return nil
+ }
+ c.metadataCache[database] = metadata
+ }
+ return c.metadataCache[database].GetSchemaMetadata("").ListTableNames()
+}
+
+func (c *Completer) listViews(database string) []string {
+ if _, exists := c.metadataCache[database]; !exists {
+ _, metadata, err := c.getMetadata(c.ctx, c.instanceID, database)
+ if err != nil || metadata == nil {
+ return nil
+ }
+ c.metadataCache[database] = metadata
+ }
+ return c.metadataCache[database].GetSchemaMetadata("").ListViewNames()
+}
+
+func (c *Completer) quotedIdentifierIfNeeded(s string) string {
+ if c.caretTokenIsQuoted {
+ return s
+ }
+ if omniparser.IsIdentTokenType(omniparser.Tokenize(strings.ToUpper(s))[0].Type) {
+ // It's an identifier or non-reserved keyword, check if it needs quoting.
+ for _, r := range s {
+ if !unicode.IsLetter(r) && !unicode.IsDigit(r) && r != '_' && r != '$' {
+ return fmt.Sprintf("`%s`", s)
+ }
+ }
+ if len(s) > 0 && unicode.IsDigit(rune(s[0])) {
+ return fmt.Sprintf("`%s`", s)
+ }
+ return s
+ }
+ // It's a reserved keyword, quote it.
+ return fmt.Sprintf("`%s`", s)
+}
+
+// getMySQLBuiltinFunctions returns a list of MySQL builtin function names.
+func getMySQLBuiltinFunctions() []string {
+ return []string{
+ "ABS", "ACOS", "ADDDATE", "ADDTIME", "AES_DECRYPT", "AES_ENCRYPT",
+ "ASCII", "ASIN", "ATAN", "ATAN2", "AVG",
+ "BENCHMARK", "BIN", "BIT_AND", "BIT_COUNT", "BIT_LENGTH", "BIT_OR", "BIT_XOR",
+ "CAST", "CEIL", "CEILING", "CHAR", "CHAR_LENGTH", "CHARACTER_LENGTH",
+ "COALESCE", "COERCIBILITY", "COLLATION", "COMPRESS", "CONCAT", "CONCAT_WS",
+ "CONNECTION_ID", "CONV", "CONVERT", "CONVERT_TZ", "COS", "COT", "COUNT",
+ "CRC32", "CURDATE", "CURRENT_DATE", "CURRENT_TIME", "CURRENT_TIMESTAMP",
+ "CURRENT_USER", "CURTIME",
+ "DATABASE", "DATE", "DATE_ADD", "DATE_FORMAT", "DATE_SUB", "DATEDIFF",
+ "DAY", "DAYNAME", "DAYOFMONTH", "DAYOFWEEK", "DAYOFYEAR", "DECODE",
+ "DEFAULT", "DEGREES", "DES_DECRYPT", "DES_ENCRYPT",
+ "ELT", "ENCODE", "ENCRYPT", "EXP", "EXPORT_SET", "EXTRACT",
+ "FIELD", "FIND_IN_SET", "FLOOR", "FORMAT", "FOUND_ROWS", "FROM_BASE64",
+ "FROM_DAYS", "FROM_UNIXTIME",
+ "GET_FORMAT", "GET_LOCK", "GREATEST", "GROUP_CONCAT",
+ "HEX", "HOUR",
+ "IF", "IFNULL", "IN", "INET_ATON", "INET_NTOA", "INET6_ATON", "INET6_NTOA",
+ "INSERT", "INSTR", "IS_FREE_LOCK", "IS_IPV4", "IS_IPV4_COMPAT",
+ "IS_IPV4_MAPPED", "IS_IPV6", "IS_USED_LOCK", "ISNULL",
+ "JSON_ARRAY", "JSON_ARRAYAGG", "JSON_CONTAINS", "JSON_CONTAINS_PATH",
+ "JSON_DEPTH", "JSON_EXTRACT", "JSON_INSERT", "JSON_KEYS", "JSON_LENGTH",
+ "JSON_MERGE", "JSON_MERGE_PATCH", "JSON_MERGE_PRESERVE", "JSON_OBJECT",
+ "JSON_OBJECTAGG", "JSON_OVERLAPS", "JSON_PRETTY", "JSON_QUOTE",
+ "JSON_REMOVE", "JSON_REPLACE", "JSON_SCHEMA_VALID", "JSON_SEARCH",
+ "JSON_SET", "JSON_STORAGE_FREE", "JSON_STORAGE_SIZE", "JSON_TABLE",
+ "JSON_TYPE", "JSON_UNQUOTE", "JSON_VALID", "JSON_VALUE",
+ "LAST_DAY", "LAST_INSERT_ID", "LCASE", "LEAST", "LEFT", "LENGTH",
+ "LN", "LOAD_FILE", "LOCALTIME", "LOCALTIMESTAMP", "LOCATE", "LOG",
+ "LOG10", "LOG2", "LOWER", "LPAD", "LTRIM",
+ "MAKE_SET", "MAKEDATE", "MAKETIME", "MAX", "MD5", "MICROSECOND",
+ "MID", "MIN", "MINUTE", "MOD", "MONTH", "MONTHNAME",
+ "NOW", "NULLIF",
+ "OCT", "OCTET_LENGTH", "ORD",
+ "PASSWORD", "PERIOD_ADD", "PERIOD_DIFF", "PI", "POW", "POWER",
+ "QUARTER",
+ "RADIANS", "RAND", "RANDOM_BYTES", "REGEXP_INSTR", "REGEXP_LIKE",
+ "REGEXP_REPLACE", "REGEXP_SUBSTR", "RELEASE_ALL_LOCKS", "RELEASE_LOCK",
+ "REPEAT", "REPLACE", "REVERSE", "RIGHT", "ROUND", "ROW_COUNT", "RPAD", "RTRIM",
+ "SCHEMA", "SEC_TO_TIME", "SECOND", "SESSION_USER", "SHA1", "SHA2",
+ "SIGN", "SIN", "SLEEP", "SOUNDEX", "SPACE", "SQRT",
+ "STD", "STDDEV", "STDDEV_POP", "STDDEV_SAMP",
+ "STR_TO_DATE", "STRCMP", "SUBDATE", "SUBSTR", "SUBSTRING",
+ "SUBSTRING_INDEX", "SUM", "SYSDATE", "SYSTEM_USER",
+ "TAN", "TIME", "TIME_FORMAT", "TIME_TO_SEC", "TIMEDIFF", "TIMESTAMP",
+ "TIMESTAMPADD", "TIMESTAMPDIFF", "TO_BASE64", "TO_DAYS", "TO_SECONDS",
+ "TRIM", "TRUNCATE",
+ "UCASE", "UNCOMPRESS", "UNCOMPRESSED_LENGTH", "UNHEX",
+ "UNIX_TIMESTAMP", "UPPER", "USER", "UTC_DATE", "UTC_TIME", "UTC_TIMESTAMP",
+ "UUID", "UUID_SHORT", "UUID_TO_BIN",
+ "VALUES", "VAR_POP", "VAR_SAMP", "VARIANCE", "VERSION",
+ "WEEK", "WEEKDAY", "WEEKOFYEAR", "WEIGHT_STRING",
+ "YEAR", "YEARWEEK",
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/completion_test.go b/backend/plugin/parser/oceanbase/completion_test.go
new file mode 100644
index 0000000000..699f1438b2
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/completion_test.go
@@ -0,0 +1,205 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "io"
+ "os"
+ "slices"
+ "strings"
+ "testing"
+ "time"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/stretchr/testify/require"
+ "gopkg.in/yaml.v3"
+
+ "github.com/bytebase/bytebase/backend/common/yamltest"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+type candidatesTest struct {
+ Input string
+ Want []base.Candidate
+}
+
+func TestCompletion(t *testing.T) {
+ tests := []candidatesTest{}
+
+ const (
+ record = false
+ )
+ var (
+ filepath = "test-data/test_completion.yaml"
+ )
+
+ a := require.New(t)
+ yamlFile, err := os.Open(filepath)
+ a.NoError(err)
+
+ byteValue, err := io.ReadAll(yamlFile)
+ a.NoError(yamlFile.Close())
+ a.NoError(err)
+ a.NoError(yaml.Unmarshal(byteValue, &tests))
+
+ for i, t := range tests {
+ text, caretLine, caretCol := catchCaretLineColumn(t.Input)
+ result, err := base.Completion(context.Background(), storepb.Engine_OCEANBASE, base.CompletionContext{
+ Scene: base.SceneTypeAll,
+ DefaultDatabase: "db",
+ Metadata: getMetadataForTest,
+ ListDatabaseNames: listDatabaseNamesForTest,
+ }, text, caretLine, caretCol)
+ a.NoError(err)
+ var filteredResult []base.Candidate
+ for _, r := range result {
+ switch r.Type {
+ case base.CandidateTypeKeyword, base.CandidateTypeFunction:
+ continue
+ default:
+ filteredResult = append(filteredResult, r)
+ }
+ }
+ slices.SortFunc(filteredResult, func(x, y base.Candidate) int {
+ if x.Type != y.Type {
+ if x.Type < y.Type {
+ return -1
+ }
+ return 1
+ }
+ if x.Text != y.Text {
+ if x.Text < y.Text {
+ return -1
+ }
+ return 1
+ }
+ if x.Definition < y.Definition {
+ return -1
+ } else if x.Definition > y.Definition {
+ return 1
+ }
+ return 0
+ })
+
+ if record {
+ tests[i].Want = filteredResult
+ } else {
+ a.Equal(t.Want, filteredResult, t.Input)
+ }
+ }
+
+ if record {
+ yamltest.Record(t, filepath, tests)
+ }
+}
+
+// Completion cost must be bounded by the caret's statement, not the whole
+// sheet: a broken statement anywhere after the caret must not make the
+// FROM-clause re-parse loop shrink through the entire trailing document
+// (BYT-9886).
+func TestCompletionWithBrokenTrailingStatementScalesLinearly(t *testing.T) {
+ a := require.New(t)
+
+ // The caret completes through the JOIN alias a2: resolving a2 to t2's
+ // columns requires parseTableReferences to actually extract the FROM
+ // clause, so an over-truncated (empty) fragment cannot pass this test.
+ var sheet strings.Builder
+ sheet.WriteString("SELECT a2. FROM t1 JOIN t2 a2 ON t1.c1 = a2.c1;\n")
+ sheet.WriteString("SELEC broken FROM oops;\n")
+ for i := range 800 {
+ fmt.Fprintf(&sheet, "SELECT col_a, col_b, col_c FROM table_%04d WHERE col_a = %d AND col_b LIKE 'pattern%%' ORDER BY col_c LIMIT 100;\n", i, i)
+ }
+
+ started := time.Now()
+ result, err := base.Completion(context.Background(), storepb.Engine_OCEANBASE, base.CompletionContext{
+ Scene: base.SceneTypeAll,
+ DefaultDatabase: "db",
+ Metadata: getMetadataForTest,
+ ListDatabaseNames: listDatabaseNamesForTest,
+ }, sheet.String(), 1, 10 /* caret right after "SELECT a2." */)
+ elapsed := time.Since(started)
+
+ a.NoError(err)
+ var texts []string
+ for _, candidate := range result {
+ if candidate.Type == base.CandidateTypeColumn {
+ texts = append(texts, candidate.Text)
+ }
+ }
+ a.Contains(texts, "c1")
+ a.Contains(texts, "c2")
+ a.Less(elapsed, 2*time.Second)
+}
+
+func listDatabaseNamesForTest(_ context.Context, _ string) ([]string, error) {
+ return []string{"db"}, nil
+}
+
+func getMetadataForTest(_ context.Context, _, databaseName string) (string, *model.DatabaseMetadata, error) {
+ if databaseName != "db" {
+ return "", nil, nil
+ }
+
+ return "db", model.NewDatabaseMetadata(&metadatapb.DatabaseSchemaMetadata{
+ Name: databaseName,
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Tables: []*metadatapb.TableMetadata{
+ {
+ Name: "t1",
+ Columns: []*metadatapb.ColumnMetadata{
+ {
+ Name: "c1",
+ },
+ },
+ },
+ {
+ Name: "t2",
+ Columns: []*metadatapb.ColumnMetadata{
+ {
+ Name: "c1",
+ },
+ {
+ Name: "c2",
+ },
+ },
+ },
+ },
+ Views: []*metadatapb.ViewMetadata{
+ {
+ Name: "v1",
+ Definition: `CREATE VIEW v1 AS
+ SELECT *
+ FROM t1
+ `,
+ },
+ },
+ },
+ },
+ }, nil, nil, storepb.Engine_OCEANBASE, true /* isObjectCaseSensitive */), nil
+}
+
+// catchCaretLineColumn returns the SQL without the caret marker and the
+// 1-based line + 0-based column of the caret position. Handles multiline input.
+func catchCaretLineColumn(s string) (string, int, int) {
+ for i, c := range s {
+ if c == '|' {
+ text := s[:i] + s[i+1:]
+ line := 1
+ col := 0
+ for _, ch := range s[:i] {
+ if ch == '\n' {
+ line++
+ col = 0
+ } else {
+ col++
+ }
+ }
+ return text, line, col
+ }
+ }
+ return s, 1, -1
+}
diff --git a/backend/plugin/parser/oceanbase/diagnose.go b/backend/plugin/parser/oceanbase/diagnose.go
new file mode 100644
index 0000000000..68bee9a334
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/diagnose.go
@@ -0,0 +1,56 @@
+package oceanbase
+
+import (
+ "context"
+ "errors"
+ "strings"
+ "unicode"
+
+ mysqlomniparser "github.com/bytebase/omni/oceanbase/parser"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterDiagnoseFunc(storepb.Engine_OCEANBASE, Diagnose)
+}
+
+func Diagnose(_ context.Context, _ base.DiagnoseContext, statement string) ([]base.Diagnostic, error) {
+ diagnostics := make([]base.Diagnostic, 0)
+ syntaxError := parseMySQLStatement(statement)
+ if syntaxError != nil {
+ diagnostics = append(diagnostics, base.ConvertSyntaxErrorToDiagnostic(syntaxError, statement))
+ }
+
+ return diagnostics, nil
+}
+
+func parseMySQLStatement(statement string) *base.SyntaxError {
+ trimmedStatement := strings.TrimRightFunc(statement, unicode.IsSpace)
+ if len(trimmedStatement) > 0 && !strings.HasSuffix(trimmedStatement, ";") {
+ // Add a semicolon to the end of the statement to allow users to omit the semicolon
+ // for the last statement in the script.
+ statement += ";"
+ }
+
+ _, err := ParseOceanBase(statement)
+ if err == nil {
+ return nil
+ }
+
+ var parseErr *mysqlomniparser.ParseError
+ if !errors.As(err, &parseErr) {
+ return &base.SyntaxError{
+ Position: &storepb.Position{Line: 1, Column: 1},
+ Message: err.Error(),
+ }
+ }
+
+ pos := ByteOffsetToRunePosition(statement, parseErr.Position)
+ return &base.SyntaxError{
+ Position: pos,
+ Message: parseErr.Message,
+ RawMessage: parseErr.Message,
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/explain.go b/backend/plugin/parser/oceanbase/explain.go
new file mode 100644
index 0000000000..7cb2050537
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/explain.go
@@ -0,0 +1,135 @@
+package oceanbase
+
+import (
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterExplainStatementFunc(storepb.Engine_OCEANBASE, explainStatement)
+}
+
+// explainStatement implements base.ExplainStatement. MySQL and MariaDB both
+// spell their structured plan FORMAT=JSON; any other format the caller names
+// gets the engine's default plan, since FORMAT=TREE is a shape of its own that
+// nothing downstream reads (the driver capability table refuses the rest).
+func explainStatement(statement string, format base.ExplainFormat) (string, error) {
+ node, err := singleStatement(statement)
+ if err != nil {
+ return "", err
+ }
+ planned := statement
+ if explain, ok := node.(*ast.ExplainStmt); ok {
+ if explain.Analyze {
+ return "", base.ErrExplainAnalyzeExecutes
+ }
+ if inner, ok := explainedText(explain, statement); ok {
+ planned = inner
+ } else {
+ // Nothing to rebuild around, as for EXPLAIN FOR CONNECTION or the
+ // EXPLAIN tbl_name that describes a table. Run what the user wrote
+ // rather than plan a plan.
+ return statement, nil
+ }
+ }
+ if format == base.ExplainFormatJSON {
+ return "EXPLAIN FORMAT=JSON " + planned, nil
+ }
+ return "EXPLAIN " + planned, nil
+}
+
+// DescribeExplain returns the output format of an EXPLAIN statement and whether
+// it executes the statement it plans. It is not an explain at all unless it
+// plans a statement: EXPLAIN tbl_name and DESCRIBE tbl_name parse here too and
+// describe a table's columns, which is a result like any other.
+//
+// An omitted FORMAT is not text: from MySQL 8.0.32 it follows the session's
+// explain_format, which the statement alone does not reveal. It is reported as
+// no format at all, which the caller reads as unknown.
+func DescribeExplain(statement string) (format string, executed bool, ok bool) {
+ node, err := singleStatement(statement)
+ if err != nil {
+ return "", false, false
+ }
+ explain, ok := node.(*ast.ExplainStmt)
+ if !ok {
+ return "", false, false
+ }
+ if _, plans := explainedStart(explain.Stmt); !plans {
+ return "", false, false
+ }
+ switch {
+ case strings.EqualFold(explain.Format, "json"):
+ return "json", explain.Analyze, true
+ case explain.Format == "":
+ return "", explain.Analyze, true
+ default:
+ // TRADITIONAL is a table and TREE a tree of lines; both are text.
+ return "text", explain.Analyze, true
+ }
+}
+
+// singleStatement returns the one statement in text. An explain request plans one
+// statement at a time: both the drivers and the API gate split a multi-statement
+// request first.
+func singleStatement(text string) (ast.Node, error) {
+ list, err := ParseOceanBase(text)
+ if err != nil {
+ return nil, convertOmniError(err, base.Statement{Text: text})
+ }
+ if list == nil || len(list.Items) == 0 {
+ return nil, errors.New("EXPLAIN needs a statement to plan")
+ }
+ if len(list.Items) > 1 {
+ return nil, errors.New("EXPLAIN plans a single statement")
+ }
+ return list.Items[0], nil
+}
+
+// explainedText returns the text within text of the statement explain plans, and
+// whether it could be located.
+func explainedText(explain *ast.ExplainStmt, text string) (string, bool) {
+ // The parser reads the body of an executable comment, so a location can fall
+ // inside one and the slice would leave the comment unclosed.
+ if strings.Contains(text, "/*!") || strings.Contains(text, "/*M!") {
+ return "", false
+ }
+ start, ok := explainedStart(explain.Stmt)
+ if !ok {
+ return "", false
+ }
+ // The plan ends where the EXPLAIN does, which is past clauses that the
+ // planned statement's own location can leave out.
+ if start < 0 || start >= explain.Loc.End || explain.Loc.End > len(text) {
+ return "", false
+ }
+ return text[start:explain.Loc.End], true
+}
+
+// explainedStart returns where a statement that EXPLAIN can plan begins. The
+// cases are what the grammar accepts after EXPLAIN; anything else it parses there
+// describes a table rather than planning a statement.
+func explainedStart(node ast.Node) (int, bool) {
+ switch n := node.(type) {
+ case *ast.SelectStmt:
+ return n.Loc.Start, true
+ // REPLACE parses as an InsertStmt.
+ case *ast.InsertStmt:
+ return n.Loc.Start, true
+ case *ast.UpdateStmt:
+ return n.Loc.Start, true
+ case *ast.DeleteStmt:
+ return n.Loc.Start, true
+ case *ast.TableStmt:
+ return n.Loc.Start, true
+ case *ast.ValuesStmt:
+ return n.Loc.Start, true
+ default:
+ return 0, false
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/explain_plan.go b/backend/plugin/parser/oceanbase/explain_plan.go
new file mode 100644
index 0000000000..bf1e730955
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/explain_plan.go
@@ -0,0 +1,65 @@
+package oceanbase
+
+import (
+ "encoding/json"
+ "strconv"
+ "strings"
+
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common"
+)
+
+// EstimateAffectedRowsFromExplainJSON returns the EST.ROWS estimate from OceanBase
+// `EXPLAIN FORMAT=JSON` output: the root operator's, or the largest child operator's when the
+// root has no operator.
+func EstimateAffectedRowsFromExplainJSON(plan string) (int64, error) {
+ var root map[string]any
+ if err := json.Unmarshal([]byte(plan), &root); err != nil {
+ return 0, errors.Wrap(err, "failed to parse EXPLAIN FORMAT=JSON output")
+ }
+ if operator, ok := root["OPERATOR"].(string); ok && operator != "" {
+ rows, ok := planNumber(root["EST.ROWS"])
+ if !ok {
+ return 0, errors.Errorf("operator %q has no EST.ROWS", operator)
+ }
+ return common.RoundRows(rows), nil
+ }
+ var maxRows float64
+ found := false
+ for key, value := range root {
+ child, ok := value.(map[string]any)
+ if !ok || !strings.HasPrefix(key, "CHILD_") {
+ continue
+ }
+ operator, ok := child["OPERATOR"].(string)
+ if !ok || operator == "" {
+ continue
+ }
+ rows, ok := planNumber(child["EST.ROWS"])
+ if !ok {
+ return 0, errors.Errorf("operator %q has no EST.ROWS", operator)
+ }
+ if !found || rows > maxRows {
+ maxRows = rows
+ found = true
+ }
+ }
+ if !found {
+ return 0, errors.New("the plan has no operator")
+ }
+ return common.RoundRows(maxRows), nil
+}
+
+// planNumber reads an estimate the plan reports either as a JSON number or as a string.
+func planNumber(value any) (float64, bool) {
+ switch v := value.(type) {
+ case float64:
+ return v, true
+ case string:
+ f, err := strconv.ParseFloat(v, 64)
+ return f, err == nil
+ default:
+ return 0, false
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/explain_plan_test.go b/backend/plugin/parser/oceanbase/explain_plan_test.go
new file mode 100644
index 0000000000..edc313a7e9
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/explain_plan_test.go
@@ -0,0 +1,69 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestEstimateAffectedRowsFromExplainJSON(t *testing.T) {
+ for _, tc := range []struct {
+ name string
+ plan string
+ want int64
+ }{
+ {
+ name: "root operator",
+ plan: `{"ID":0,"OPERATOR":"UPDATE","NAME":"","EST.ROWS":1000,"EST.TIME(us)":7680,"output":"","CHILD_1":{"ID":1,"OPERATOR":"TABLE RANGE SCAN","NAME":"dba_test_1","EST.ROWS":1200,"EST.TIME(us)":91}}`,
+ want: 1000,
+ },
+ {
+ name: "fractional estimate",
+ plan: `{"ID":0,"OPERATOR":"DELETE","NAME":"","EST.ROWS":2.6,"EST.TIME(us)":20}`,
+ want: 3,
+ },
+ {
+ name: "largest child operator without a root operator",
+ plan: `{"CHILD_1":{"ID":1,"OPERATOR":"TABLE FULL SCAN","NAME":"t1","EST.ROWS":40},"CHILD_2":{"ID":2,"OPERATOR":"TABLE FULL SCAN","NAME":"t2","EST.ROWS":70}}`,
+ want: 70,
+ },
+ } {
+ t.Run(tc.name, func(t *testing.T) {
+ got, err := EstimateAffectedRowsFromExplainJSON(tc.plan)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, got)
+ })
+ }
+
+ for _, tc := range []struct {
+ name string
+ plan string
+ wantErr string
+ }{
+ {
+ name: "root operator without an estimate",
+ plan: `{"ID":0,"OPERATOR":"UPDATE","NAME":""}`,
+ wantErr: `operator "UPDATE" has no EST.ROWS`,
+ },
+ {
+ name: "child operator without an estimate",
+ plan: `{"CHILD_1":{"ID":1,"OPERATOR":"TABLE FULL SCAN","NAME":"t1"}}`,
+ wantErr: `operator "TABLE FULL SCAN" has no EST.ROWS`,
+ },
+ {
+ name: "no operator",
+ plan: `{}`,
+ wantErr: "the plan has no operator",
+ },
+ {
+ name: "empty output",
+ plan: "",
+ wantErr: "failed to parse EXPLAIN FORMAT=JSON output",
+ },
+ } {
+ t.Run(tc.name, func(t *testing.T) {
+ _, err := EstimateAffectedRowsFromExplainJSON(tc.plan)
+ require.ErrorContains(t, err, tc.wantErr)
+ })
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/explain_test.go b/backend/plugin/parser/oceanbase/explain_test.go
new file mode 100644
index 0000000000..6b9b5ab52a
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/explain_test.go
@@ -0,0 +1,127 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestExplainStatement(t *testing.T) {
+ tests := []struct {
+ statement string
+ want string
+ }{
+ {"SELECT 1", "EXPLAIN SELECT 1"},
+ {"SELECT 1;", "EXPLAIN SELECT 1;"},
+ {"DELETE FROM t", "EXPLAIN DELETE FROM t"},
+ {"UPDATE t SET a = 1", "EXPLAIN UPDATE t SET a = 1"},
+ // A statement that already asks for a plan is rebuilt around the statement
+ // it plans, so no request plans a plan.
+ {"EXPLAIN SELECT 1", "EXPLAIN SELECT 1"},
+ {"EXPLAIN FORMAT=JSON SELECT 1", "EXPLAIN SELECT 1"},
+ {"EXPLAIN SELECT 1 ORDER BY 1", "EXPLAIN SELECT 1 ORDER BY 1"},
+ // An EXPLAIN with no statement to plan is left as the user wrote it: it
+ // describes a table or another connection's query, and planning a plan
+ // would only turn a working statement into a syntax error.
+ {"EXPLAIN t", "EXPLAIN t"},
+ {"DESCRIBE t", "DESCRIBE t"},
+ {"EXPLAIN FOR CONNECTION 5", "EXPLAIN FOR CONNECTION 5"},
+ }
+ for _, tc := range tests {
+ got, err := explainStatement(tc.statement, base.ExplainFormatDefault)
+ require.NoErrorf(t, err, "%q", tc.statement)
+ require.Equalf(t, tc.want, got, "%q", tc.statement)
+ }
+}
+
+// TestExplainStatementJSON pins the statement that asks for the structured plan
+// the visualizer draws. A caller's own FORMAT is replaced rather than kept, so
+// the request decides the format whatever the statement named.
+func TestExplainStatementJSON(t *testing.T) {
+ tests := []struct {
+ statement string
+ want string
+ }{
+ {"SELECT 1", "EXPLAIN FORMAT=JSON SELECT 1"},
+ {"EXPLAIN SELECT 1", "EXPLAIN FORMAT=JSON SELECT 1"},
+ {"EXPLAIN FORMAT=TREE SELECT 1", "EXPLAIN FORMAT=JSON SELECT 1"},
+ {"EXPLAIN FORMAT=JSON SELECT 1", "EXPLAIN FORMAT=JSON SELECT 1"},
+ // Nothing to plan, so the statement runs as written and the format the
+ // request named has nowhere to go.
+ {"EXPLAIN t", "EXPLAIN t"},
+ }
+ for _, tc := range tests {
+ got, err := explainStatement(tc.statement, base.ExplainFormatJSON)
+ require.NoErrorf(t, err, "%q", tc.statement)
+ require.Equalf(t, tc.want, got, "%q", tc.statement)
+ }
+ // Only JSON has a reader; the rest fall back to the engine's own plan.
+ for _, format := range []base.ExplainFormat{base.ExplainFormatText, base.ExplainFormatXML, base.ExplainFormatYAML} {
+ got, err := explainStatement("SELECT 1", format)
+ require.NoError(t, err)
+ require.Equal(t, "EXPLAIN SELECT 1", got)
+ }
+}
+
+// TestDescribeExplain pins what a result says about a plan the caller asked for
+// itself. An omitted FORMAT is unknown rather than text, because from MySQL
+// 8.0.32 it follows the session's explain_format.
+func TestDescribeExplain(t *testing.T) {
+ tests := []struct {
+ statement string
+ format string
+ executed bool
+ isExplain bool
+ }{
+ {statement: "EXPLAIN FORMAT=JSON SELECT 1", format: "json", isExplain: true},
+ {statement: "explain format = json select 1", format: "json", isExplain: true},
+ {statement: "EXPLAIN FORMAT=TREE SELECT 1", format: "text", isExplain: true},
+ {statement: "EXPLAIN FORMAT=TRADITIONAL SELECT 1", format: "text", isExplain: true},
+ {statement: "EXPLAIN SELECT 1", isExplain: true},
+ {statement: "EXPLAIN ANALYZE SELECT 1", executed: true, isExplain: true},
+ {statement: "SELECT 1"},
+ {statement: "SELECT 1; SELECT 2"},
+ // EXPLAIN over a table name describes its columns. The result is a
+ // table like any other, and calling it a query plan would put it in
+ // the viewer instead of the grid.
+ {statement: "EXPLAIN t"},
+ {statement: "DESCRIBE t"},
+ {statement: "EXPLAIN FOR CONNECTION 5"},
+ }
+ for _, tc := range tests {
+ format, executed, isExplain := DescribeExplain(tc.statement)
+ require.Equalf(t, tc.isExplain, isExplain, "%q", tc.statement)
+ require.Equalf(t, tc.format, format, "%q", tc.statement)
+ require.Equalf(t, tc.executed, executed, "%q", tc.statement)
+ }
+}
+
+// TestExplainStatementRejects locks what never becomes an EXPLAIN: a write with
+// EXPLAIN options smuggled in front of it, which anything that simply prefixed
+// EXPLAIN would turn into an EXPLAIN ANALYZE DELETE that runs the DELETE, and an
+// EXPLAIN ANALYZE the caller wrote, which plans by executing what it plans.
+func TestExplainStatementRejects(t *testing.T) {
+ for _, statement := range []string{
+ "ANALYZE DELETE FROM t",
+ "EXPLAIN ANALYZE SELECT * FROM t",
+ "EXPLAIN ANALYZE DELETE FROM t",
+ "FORMAT=JSON SELECT 1",
+ "SELECT 1; SELECT 2",
+ "",
+ } {
+ _, err := explainStatement(statement, base.ExplainFormatDefault)
+ require.Errorf(t, err, "%q", statement)
+ }
+}
+
+// TestExplainStatementExecutableComment keeps the rebuild off text whose locations
+// the lexer reports against a spliced buffer. The statement runs as written, which
+// still never plans a plan.
+func TestExplainStatementExecutableComment(t *testing.T) {
+ const statement = "EXPLAIN /*!40001 SELECT 1 */"
+ got, err := explainStatement(statement, base.ExplainFormatDefault)
+ require.NoError(t, err)
+ require.Equal(t, statement, got)
+}
diff --git a/backend/plugin/parser/oceanbase/limit.go b/backend/plugin/parser/oceanbase/limit.go
new file mode 100644
index 0000000000..73d3d56f52
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/limit.go
@@ -0,0 +1,251 @@
+package oceanbase
+
+import (
+ "fmt"
+ "log/slog"
+ "reflect"
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ omniparser "github.com/bytebase/omni/oceanbase/parser"
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/common/log"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterResultLimitFunc(storepb.Engine_OCEANBASE, statementWithResultLimit)
+}
+
+// statementWithResultLimit implements base.ResultLimitFunc for OceanBase. It takes
+// no engineVersion.
+func statementWithResultLimit(statement string, limit int, _ string) string {
+ stmt, err := statementWithResultLimitInline(statement, limit)
+ if err != nil {
+ slog.Error("fail to add limit clause", slog.String("statement", statement), log.BBError(err))
+ // MySQL 5.7 doesn't support WITH clause.
+ return fmt.Sprintf("SELECT * FROM (%s) result LIMIT %d;", base.TrimStatement(statement), limit)
+ }
+ return stmt
+}
+
+func statementWithResultLimitInline(statement string, limitCount int) (string, error) {
+ if strings.TrimSpace(statement) == "" {
+ return "", errors.New("empty statement")
+ }
+
+ list, err := ParseOceanBase(statement)
+ if err != nil {
+ if stmt, procedureErr := rewriteMySQLSelectProcedureLimit(statement, limitCount); procedureErr == nil {
+ return stmt, nil
+ }
+ return "", err
+ }
+ if len(list.Items) != 1 {
+ return "", errors.Errorf("expected exactly one statement, got %d", len(list.Items))
+ }
+
+ stmt, ok := list.Items[0].(*ast.SelectStmt)
+ if !ok {
+ return statement, nil
+ }
+
+ return rewriteMySQLSelectLimit(statement, stmt, limitCount)
+}
+
+func rewriteMySQLSelectProcedureLimit(sql string, limitCount int) (string, error) {
+ statements, err := SplitSQL(sql)
+ if err != nil {
+ return "", err
+ }
+ statementCount := 0
+ for _, statement := range statements {
+ if !statement.Empty {
+ statementCount++
+ }
+ }
+ if statementCount != 1 {
+ return "", errors.Errorf("expected exactly one statement, got %d", statementCount)
+ }
+
+ tokens := omniparser.Tokenize(sql)
+ if len(tokens) == 0 || omniparser.TokenName(tokens[0].Type) != "SELECT" {
+ return "", errors.New("not a SELECT PROCEDURE statement")
+ }
+ for i, token := range tokens[1:] {
+ if omniparser.TokenName(token.Type) == "PROCEDURE" {
+ procedureTokenIndex := i + 1
+ if stmt, ok := rewriteMySQLLimitBeforeProcedure(sql, tokens[:procedureTokenIndex], limitCount); ok {
+ return stmt, nil
+ }
+ return sql[:token.Loc] + fmt.Sprintf("LIMIT %d ", limitCount) + sql[token.Loc:], nil
+ }
+ }
+ return "", errors.New("SELECT PROCEDURE clause not found")
+}
+
+func rewriteMySQLLimitBeforeProcedure(sql string, tokens []omniparser.Token, limitCount int) (string, bool) {
+ depth := 0
+ for i := len(tokens) - 1; i >= 0; i-- {
+ switch tokens[i].Str {
+ case ")":
+ depth++
+ continue
+ case "(":
+ if depth > 0 {
+ depth--
+ }
+ continue
+ default:
+ }
+ if depth > 0 {
+ continue
+ }
+ if omniparser.TokenName(tokens[i].Type) != "LIMIT" {
+ continue
+ }
+ countTokenIndex := i + 1
+ if i+3 < len(tokens) && tokens[i+2].Str == "," {
+ countTokenIndex = i + 3
+ }
+ if countTokenIndex >= len(tokens) {
+ return "", false
+ }
+ if tokens[countTokenIndex].Ival > 0 && int(tokens[countTokenIndex].Ival) <= limitCount {
+ return sql, true
+ }
+ return sql[:tokens[countTokenIndex].Loc] + fmt.Sprintf("%d", limitCount) + sql[tokens[countTokenIndex].End:], true
+ }
+ return "", false
+}
+
+func rewriteMySQLSelectLimit(sql string, stmt *ast.SelectStmt, limitCount int) (string, error) {
+ if stmt.Limit != nil && stmt.Limit.Count != nil {
+ existingLimit := extractMySQLLimit(stmt.Limit.Count)
+ if existingLimit >= 0 && existingLimit <= limitCount {
+ return sql, nil
+ }
+ loc := nodeLocOf(stmt.Limit.Count)
+ loc = trimMySQLLocSpace(sql, loc)
+ if loc.Start >= 0 && loc.End > loc.Start && loc.End <= len(sql) {
+ if existingLimit < 0 && stmt.Into == nil {
+ return "", errors.Errorf("cannot rewrite non-constant LIMIT expression")
+ }
+ return sql[:loc.Start] + fmt.Sprintf("%d", limitCount) + sql[loc.End:], nil
+ }
+ return "", errors.Errorf("cannot rewrite non-constant LIMIT expression")
+ }
+
+ insertPos, beforeClause := findMySQLLimitInsertPosition(sql, stmt)
+ if insertPos < 0 || insertPos > len(sql) {
+ return "", errors.Errorf("invalid LIMIT insert position %d", insertPos)
+ }
+ if beforeClause {
+ return sql[:insertPos] + fmt.Sprintf("LIMIT %d ", limitCount) + sql[insertPos:], nil
+ }
+ return sql[:insertPos] + fmt.Sprintf(" LIMIT %d", limitCount) + sql[insertPos:], nil
+}
+
+func findMySQLLimitInsertPosition(sql string, stmt *ast.SelectStmt) (int, bool) {
+ if stmt.Into != nil && stmt.Into.Loc.Start > 0 {
+ intoStart := findMySQLKeywordBefore(sql, stmt.Into.Loc.Start, "INTO")
+ if intoStart >= maxMySQLLocEndBeforeTailClauses(stmt) {
+ return intoStart, true
+ }
+ }
+ if stmt.ForUpdate != nil && stmt.ForUpdate.Loc.Start > 0 {
+ return stmt.ForUpdate.Loc.Start, true
+ }
+ if stmt.Loc.End > 0 {
+ return stmt.Loc.End, false
+ }
+ return -1, false
+}
+
+func extractMySQLLimit(node ast.Node) int {
+ limit, ok := node.(*ast.IntLit)
+ if !ok {
+ return -1
+ }
+ return int(limit.Value)
+}
+
+func nodeLocOf(node ast.Node) ast.Loc {
+ return mysqlNodeLoc(node)
+}
+
+func trimMySQLLocSpace(sql string, loc ast.Loc) ast.Loc {
+ for loc.Start < loc.End && loc.Start < len(sql) && (sql[loc.Start] == ' ' || sql[loc.Start] == '\t' || sql[loc.Start] == '\n' || sql[loc.Start] == '\r') {
+ loc.Start++
+ }
+ for loc.End > loc.Start && loc.End <= len(sql) && (sql[loc.End-1] == ' ' || sql[loc.End-1] == '\t' || sql[loc.End-1] == '\n' || sql[loc.End-1] == '\r') {
+ loc.End--
+ }
+ return loc
+}
+
+func maxMySQLLocEndBeforeTailClauses(node ast.Node) int {
+ maxEnd := -1
+ ast.Inspect(node, func(n ast.Node) bool {
+ if n == nil {
+ return false
+ }
+ if n == node {
+ return true
+ }
+ if _, ok := n.(*ast.IntoClause); ok {
+ return false
+ }
+ if _, ok := n.(*ast.ForUpdate); ok {
+ return false
+ }
+ if loc := mysqlNodeLoc(n); loc.End > maxEnd {
+ maxEnd = loc.End
+ }
+ return true
+ })
+ return maxEnd
+}
+
+func mysqlNodeLoc(node ast.Node) ast.Loc {
+ if node == nil {
+ return ast.Loc{Start: -1, End: -1}
+ }
+ value := reflect.ValueOf(node)
+ if value.Kind() != reflect.Pointer || value.IsNil() {
+ return ast.Loc{Start: -1, End: -1}
+ }
+ elem := value.Elem()
+ if elem.Kind() != reflect.Struct {
+ return ast.Loc{Start: -1, End: -1}
+ }
+ field := elem.FieldByName("Loc")
+ if !field.IsValid() || !field.CanInterface() {
+ return ast.Loc{Start: -1, End: -1}
+ }
+ loc, ok := field.Interface().(ast.Loc)
+ if !ok {
+ return ast.Loc{Start: -1, End: -1}
+ }
+ return loc
+}
+
+func findMySQLKeywordBefore(sql string, offset int, keyword string) int {
+ if offset > len(sql) {
+ offset = len(sql)
+ }
+ if len(keyword) == 0 {
+ return offset
+ }
+ keyword = strings.ToUpper(keyword)
+ tokens := omniparser.Tokenize(sql[:offset])
+ for i := len(tokens) - 1; i >= 0; i-- {
+ token := tokens[i]
+ if token.End <= offset && omniparser.TokenName(token.Type) == keyword {
+ return token.Loc
+ }
+ }
+ return offset
+}
diff --git a/backend/plugin/parser/oceanbase/limit_test.go b/backend/plugin/parser/oceanbase/limit_test.go
new file mode 100644
index 0000000000..155bd7a532
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/limit_test.go
@@ -0,0 +1,296 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+)
+
+func TestGetStatementWithResultLimit(t *testing.T) {
+ testCases := []struct {
+ stmt string
+ count int
+ want string
+ }{
+ {
+ stmt: "SELECT * FROM t LIMIT 0,20;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 0,10;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 123,20;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 123,10;",
+ },
+ {
+ stmt: "SELECT * FROM t;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 10;",
+ count: 5,
+ want: "SELECT * FROM t LIMIT 5;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 5;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 5;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 0;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 0;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 123;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT 10 OFFSET 123;",
+ count: 5,
+ want: "SELECT * FROM t LIMIT 5 OFFSET 123;",
+ },
+ {
+ stmt: "SELECT * FROM t2 JOIN t1 ON t2.c2 = t1.c2 where t2.c2 > 10;",
+ count: 10,
+ want: "SELECT * FROM t2 JOIN t1 ON t2.c2 = t1.c2 where t2.c2 > 10 LIMIT 10;",
+ },
+ {
+ stmt: "SELECT * FROM t1 ORDER BY c2;",
+ count: 10,
+ want: "SELECT * FROM t1 ORDER BY c2 LIMIT 10;",
+ },
+ {
+ stmt: "SELECT COUNT(col1) AS col2 FROM t GROUP BY col2 HAVING col2 = 2;",
+ count: 10,
+ want: "SELECT COUNT(col1) AS col2 FROM t GROUP BY col2 HAVING col2 = 2 LIMIT 10;",
+ },
+ {
+ stmt: "SELECT firstName, lastName FROM employees UNION SELECT contactFirstName, contactLastName FROM customers;",
+ count: 10,
+ want: "SELECT firstName, lastName FROM employees UNION SELECT contactFirstName, contactLastName FROM customers LIMIT 10;",
+ },
+ {
+ stmt: "(SELECT * FROM t LIMIT 100) LIMIT 20;",
+ count: 10,
+ want: "(SELECT * FROM t LIMIT 100) LIMIT 10;",
+ },
+ {
+ stmt: "(SELECT * FROM t) FOR UPDATE;",
+ count: 10,
+ want: "(SELECT * FROM t) LIMIT 10 FOR UPDATE;",
+ }, {
+ stmt: "SELECT customerNumber, checkNumber, amount FROM payments WHERE amount = (SELECT MAX(amount) FROM payments);",
+ count: 10,
+ want: "SELECT customerNumber, checkNumber, amount FROM payments WHERE amount = (SELECT MAX(amount) FROM payments) LIMIT 10;",
+ }, {
+ stmt: "SELECT firstName, lastName FROM employees UNION SELECT contactFirstName, contactLastName FROM customers LIMIT 10;",
+ count: 10,
+ want: "SELECT firstName, lastName FROM employees UNION SELECT contactFirstName, contactLastName FROM customers LIMIT 10;",
+ }, {
+ stmt: "WITH RECURSIVE cte_count (n) AS ( SELECT 1 UNION ALL SELECT n + 1 FROM cte_count WHERE n < 3 ) SELECT n FROM cte_count;",
+ count: 10,
+ want: "WITH RECURSIVE cte_count (n) AS ( SELECT 1 UNION ALL SELECT n + 1 FROM cte_count WHERE n < 3 ) SELECT n FROM cte_count LIMIT 10;",
+ },
+ // EXCEPT need mysql >= 8.0.31
+ // {
+ // stmt: "SELECT firstName FROM employees EXCEPT SELECT contactFirstName FROM customers;",
+ // count: 20,
+ // want: "SELECT firstName FROM employees EXCEPT SELECT contactFirstName FROM customers LIMIT 10;",
+ // },
+ {
+ stmt: "SELECT col1, col2 FROM table1 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 20 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 5 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 5 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 0 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT row_count PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT row_count OFFSET 100 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 10 OFFSET 100 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 100,20 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 100,10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 100,5 PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 100,5 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 LIMIT 100,row_count PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 LIMIT 100,10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT * FROM (SELECT * FROM t LIMIT 100) s JOIN u PROCEDURE ANALYSE(10, 2000);",
+ count: 10,
+ want: "SELECT * FROM (SELECT * FROM t LIMIT 100) s JOIN u LIMIT 10 PROCEDURE ANALYSE(10, 2000);",
+ },
+ {
+ stmt: "SELECT col1, col2 FROM table1 ORDER BY col1;",
+ count: 10,
+ want: "SELECT col1, col2 FROM table1 ORDER BY col1 LIMIT 10;",
+ },
+ {
+ stmt: "SELECT * FROM t FOR UPDATE;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 FOR UPDATE;",
+ },
+ {
+ stmt: "SELECT * FROM t LOCK IN SHARE MODE;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 LOCK IN SHARE MODE;",
+ },
+ {
+ stmt: "SELECT * FROM t INTO OUTFILE '/tmp/a';",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 INTO OUTFILE '/tmp/a';",
+ },
+ {
+ stmt: "SELECT * FROM t /* into */ INTO OUTFILE '/tmp/a';",
+ count: 10,
+ want: "SELECT * FROM t /* into */ LIMIT 10 INTO OUTFILE '/tmp/a';",
+ },
+ {
+ stmt: "SELECT * FROM t INTO /* into */ OUTFILE '/tmp/a';",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 INTO /* into */ OUTFILE '/tmp/a';",
+ },
+ {
+ stmt: "SELECT c INTO @v FROM t LIMIT row_count;",
+ count: 10,
+ want: "SELECT c INTO @v FROM t LIMIT 10;",
+ },
+ {
+ stmt: "SELECT c FROM t INTO @v FOR UPDATE;",
+ count: 10,
+ want: "SELECT c FROM t LIMIT 10 INTO @v FOR UPDATE;",
+ },
+ {
+ stmt: "SELECT * INTO OUTFILE '/tmp/a' FROM t;",
+ count: 10,
+ want: "SELECT * INTO OUTFILE '/tmp/a' FROM t LIMIT 10;",
+ },
+ {
+ stmt: "SELECT * FROM t -- note",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 -- note",
+ },
+ {
+ stmt: "SELECT * FROM t /* block comment */;",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 /* block comment */;",
+ },
+ {
+ stmt: "SELECT * FROM t # mysql comment",
+ count: 10,
+ want: "SELECT * FROM t LIMIT 10 # mysql comment",
+ },
+ }
+
+ for _, tc := range testCases {
+ got := statementWithResultLimit(tc.stmt, tc.count, "")
+ require.Equal(t, tc.want, got, tc.stmt)
+ }
+}
+
+func TestGetStatementWithResultLimitFallback(t *testing.T) {
+ testCases := []struct {
+ stmt string
+ count int
+ want string
+ }{
+ {
+ stmt: "SELECT * FROM t LIMIT 1 + 2",
+ count: 5,
+ want: "SELECT * FROM (SELECT * FROM t LIMIT 1 + 2) result LIMIT 5;",
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT @row_count",
+ count: 5,
+ want: "SELECT * FROM (SELECT * FROM t LIMIT @row_count) result LIMIT 5;",
+ },
+ }
+
+ for _, tc := range testCases {
+ got := statementWithResultLimit(tc.stmt, tc.count, "")
+ require.Equal(t, tc.want, got, tc.stmt)
+ }
+}
+
+func TestGetStatementWithResultLimitInline(t *testing.T) {
+ testCases := []struct {
+ stmt string
+ count int
+ wantErr bool
+ want string
+ }{
+ {
+ stmt: "SELECT * FROM t LIMIT 1 + 2",
+ count: 5,
+ wantErr: true,
+ },
+ {
+ stmt: "SELECT * FROM t LIMIT @row_count",
+ count: 5,
+ wantErr: true,
+ },
+ {
+ stmt: "SELECT * FROM a; SELECT * FROM b;",
+ count: 5,
+ wantErr: true,
+ },
+ {
+ stmt: "SELECT col1 FROM table1 PROCEDURE ANALYSE(10, 2000); SELECT * FROM b;",
+ count: 5,
+ wantErr: true,
+ },
+ {
+ stmt: "UPDATE t SET a = 1",
+ count: 5,
+ want: "UPDATE t SET a = 1",
+ },
+ }
+
+ for _, tc := range testCases {
+ got, err := statementWithResultLimitInline(tc.stmt, tc.count)
+ if tc.wantErr {
+ require.Error(t, err, tc.stmt)
+ continue
+ }
+ require.NoError(t, err, tc.stmt)
+ require.Equal(t, tc.want, got, tc.stmt)
+ }
+}
+
+func TestGetStatementWithResultLimitUnicodeBeforeInto(t *testing.T) {
+ stmt := "SELECT 'ı' FROM t INTO OUTFILE '/tmp/a';"
+ want := "SELECT 'ı' FROM t LIMIT 10 INTO OUTFILE '/tmp/a';"
+
+ got := statementWithResultLimit(stmt, 10, "")
+ require.Equal(t, want, got)
+}
diff --git a/backend/plugin/parser/oceanbase/oceanbase.go b/backend/plugin/parser/oceanbase/oceanbase.go
new file mode 100644
index 0000000000..87f69196cc
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/oceanbase.go
@@ -0,0 +1,85 @@
+// Package oceanbase parses OceanBase's MySQL mode. OceanBase accepts distributed DDL
+// MySQL rejects, so it carries its own omni parser and AST rather than MySQL's.
+package oceanbase
+
+import (
+ "errors"
+ "fmt"
+
+ omniparser "github.com/bytebase/omni/oceanbase/parser"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterParseStatementsFunc(storepb.Engine_OCEANBASE, parseStatements)
+ base.RegisterGetStatementTypes(storepb.Engine_OCEANBASE, GetStatementTypes)
+}
+
+// parseStatements is the ParseStatementsFunc for OceanBase. Each returned statement
+// carries both its text and its AST.
+func parseStatements(statement string) ([]base.ParsedStatement, error) {
+ stmts, err := SplitSQL(statement)
+ if err != nil {
+ return nil, err
+ }
+
+ var result []base.ParsedStatement
+ for _, stmt := range stmts {
+ if stmt.Empty {
+ continue
+ }
+
+ list, omniErr := ParseOceanBase(stmt.Text)
+ if omniErr != nil {
+ return nil, convertOmniError(omniErr, stmt)
+ }
+ if list == nil || len(list.Items) == 0 {
+ continue
+ }
+
+ for _, node := range list.Items {
+ result = append(result, base.ParsedStatement{
+ Statement: stmt,
+ AST: &OmniAST{
+ Node: node,
+ Text: stmt.Text,
+ StartPosition: stmt.Start,
+ },
+ })
+ }
+ }
+
+ return result, nil
+}
+
+// convertOmniError converts an omni parser error to a base.SyntaxError with proper line:column position.
+func convertOmniError(err error, stmt base.Statement) error {
+ var parseErr *omniparser.ParseError
+ if !errors.As(err, &parseErr) {
+ return err
+ }
+ message, position, relatedText := parseErr.Message, parseErr.Position, parseErr.RelatedText
+
+ pos := ByteOffsetToRunePosition(stmt.Text, position)
+
+ // Offset by the statement's 1-based start; its column applies only to the statement's first line.
+ if stmt.Start != nil {
+ if pos.Line == 1 {
+ pos.Column += stmt.Start.Column - 1
+ }
+ pos.Line += stmt.Start.Line - 1
+ }
+
+ msg := fmt.Sprintf("Syntax error at line %d:%d: %s", pos.Line, pos.Column, message)
+ if relatedText != "" {
+ msg += "\nrelated text: " + relatedText
+ }
+
+ return &base.SyntaxError{
+ Position: pos,
+ Message: msg,
+ RawMessage: message,
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/oceanbase_test.go b/backend/plugin/parser/oceanbase/oceanbase_test.go
new file mode 100644
index 0000000000..7df95fcae0
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/oceanbase_test.go
@@ -0,0 +1,57 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestParseStatements(t *testing.T) {
+ statement := "SELECT 1; SELECT 2;"
+
+ statements, err := base.ParseStatements(storepb.Engine_OCEANBASE, statement)
+ require.NoError(t, err)
+
+ require.Len(t, statements, 2)
+
+ // Check first statement
+ require.Equal(t, "SELECT 1;", statements[0].Text)
+ require.False(t, statements[0].Empty)
+ require.NotNil(t, statements[0].AST)
+ require.NotNil(t, statements[0].Start)
+
+ // Check second statement
+ require.Contains(t, statements[1].Text, "SELECT 2")
+ require.False(t, statements[1].Empty)
+ require.NotNil(t, statements[1].AST)
+}
+
+func TestParseStatementsSyntaxErrorColumnOnSharedLine(t *testing.T) {
+ for _, tc := range []struct {
+ engine storepb.Engine
+ statement string
+ want *storepb.Position
+ }{
+ // The error is at the ')' after DEFAULT, column 51 of the line.
+ {storepb.Engine_OCEANBASE, "SELECT 1; CREATE TABLE t (a INT DEFAULT);", &storepb.Position{Line: 1, Column: 40}},
+ {storepb.Engine_OCEANBASE, "SELECT 1;\nSELECT 2; CREATE TABLE t (a INT DEFAULT);", &storepb.Position{Line: 2, Column: 40}},
+ } {
+ _, err := base.ParseStatements(tc.engine, tc.statement)
+
+ var syntaxErr *base.SyntaxError
+ require.ErrorAs(t, err, &syntaxErr, tc.statement)
+ require.Equal(t, tc.want, syntaxErr.Position, tc.statement)
+ }
+}
+
+func TestParseStatementsRejectsMariaDBSyntax(t *testing.T) {
+ for _, engine := range []storepb.Engine{storepb.Engine_OCEANBASE} {
+ _, err := base.ParseStatements(engine, "CREATE OR REPLACE TABLE t (a INT);")
+
+ var syntaxErr *base.SyntaxError
+ require.ErrorAs(t, err, &syntaxErr, engine.String())
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/omni.go b/backend/plugin/parser/oceanbase/omni.go
new file mode 100644
index 0000000000..7c1fffe578
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/omni.go
@@ -0,0 +1,84 @@
+package oceanbase
+
+import (
+ "unicode/utf8"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ omniparser "github.com/bytebase/omni/oceanbase/parser"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+// OmniAST wraps an omni AST node and implements the base.AST interface.
+type OmniAST struct {
+ // Node is the omni AST node (e.g. *ast.SelectStmt, *ast.CreateTableStmt).
+ Node ast.Node
+ // Text is the original SQL text of this statement.
+ Text string
+ // StartPosition is the 1-based position where this statement starts.
+ StartPosition *storepb.Position
+}
+
+// ASTSource returns the statement's own text. Consumers shared with MySQL, such as
+// backend/plugin/schema/mysql's walk-through, read it to re-derive a MySQL AST node
+// for an OceanBase statement.
+func (a *OmniAST) ASTSource() string {
+ return a.Text
+}
+
+// ASTStartPosition implements base.AST.
+func (a *OmniAST) ASTStartPosition() *storepb.Position {
+ return a.StartPosition
+}
+
+// ParseOceanBase parses SQL using omni's parser and returns an ast.List.
+// This is the recommended entry point for new code that needs omni AST nodes.
+func ParseOceanBase(sql string) (*ast.List, error) {
+ return omniparser.Parse(sql)
+}
+
+// IsKeyword reports whether s is a registered MySQL keyword.
+func IsKeyword(s string) bool {
+ return omniparser.IsKeyword(s)
+}
+
+// GetOmniNode extracts the omni AST node from a base.AST interface.
+// Returns the node and true if it is an OmniAST, nil and false otherwise.
+func GetOmniNode(a base.AST) (ast.Node, bool) {
+ if a == nil {
+ return nil, false
+ }
+ omniAST, ok := a.(*OmniAST)
+ if !ok {
+ return nil, false
+ }
+ return omniAST.Node, true
+}
+
+// ByteOffsetToRunePosition converts a byte offset in sql to a 1-based line:column
+// where column is measured in Unicode code points (runes), matching storepb.Position semantics.
+func ByteOffsetToRunePosition(sql string, byteOffset int) *storepb.Position {
+ if byteOffset > len(sql) {
+ byteOffset = len(sql)
+ }
+
+ line := int32(1)
+ runeCol := int32(0) // 0-based rune count on current line
+ i := 0
+ for i < byteOffset {
+ r, size := utf8.DecodeRuneInString(sql[i:])
+ if r == '\n' {
+ line++
+ runeCol = 0
+ } else {
+ runeCol++
+ }
+ i += size
+ }
+
+ return &storepb.Position{
+ Line: line,
+ Column: runeCol + 1, // convert to 1-based
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/query.go b/backend/plugin/parser/oceanbase/query.go
new file mode 100644
index 0000000000..cd272c7d76
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query.go
@@ -0,0 +1,78 @@
+package oceanbase
+
+import (
+ "github.com/bytebase/omni/oceanbase/ast"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterQueryValidator(storepb.Engine_OCEANBASE, validateQuery)
+}
+
+// validateQuery validates the SQL statement for SQL editor.
+// Only SELECT, EXPLAIN, SHOW, SET, and DESCRIBE are allowed in read-only mode.
+// EXPLAIN ANALYZE is treated as non-read-only since it actually executes the query.
+func validateQuery(statement string) (bool, bool, error) {
+ stmts, err := ParseOceanBase(statement)
+ if err != nil {
+ return false, false, convertOmniError(err, base.Statement{Text: statement})
+ }
+
+ hasExecute := false
+ readOnly := true
+ for _, node := range stmts.Items {
+ switch stmt := node.(type) {
+ case *ast.SelectStmt:
+ // INTO OUTFILE and INTO DUMPFILE write a file on the server, so
+ // they are writes (pg refuses its own SELECT ... INTO likewise).
+ // INTO <variable> returns no rows: the SET case, not a write.
+ writesFile, assignsVariables := selectIntoTargets(stmt)
+ if writesFile {
+ return false, false, nil
+ }
+ if assignsVariables {
+ hasExecute = true
+ }
+ case *ast.ExplainStmt:
+ if stmt.Analyze {
+ readOnly = false
+ }
+ case *ast.ShowStmt:
+ // SHOW is always allowed.
+ case *ast.SetStmt, *ast.SetPasswordStmt, *ast.SetDefaultRoleStmt, *ast.SetRoleStmt, *ast.SetResourceGroupStmt, *ast.SetTransactionStmt:
+ hasExecute = true
+ default:
+ return false, false, nil
+ }
+ }
+ return readOnly, !hasExecute, nil
+}
+
+// selectIntoTargets reports what a SELECT's INTO clause targets. It searches
+// the whole statement rather than its root because the parser attaches INTO to
+// an arm of a set operation or to a parenthesized query, not necessarily to the
+// node the caller holds — the same reason pg's omniIntoClause walks its arms.
+//
+// A subquery cannot carry INTO in MySQL, so reaching into the tree cannot
+// over-match a legal statement; if the grammar ever allowed it, the answer here
+// would be conservative rather than permissive.
+func selectIntoTargets(n *ast.SelectStmt) (writesFile, assignsVariables bool) {
+ ast.Inspect(n, func(node ast.Node) bool {
+ sel, ok := node.(*ast.SelectStmt)
+ if !ok || sel.Into == nil {
+ return true
+ }
+ // The clause form decides, not the filename it carries: those fields
+ // hold the decoded path, so "INTO OUTFILE ''" leaves both empty while
+ // still being a file write.
+ if len(sel.Into.Vars) > 0 {
+ assignsVariables = true
+ } else {
+ writesFile = true
+ }
+ return true
+ })
+ return writesFile, assignsVariables
+}
diff --git a/backend/plugin/parser/oceanbase/query_span.go b/backend/plugin/parser/oceanbase/query_span.go
new file mode 100644
index 0000000000..e6872122ed
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span.go
@@ -0,0 +1,28 @@
+package oceanbase
+
+import (
+ "context"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterGetQuerySpan(storepb.Engine_OCEANBASE, GetQuerySpan)
+}
+
+// GetQuerySpan returns the query span for the given statement.
+func GetQuerySpan(
+ ctx context.Context,
+ gCtx base.GetQuerySpanContext,
+ stmt base.Statement,
+ database, _ string,
+ ignoreCaseSensitive bool,
+) (*base.QuerySpan, error) {
+ q := newQuerySpanExtractor(database, gCtx, ignoreCaseSensitive)
+ querySpan, err := q.getQuerySpan(ctx, stmt.Text)
+ if err != nil {
+ return nil, convertOmniError(err, stmt)
+ }
+ return querySpan, nil
+}
diff --git a/backend/plugin/parser/oceanbase/query_span_extractor.go b/backend/plugin/parser/oceanbase/query_span_extractor.go
new file mode 100644
index 0000000000..828c777770
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span_extractor.go
@@ -0,0 +1,1808 @@
+package oceanbase
+
+import (
+ "context"
+ "strconv"
+ "strings"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+type querySpanExtractor struct {
+ ctx context.Context
+ defaultDatabase string
+
+ gCtx base.GetQuerySpanContext
+
+ ignoreCaseSensitive bool
+
+ // ctes records common table expressions visible to the current select scope.
+ ctes []*base.PseudoTable
+
+ // outerTableSources resolves correlated subquery column references.
+ outerTableSources []base.TableSource
+
+ // tableSourceFrom is the set of table sources visible from the current FROM clause.
+ tableSourceFrom []base.TableSource
+
+ // priorTableInFrom resolves JSON_TABLE document expressions against preceding FROM items.
+ priorTableInFrom []base.TableSource
+
+ viewResolutionStack map[string]bool
+}
+
+func newQuerySpanExtractor(defaultDatabase string, gCtx base.GetQuerySpanContext, ignoreCaseSensitive bool) *querySpanExtractor {
+ return &querySpanExtractor{
+ defaultDatabase: defaultDatabase,
+ gCtx: gCtx,
+ ignoreCaseSensitive: ignoreCaseSensitive,
+ }
+}
+
+func (q *querySpanExtractor) getQuerySpan(ctx context.Context, stmt string) (*base.QuerySpan, error) {
+ return (&omniQuerySpanExtractor{querySpanExtractor: q}).getOmniQuerySpan(ctx, stmt)
+}
+
+type joinType int
+
+const (
+ Join joinType = iota
+ InnerJoin
+ CrossJoin
+ StraightJoin
+ LeftOuterJoin
+ RightOuterJoin
+ NaturalInnerJoin
+ NaturalLeftOuterJoin
+ NaturalRightOuterJoin
+)
+
+func joinTableSources(l, r base.TableSource, tp joinType, using []string) base.TableSource {
+ switch tp {
+ case Join, InnerJoin, CrossJoin, StraightJoin, LeftOuterJoin, RightOuterJoin:
+ var columns []base.QuerySpanResult
+ rightFieldsMap := make(map[string]bool)
+ for _, field := range r.GetQuerySpanResult() {
+ rightFieldsMap[strings.ToLower(field.Name)] = true
+ }
+ lowercaseUsingFields := make(map[string]bool)
+ for _, field := range using {
+ lowercaseUsingFields[strings.ToLower(field)] = true
+ }
+ for _, field := range l.GetQuerySpanResult() {
+ columns = append(columns, field)
+ if _, ok := lowercaseUsingFields[strings.ToLower(field.Name)]; ok {
+ delete(rightFieldsMap, strings.ToLower(field.Name))
+ }
+ }
+ for _, field := range r.GetQuerySpanResult() {
+ if _, ok := rightFieldsMap[strings.ToLower(field.Name)]; ok {
+ columns = append(columns, field)
+ }
+ }
+ return &base.PseudoTable{
+ Columns: columns,
+ }
+ case NaturalInnerJoin, NaturalLeftOuterJoin, NaturalRightOuterJoin:
+ rightFieldsMap := make(map[string]bool)
+ for _, field := range r.GetQuerySpanResult() {
+ rightFieldsMap[strings.ToLower(field.Name)] = true
+ }
+ var columns []base.QuerySpanResult
+ for _, field := range l.GetQuerySpanResult() {
+ columns = append(columns, field)
+ delete(rightFieldsMap, strings.ToLower(field.Name))
+ }
+ for _, field := range r.GetQuerySpanResult() {
+ if _, ok := rightFieldsMap[strings.ToLower(field.Name)]; ok {
+ columns = append(columns, field)
+ }
+ }
+ return &base.PseudoTable{
+ Columns: columns,
+ }
+ default:
+ return nil
+ }
+}
+
+func (q *querySpanExtractor) getAllTableColumnSources(databaseName, tableName string) ([]base.QuerySpanResult, bool) {
+ findInTableSource := func(tableSource base.TableSource) ([]base.QuerySpanResult, bool) {
+ if q.ignoreCaseSensitive {
+ if databaseName != "" && !strings.EqualFold(databaseName, tableSource.GetDatabaseName()) {
+ return nil, false
+ }
+ if tableName != "" && !strings.EqualFold(tableName, tableSource.GetTableName()) {
+ return nil, false
+ }
+ } else {
+ if databaseName != "" && databaseName != tableSource.GetDatabaseName() {
+ return nil, false
+ }
+ if tableName != "" && tableName != tableSource.GetTableName() {
+ return nil, false
+ }
+ }
+ return tableSource.GetQuerySpanResult(), true
+ }
+
+ for i := len(q.outerTableSources) - 1; i >= 0; i-- {
+ if querySpanResult, ok := findInTableSource(q.outerTableSources[i]); ok {
+ return querySpanResult, true
+ }
+ }
+ for i := len(q.tableSourceFrom) - 1; i >= 0; i-- {
+ if querySpanResult, ok := findInTableSource(q.tableSourceFrom[i]); ok {
+ return querySpanResult, true
+ }
+ }
+ return nil, false
+}
+
+func (q *querySpanExtractor) getFieldColumnSource(databaseName, tableName, fieldName string) (base.SourceColumnSet, error) {
+ findInTableSource := func(tableSource base.TableSource) (base.SourceColumnSet, bool) {
+ if q.ignoreCaseSensitive {
+ if databaseName != "" && !strings.EqualFold(databaseName, tableSource.GetDatabaseName()) {
+ return nil, false
+ }
+ if tableName != "" && !strings.EqualFold(tableName, tableSource.GetTableName()) {
+ return nil, false
+ }
+ } else {
+ if databaseName != "" && databaseName != tableSource.GetDatabaseName() {
+ return nil, false
+ }
+ if tableName != "" && tableName != tableSource.GetTableName() {
+ return nil, false
+ }
+ }
+ for _, column := range tableSource.GetQuerySpanResult() {
+ if strings.EqualFold(column.Name, fieldName) {
+ return column.SourceColumns, true
+ }
+ }
+ return nil, false
+ }
+
+ for i := len(q.outerTableSources) - 1; i >= 0; i-- {
+ if sourceColumnSet, ok := findInTableSource(q.outerTableSources[i]); ok {
+ return sourceColumnSet, nil
+ }
+ }
+ for i := len(q.tableSourceFrom) - 1; i >= 0; i-- {
+ if sourceColumnSet, ok := findInTableSource(q.tableSourceFrom[i]); ok {
+ return sourceColumnSet, nil
+ }
+ }
+ for i := len(q.priorTableInFrom) - 1; i >= 0; i-- {
+ if sourceColumnSet, ok := findInTableSource(q.priorTableInFrom[i]); ok {
+ return sourceColumnSet, nil
+ }
+ }
+
+ return nil, &base.ResourceNotFoundError{
+ Database: &databaseName,
+ Table: &tableName,
+ Column: &fieldName,
+ }
+}
+
+func (q *querySpanExtractor) findTableSchema(databaseName, tableName string) (base.TableSource, error) {
+ if databaseName == "" {
+ for i := len(q.ctes) - 1; i >= 0; i-- {
+ table := q.ctes[i]
+ if table.Name == tableName {
+ return table, nil
+ }
+ }
+ }
+
+ if databaseName == "" {
+ databaseName = q.defaultDatabase
+ }
+
+ var dbMetadata *model.DatabaseMetadata
+ allDatabaseNames, err := q.gCtx.ListDatabaseNamesFunc(q.ctx, q.gCtx.InstanceID)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to list databases")
+ }
+ if q.ignoreCaseSensitive {
+ for _, db := range allDatabaseNames {
+ if strings.EqualFold(db, databaseName) {
+ _, dbMetadata, err = q.gCtx.GetDatabaseMetadataFunc(q.ctx, q.gCtx.InstanceID, db)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to get database metadata for database %q", db)
+ }
+ break
+ }
+ }
+ } else {
+ for _, db := range allDatabaseNames {
+ if db == databaseName {
+ _, dbMetadata, err = q.gCtx.GetDatabaseMetadataFunc(q.ctx, q.gCtx.InstanceID, db)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to get database metadata for database %q", db)
+ }
+ break
+ }
+ }
+ }
+ if dbMetadata == nil {
+ return nil, &base.ResourceNotFoundError{
+ Database: &databaseName,
+ }
+ }
+
+ emptySchema := ""
+ schema := dbMetadata.GetSchemaMetadata(emptySchema)
+ if schema == nil {
+ return nil, &base.ResourceNotFoundError{
+ Database: &databaseName,
+ Schema: &emptySchema,
+ }
+ }
+
+ var tableSchema *model.TableMetadata
+ if q.ignoreCaseSensitive {
+ for _, table := range schema.ListTableNames() {
+ if strings.EqualFold(table, tableName) {
+ tableSchema = schema.GetTable(table)
+ break
+ }
+ }
+ } else {
+ tableSchema = schema.GetTable(tableName)
+ }
+ if tableSchema != nil {
+ columnNames := make([]string, 0, len(tableSchema.GetProto().GetColumns()))
+ for _, column := range tableSchema.GetProto().GetColumns() {
+ columnNames = append(columnNames, column.Name)
+ }
+ return &base.PhysicalTable{
+ Name: tableSchema.GetProto().Name,
+ Schema: emptySchema,
+ Database: dbMetadata.GetProto().GetName(),
+ Server: "",
+ Columns: columnNames,
+ }, nil
+ }
+
+ var viewSchema *metadatapb.ViewMetadata
+ if q.ignoreCaseSensitive {
+ for _, view := range schema.ListViewNames() {
+ if strings.EqualFold(view, tableName) {
+ viewSchema = schema.GetView(view)
+ break
+ }
+ }
+ } else {
+ viewSchema = schema.GetView(tableName)
+ }
+ if viewSchema != nil {
+ columns, err := q.getColumnsForView(dbMetadata.GetProto().GetName(), viewSchema.Name, viewSchema.Definition)
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to get columns for view %q", tableName)
+ }
+ return &base.PhysicalView{
+ Name: viewSchema.Name,
+ Schema: emptySchema,
+ Database: dbMetadata.GetProto().GetName(),
+ Server: "",
+ Columns: columns,
+ }, nil
+ }
+
+ return nil, &base.ResourceNotFoundError{
+ Database: &databaseName,
+ Schema: &emptySchema,
+ Table: &tableName,
+ }
+}
+
+func (q *querySpanExtractor) getColumnsForView(databaseName, viewName, definition string) ([]base.QuerySpanResult, error) {
+ key := mysqlViewResolutionKey(databaseName, viewName)
+ if q.viewResolutionStack[key] {
+ return nil, errors.Errorf("cyclic view reference detected while resolving %q", viewName)
+ }
+
+ newQ := newQuerySpanExtractor(q.defaultDatabase, q.gCtx, q.ignoreCaseSensitive)
+ newQ.viewResolutionStack = cloneViewResolutionStack(q.viewResolutionStack)
+ newQ.viewResolutionStack[key] = true
+ span, err := newQ.getQuerySpan(q.ctx, definition)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to get query span for view")
+ }
+ if span.NotFoundError != nil {
+ return nil, span.NotFoundError
+ }
+ return span.Results, nil
+}
+
+func mysqlViewResolutionKey(databaseName, viewName string) string {
+ return databaseName + "\x00" + viewName
+}
+
+func cloneViewResolutionStack(in map[string]bool) map[string]bool {
+ out := make(map[string]bool, len(in))
+ for k, v := range in {
+ out[k] = v
+ }
+ return out
+}
+
+func isMixedQuery(m base.SourceColumnSet, ignoreCaseSensitive bool) (bool, bool) {
+ hasSystem, hasUser := false, false
+ for table := range m {
+ if isSystemResource(table, ignoreCaseSensitive) {
+ hasSystem = true
+ } else {
+ hasUser = true
+ }
+ }
+ if hasSystem && hasUser {
+ return false, true
+ }
+ return !hasUser && hasSystem, false
+}
+
+var reservedSystemDatabases = map[string]bool{
+ "information_schema": true,
+ "performance_schema": true,
+}
+
+var onDiskSystemDatabases = map[string]bool{
+ "mysql": true,
+}
+
+func isSystemResource(resource base.ColumnResource, ignoreCaseSensitive bool) bool {
+ if reservedSystemDatabases[strings.ToLower(resource.Database)] {
+ return true
+ }
+ database := resource.Database
+ if ignoreCaseSensitive {
+ database = strings.ToLower(database)
+ }
+ return onDiskSystemDatabases[database]
+}
+
+// omniQuerySpanExtractor extracts query span information from omni MySQL AST.
+// It embeds querySpanExtractor so shared metadata and identifier-resolution
+// helpers can be reused as the omni implementation grows.
+type omniQuerySpanExtractor struct {
+ *querySpanExtractor
+ source string
+}
+
+func newOmniQuerySpanExtractor(defaultDatabase string, gCtx base.GetQuerySpanContext, ignoreCaseSensitive bool) *omniQuerySpanExtractor {
+ return &omniQuerySpanExtractor{
+ querySpanExtractor: newQuerySpanExtractor(defaultDatabase, gCtx, ignoreCaseSensitive),
+ }
+}
+
+// getOmniQuerySpan is the package-internal omni entry point used by migration
+// tests and the production MySQL query-span path after cutover.
+func (q *omniQuerySpanExtractor) getOmniQuerySpan(ctx context.Context, statement string) (*base.QuerySpan, error) {
+ q.ctx = ctx
+ q.source = statement
+
+ stmts, err := ParseOceanBase(statement)
+ if err != nil {
+ return nil, err
+ }
+ if stmts == nil || len(stmts.Items) == 0 {
+ return &base.QuerySpan{
+ Type: base.Select,
+ SourceColumns: base.SourceColumnSet{},
+ Results: []base.QuerySpanResult{},
+ PredicateColumns: base.SourceColumnSet{},
+ }, nil
+ }
+ if len(stmts.Items) != 1 {
+ return nil, errors.Errorf("expected exactly 1 statement, got %d", len(stmts.Items))
+ }
+
+ root := stmts.Items[0]
+ accessTables := collectOmniAccessTables(root, q.defaultDatabase)
+ allSystems, mixed := isMixedQuery(accessTables, q.ignoreCaseSensitive)
+ if mixed {
+ return nil, base.MixUserSystemTablesError
+ }
+
+ queryType := classifyOmniQueryType(root, allSystems, q.source)
+ if allSystems {
+ accessTables = base.SourceColumnSet{}
+ }
+ explain, isExplain := root.(*ast.ExplainStmt)
+ explainAnalyze := isExplain && explain.Analyze
+
+ var results []base.QuerySpanResult
+ if queryType == base.Select {
+ tableSource, err := q.extractOmniSelectRoot(root)
+ if err != nil {
+ var resourceNotFound *base.ResourceNotFoundError
+ if errors.As(err, &resourceNotFound) {
+ return &base.QuerySpan{
+ Type: base.Select,
+ SourceColumns: accessTables,
+ Results: []base.QuerySpanResult{},
+ PredicateColumns: base.SourceColumnSet{},
+ NotFoundError: resourceNotFound,
+ }, nil
+ }
+ return nil, err
+ }
+ results = tableSource.GetQuerySpanResult()
+ }
+ return &base.QuerySpan{
+ Type: queryType,
+ ExplainAnalyze: explainAnalyze,
+ SourceColumns: accessTables,
+ Results: results,
+ PredicateColumns: base.SourceColumnSet{},
+ }, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniSelectRoot(root ast.Node) (*base.PseudoTable, error) {
+ switch n := root.(type) {
+ case *ast.SelectStmt:
+ return q.extractOmniSelectStmt(n)
+ case *ast.ExplainStmt:
+ return &base.PseudoTable{}, nil
+ case *ast.TableStmt:
+ return q.extractOmniTableStmt(n)
+ case *ast.ValuesStmt:
+ return q.extractOmniValuesStmt(n)
+ default:
+ return &base.PseudoTable{}, nil
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniSelectStmt(stmt *ast.SelectStmt) (*base.PseudoTable, error) {
+ if stmt == nil {
+ return &base.PseudoTable{}, nil
+ }
+ if stmt.Into != nil {
+ return nil, errors.New("meet unsupported select statement with into")
+ }
+
+ originalTableSourceFrom := q.tableSourceFrom
+ originalPriorLength := len(q.priorTableInFrom)
+ originalCTELength := len(q.ctes)
+ defer func() {
+ q.tableSourceFrom = originalTableSourceFrom
+ q.priorTableInFrom = q.priorTableInFrom[:originalPriorLength]
+ q.ctes = q.ctes[:originalCTELength]
+ }()
+
+ if err := q.processOmniCTEs(stmt.CTEs); err != nil {
+ return nil, err
+ }
+ if inner := stmt.ParenSource; inner != nil {
+ return q.extractOmniSelectStmt(inner)
+ }
+ if tableStmt := stmt.TableSource; tableStmt != nil {
+ return q.extractOmniTableStmt(tableStmt)
+ }
+ if valuesStmt := stmt.ValuesSource; valuesStmt != nil {
+ return q.extractOmniValuesStmt(valuesStmt)
+ }
+ if stmt.SetOp != ast.SetOpNone {
+ return q.extractOmniSetOp(stmt)
+ }
+
+ fromSources, err := q.extractOmniTableSources(stmt.From)
+ if err != nil {
+ return nil, err
+ }
+ q.tableSourceFrom = append(q.tableSourceFrom, fromSources...)
+
+ results, err := q.extractOmniTargetList(stmt.TargetList, fromSources)
+ if err != nil {
+ return nil, err
+ }
+ return &base.PseudoTable{
+ Columns: results,
+ }, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTableStmt(stmt *ast.TableStmt) (*base.PseudoTable, error) {
+ if stmt == nil || stmt.Table == nil {
+ return &base.PseudoTable{}, nil
+ }
+ if stmt.Into != nil {
+ return nil, errors.New("meet unsupported table statement with into")
+ }
+ tableSource, err := q.findTableSchema(stmt.Table.Schema, stmt.Table.Name)
+ if err != nil {
+ return nil, err
+ }
+ return &base.PseudoTable{Columns: tableSource.GetQuerySpanResult()}, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniValuesStmt(stmt *ast.ValuesStmt) (*base.PseudoTable, error) {
+ if stmt == nil || len(stmt.Rows) == 0 {
+ return &base.PseudoTable{}, nil
+ }
+ var columns []base.QuerySpanResult
+ for _, expr := range stmt.Rows[0] {
+ field, err := q.extractOmniExpr(expr)
+ if err != nil {
+ return nil, err
+ }
+ columns = append(columns, field)
+ }
+ return &base.PseudoTable{Columns: columns}, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniSetOp(stmt *ast.SelectStmt) (*base.PseudoTable, error) {
+ if stmt == nil || stmt.SetOp == ast.SetOpNone {
+ return q.extractOmniSelectStmt(stmt)
+ }
+ left, err := q.extractOmniSelectStmt(stmt.Left)
+ if err != nil {
+ return nil, err
+ }
+ right, err := q.extractOmniSelectStmt(stmt.Right)
+ if err != nil {
+ return nil, err
+ }
+ leftResults := left.GetQuerySpanResult()
+ rightResults := right.GetQuerySpanResult()
+ if len(leftResults) != len(rightResults) {
+ return nil, errors.Errorf("MySQL UNION operator left has %d fields, right has %d fields", len(leftResults), len(rightResults))
+ }
+ results := make([]base.QuerySpanResult, 0, len(leftResults))
+ for i := range leftResults {
+ sourceColumns, _ := base.MergeSourceColumnSet(leftResults[i].SourceColumns, rightResults[i].SourceColumns)
+ results = append(results, base.QuerySpanResult{
+ Name: leftResults[i].Name,
+ SourceColumns: sourceColumns,
+ IsPlainField: false,
+ })
+ }
+ return &base.PseudoTable{Columns: results}, nil
+}
+
+func (q *omniQuerySpanExtractor) processOmniCTEs(ctes []*ast.CommonTableExpr) error {
+ for _, cte := range ctes {
+ tableSource, err := q.extractOmniCTE(cte)
+ if err != nil {
+ return err
+ }
+ if tableSource != nil {
+ q.ctes = append(q.ctes, tableSource)
+ }
+ }
+ return nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniCTE(cte *ast.CommonTableExpr) (*base.PseudoTable, error) {
+ if cte == nil {
+ return nil, nil
+ }
+ if cte.Recursive {
+ return q.extractOmniRecursiveCTE(cte)
+ }
+ return q.extractOmniNonRecursiveCTE(cte)
+}
+
+func (q *omniQuerySpanExtractor) extractOmniNonRecursiveCTE(cte *ast.CommonTableExpr) (*base.PseudoTable, error) {
+ tableSource, err := q.extractOmniSelectStmt(cte.Select)
+ if err != nil {
+ return nil, err
+ }
+ results := cloneOmniQuerySpanResults(tableSource.GetQuerySpanResult())
+ if len(cte.Columns) > 0 {
+ if len(cte.Columns) != len(results) {
+ return nil, errors.Errorf("MySQL CTE column list should have the same length, but got %d and %d", len(cte.Columns), len(results))
+ }
+ for i := range cte.Columns {
+ results[i].Name = cte.Columns[i]
+ }
+ }
+ return &base.PseudoTable{Name: cte.Name, Columns: results}, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniRecursiveCTE(cte *ast.CommonTableExpr) (*base.PseudoTable, error) {
+ selectStmt := ast.UnwrapParenSource(cte.Select)
+ if selectStmt == nil || selectStmt.SetOp == ast.SetOpNone {
+ return q.extractOmniNonRecursiveCTE(cte)
+ }
+ initialTable, err := q.extractOmniRecursiveCTEAnchor(selectStmt)
+ if err != nil {
+ return nil, err
+ }
+ results := cloneOmniQuerySpanResults(initialTable.GetQuerySpanResult())
+ if len(cte.Columns) > 0 {
+ if len(cte.Columns) != len(results) {
+ return nil, errors.Errorf("The common table expression and column names list have different column counts")
+ }
+ for i := range cte.Columns {
+ results[i].Name = cte.Columns[i]
+ }
+ }
+ cteInfo := &base.PseudoTable{Name: cte.Name, Columns: results}
+ q.ctes = append(q.ctes, cteInfo)
+ defer func() {
+ q.ctes = q.ctes[:len(q.ctes)-1]
+ }()
+
+ for {
+ recursiveTable, err := q.extractOmniSelectStmt(cte.Select)
+ if err != nil {
+ return nil, err
+ }
+ recursiveResults := recursiveTable.GetQuerySpanResult()
+ if len(recursiveResults) != len(cteInfo.Columns) {
+ return nil, errors.Errorf("The common table expression and column names list have different column counts")
+ }
+ changed := false
+ for i := range recursiveResults {
+ var ok bool
+ cteInfo.Columns[i].SourceColumns, ok = base.MergeSourceColumnSet(cteInfo.Columns[i].SourceColumns, recursiveResults[i].SourceColumns)
+ cteInfo.Columns[i].IsPlainField = false
+ changed = changed || ok
+ }
+ if !changed {
+ break
+ }
+ }
+ return cteInfo, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniRecursiveCTEAnchor(stmt *ast.SelectStmt) (*base.PseudoTable, error) {
+ stmt = ast.UnwrapParenSource(stmt)
+ if stmt == nil || stmt.SetOp == ast.SetOpNone {
+ return q.extractOmniSelectStmt(stmt)
+ }
+ if stmt.Left != nil {
+ return q.extractOmniRecursiveCTEAnchor(stmt.Left)
+ }
+ return q.extractOmniRecursiveCTEAnchor(stmt.Right)
+}
+
+func cloneOmniQuerySpanResults(results []base.QuerySpanResult) []base.QuerySpanResult {
+ clone := make([]base.QuerySpanResult, len(results))
+ copy(clone, results)
+ return clone
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTableSources(tableExprs []ast.TableExpr) ([]base.TableSource, error) {
+ var result []base.TableSource
+ for _, tableExpr := range tableExprs {
+ tableSource, err := q.extractOmniTableSource(tableExpr)
+ if err != nil {
+ return nil, err
+ }
+ if tableSource == nil {
+ continue
+ }
+ q.priorTableInFrom = append(q.priorTableInFrom, tableSource)
+ result = append(result, tableSource)
+ }
+ return result, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTableSource(tableExpr ast.TableExpr) (base.TableSource, error) {
+ switch t := tableExpr.(type) {
+ case nil:
+ return nil, nil
+ case *ast.TableRef:
+ if isOmniDualTable(t) {
+ return &base.PseudoTable{Name: t.Name}, nil
+ }
+ tableSource, err := q.findTableSchema(t.Schema, t.Name)
+ if err != nil {
+ return nil, err
+ }
+ if t.Alias == "" {
+ return tableSource, nil
+ }
+ return &base.PseudoTable{
+ Name: t.Alias,
+ Columns: tableSource.GetQuerySpanResult(),
+ }, nil
+ case *ast.SubqueryExpr:
+ return q.extractOmniSubquery(t)
+ case *ast.JoinClause:
+ return q.extractOmniJoin(t)
+ case *ast.JsonTableExpr:
+ return q.extractOmniJSONTable(t)
+ default:
+ return nil, errors.Errorf("unsupported omni MySQL table source %T", tableExpr)
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniJSONTable(expr *ast.JsonTableExpr) (base.TableSource, error) {
+ if expr == nil {
+ return nil, nil
+ }
+ name := expr.Alias
+ if name == "" {
+ name = q.omniExprName(expr.Expr)
+ }
+ field, err := q.extractOmniExpr(expr.Expr)
+ if err != nil {
+ return nil, err
+ }
+ var columns []base.QuerySpanResult
+ for _, column := range flattenOmniJSONTableColumns(expr.Columns) {
+ columns = append(columns, base.QuerySpanResult{
+ Name: column.Name,
+ SourceColumns: field.SourceColumns,
+ IsPlainField: field.IsPlainField,
+ })
+ }
+ return &base.PseudoTable{Name: name, Columns: columns}, nil
+}
+
+func flattenOmniJSONTableColumns(columns []*ast.JsonTableColumn) []*ast.JsonTableColumn {
+ var result []*ast.JsonTableColumn
+ for _, column := range columns {
+ if column == nil {
+ continue
+ }
+ if column.Nested {
+ result = append(result, flattenOmniJSONTableColumns(column.NestedCols)...)
+ continue
+ }
+ result = append(result, column)
+ }
+ return result
+}
+
+func (q *omniQuerySpanExtractor) extractOmniJoin(join *ast.JoinClause) (base.TableSource, error) {
+ if join == nil {
+ return nil, nil
+ }
+ left, err := q.extractOmniTableSource(join.Left)
+ if err != nil {
+ return nil, err
+ }
+ if left != nil {
+ q.tableSourceFrom = append(q.tableSourceFrom, left)
+ }
+ right, err := q.extractOmniTableSource(join.Right)
+ if err != nil {
+ return nil, err
+ }
+ if right != nil {
+ q.tableSourceFrom = append(q.tableSourceFrom, right)
+ }
+
+ var using []string
+ if condition, ok := join.Condition.(*ast.UsingCondition); ok && condition != nil {
+ using = condition.Columns
+ }
+ return joinTableSources(left, right, omniJoinType(join.Type), using), nil
+}
+
+func omniJoinType(joinType ast.JoinType) joinType {
+ switch joinType {
+ case ast.JoinInner:
+ return InnerJoin
+ case ast.JoinLeft:
+ return LeftOuterJoin
+ case ast.JoinRight:
+ return RightOuterJoin
+ case ast.JoinCross:
+ return CrossJoin
+ case ast.JoinNatural:
+ return NaturalInnerJoin
+ case ast.JoinStraight:
+ return StraightJoin
+ case ast.JoinNaturalLeft:
+ return NaturalLeftOuterJoin
+ case ast.JoinNaturalRight:
+ return NaturalRightOuterJoin
+ default:
+ return Join
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniSubquery(expr *ast.SubqueryExpr) (*base.PseudoTable, error) {
+ if expr == nil {
+ return &base.PseudoTable{}, nil
+ }
+ subqueryExtractor := q.cloneOmniForSubquery()
+ if expr.Lateral {
+ subqueryExtractor.outerTableSources = append(subqueryExtractor.outerTableSources, q.priorTableInFrom...)
+ }
+ tableSource, err := subqueryExtractor.extractOmniSelectStmt(expr.Select)
+ if err != nil {
+ return nil, err
+ }
+ results := cloneOmniQuerySpanResults(tableSource.GetQuerySpanResult())
+ if len(expr.Columns) > 0 {
+ if len(expr.Columns) != len(results) {
+ return nil, errors.Errorf("derived table column list length %d doesn't match result column length %d", len(expr.Columns), len(results))
+ }
+ for i := range expr.Columns {
+ results[i].Name = expr.Columns[i]
+ }
+ }
+ if expr.Alias == "" {
+ return &base.PseudoTable{Name: tableSource.Name, Columns: results}, nil
+ }
+ return &base.PseudoTable{
+ Name: expr.Alias,
+ Columns: results,
+ }, nil
+}
+
+func (q *omniQuerySpanExtractor) cloneOmniForSubquery() *omniQuerySpanExtractor {
+ return &omniQuerySpanExtractor{
+ querySpanExtractor: &querySpanExtractor{
+ ctx: q.ctx,
+ defaultDatabase: q.defaultDatabase,
+ gCtx: q.gCtx,
+ ctes: q.ctes,
+ outerTableSources: append(q.outerTableSources, q.tableSourceFrom...),
+ tableSourceFrom: []base.TableSource{},
+ ignoreCaseSensitive: q.ignoreCaseSensitive,
+ viewResolutionStack: cloneViewResolutionStack(q.viewResolutionStack),
+ },
+ source: q.source,
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTargetList(targets []ast.ExprNode, fromSources []base.TableSource) ([]base.QuerySpanResult, error) {
+ var result []base.QuerySpanResult
+ for _, target := range targets {
+ switch t := target.(type) {
+ case *ast.ResTarget:
+ if _, ok := t.Val.(*ast.StarExpr); ok {
+ fields, err := q.extractOmniTableWild("", "", fromSources)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, fields...)
+ continue
+ }
+ if columnRef, ok := t.Val.(*ast.ColumnRef); ok && columnRef.Star {
+ fields, err := q.extractOmniColumnWild(columnRef, fromSources)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, fields...)
+ continue
+ }
+ case *ast.StarExpr:
+ fields, err := q.extractOmniTableWild("", "", fromSources)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, fields...)
+ continue
+ case *ast.ColumnRef:
+ if t.Star {
+ fields, err := q.extractOmniColumnWild(t, fromSources)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, fields...)
+ continue
+ }
+ default:
+ }
+
+ field, err := q.extractOmniTarget(target)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, field)
+ }
+ return result, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTarget(target ast.ExprNode) (base.QuerySpanResult, error) {
+ switch t := target.(type) {
+ case *ast.ResTarget:
+ field, err := q.extractOmniExpr(t.Val)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ if t.Name != "" {
+ field.Name = t.Name
+ }
+ return field, nil
+ default:
+ return q.extractOmniExpr(target)
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniExpr(expr ast.ExprNode) (base.QuerySpanResult, error) {
+ switch e := expr.(type) {
+ case nil:
+ return base.QuerySpanResult{
+ SourceColumns: base.SourceColumnSet{},
+ IsPlainField: true,
+ }, nil
+ case *ast.ColumnRef:
+ if e.Star {
+ return base.QuerySpanResult{}, errors.Errorf("asterisk is not a scalar expression")
+ }
+ sourceColumns, err := q.getFieldColumnSource(e.Schema, e.Table, e.Column)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{
+ Name: e.Column,
+ SourceColumns: sourceColumns,
+ IsPlainField: true,
+ }, nil
+ case *ast.StarExpr:
+ return base.QuerySpanResult{}, errors.Errorf("asterisk is not a scalar expression")
+ case *ast.IntLit, *ast.FloatLit, *ast.StringLit, *ast.BoolLit, *ast.NullLit, *ast.HexLit, *ast.BitLit, *ast.TemporalLit:
+ return base.QuerySpanResult{
+ Name: q.omniExprName(e),
+ SourceColumns: base.SourceColumnSet{},
+ IsPlainField: true,
+ }, nil
+ case *ast.VariableRef:
+ return base.QuerySpanResult{
+ Name: q.omniExprName(e),
+ SourceColumns: base.SourceColumnSet{},
+ IsPlainField: true,
+ }, nil
+ case *ast.ParenExpr:
+ field, err := q.extractOmniExpr(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ field.Name = q.omniExprName(e)
+ field.IsPlainField = false
+ return field, nil
+ case *ast.BinaryExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Left, e.Right)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.UnaryExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Operand)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.FuncCallExpr:
+ exprs := append([]ast.ExprNode{}, e.Args...)
+ exprs = append(exprs, e.Separator)
+ for _, item := range e.OrderBy {
+ if item != nil {
+ exprs = append(exprs, item.Expr)
+ }
+ }
+ if e.Over != nil {
+ exprs = append(exprs, e.Over.PartitionBy...)
+ for _, item := range e.Over.OrderBy {
+ if item != nil {
+ exprs = append(exprs, item.Expr)
+ }
+ }
+ }
+ sourceColumns, err := q.mergeOmniExprSources(exprs...)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.SubqueryExpr:
+ sourceColumns, isPlain, err := q.extractOmniSelectSourceColumns(e.Select)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: isPlain}, nil
+ case *ast.ExistsExpr:
+ sourceColumns, _, err := q.extractOmniSelectSourceColumns(e.Select)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.CaseExpr:
+ var exprs []ast.ExprNode
+ exprs = append(exprs, e.Operand)
+ for _, when := range e.Whens {
+ if when == nil {
+ continue
+ }
+ exprs = append(exprs, when.Cond, when.Result)
+ }
+ exprs = append(exprs, e.Default)
+ sourceColumns, err := q.mergeOmniExprSources(exprs...)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.BetweenExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr, e.Low, e.High)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.InExpr:
+ exprs := append([]ast.ExprNode{e.Expr}, e.List...)
+ sourceColumns, err := q.mergeOmniExprSources(exprs...)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ if e.Select != nil {
+ selectSourceColumns, _, err := q.extractOmniSelectSourceColumns(e.Select)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ sourceColumns, _ = base.MergeSourceColumnSet(sourceColumns, selectSourceColumns)
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.LikeExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr, e.Pattern, e.Escape)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.IsExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.CastExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.ExtractExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.IntervalExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Value)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.CollateExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.MatchExpr:
+ exprs := make([]ast.ExprNode, 0, len(e.Columns)+1)
+ for _, column := range e.Columns {
+ exprs = append(exprs, column)
+ }
+ exprs = append(exprs, e.Against)
+ sourceColumns, err := q.mergeOmniExprSources(exprs...)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.ConvertExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.DefaultExpr:
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: base.SourceColumnSet{}, IsPlainField: true}, nil
+ case *ast.RowExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Items...)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.MemberOfExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Value, e.Array)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ case *ast.KeywordArg:
+ // Keyword arguments (TIMESTAMPDIFF(SECOND, ...), GET_FORMAT(DATE, ...))
+ // are unit selectors, not column references — no lineage.
+ return base.QuerySpanResult{Name: e.Keyword, SourceColumns: base.SourceColumnSet{}, IsPlainField: false}, nil
+ case *ast.WeightStringExpr:
+ sourceColumns, err := q.mergeOmniExprSources(e.Expr)
+ if err != nil {
+ return base.QuerySpanResult{}, err
+ }
+ return base.QuerySpanResult{Name: q.omniExprName(e), SourceColumns: sourceColumns, IsPlainField: false}, nil
+ default:
+ return base.QuerySpanResult{}, errors.Errorf("unsupported omni MySQL expression %T", expr)
+ }
+}
+
+func (q *omniQuerySpanExtractor) extractOmniSelectSourceColumns(selectStmt *ast.SelectStmt) (base.SourceColumnSet, bool, error) {
+ subqueryExtractor := q.cloneOmniForSubquery()
+ tableSource, err := subqueryExtractor.extractOmniSelectStmt(selectStmt)
+ if err != nil {
+ return nil, false, err
+ }
+ spanResults := tableSource.GetQuerySpanResult()
+ sourceColumns := make(base.SourceColumnSet)
+ for _, field := range spanResults {
+ sourceColumns, _ = base.MergeSourceColumnSet(sourceColumns, field.SourceColumns)
+ }
+ isPlain := false
+ if len(spanResults) == 1 {
+ isPlain = spanResults[0].IsPlainField
+ }
+ return sourceColumns, isPlain, nil
+}
+
+func (q *omniQuerySpanExtractor) mergeOmniExprSources(exprs ...ast.ExprNode) (base.SourceColumnSet, error) {
+ result := make(base.SourceColumnSet)
+ for _, expr := range exprs {
+ if expr == nil {
+ continue
+ }
+ field, err := q.extractOmniExpr(expr)
+ if err != nil {
+ return nil, err
+ }
+ result, _ = base.MergeSourceColumnSet(result, field.SourceColumns)
+ }
+ return result, nil
+}
+
+func (q *omniQuerySpanExtractor) extractOmniColumnWild(columnRef *ast.ColumnRef, fromSources []base.TableSource) ([]base.QuerySpanResult, error) {
+ if columnRef == nil {
+ return nil, nil
+ }
+ return q.extractOmniTableWild(columnRef.Schema, columnRef.Table, fromSources)
+}
+
+func (q *omniQuerySpanExtractor) extractOmniTableWild(databaseName, tableName string, fromSources []base.TableSource) ([]base.QuerySpanResult, error) {
+ if databaseName == "" && tableName == "" {
+ var result []base.QuerySpanResult
+ for _, fromSource := range fromSources {
+ result = append(result, fromSource.GetQuerySpanResult()...)
+ }
+ return result, nil
+ }
+
+ result, ok := q.getAllTableColumnSources(databaseName, tableName)
+ if !ok {
+ return nil, &base.ResourceNotFoundError{
+ Database: &databaseName,
+ Table: &tableName,
+ }
+ }
+ return result, nil
+}
+
+func (q *omniQuerySpanExtractor) omniExprName(expr ast.ExprNode) string {
+ switch e := expr.(type) {
+ case *ast.ColumnRef:
+ var parts []string
+ if e.Schema != "" {
+ parts = append(parts, e.Schema)
+ }
+ if e.Table != "" {
+ parts = append(parts, e.Table)
+ }
+ if e.Star {
+ parts = append(parts, "*")
+ } else {
+ parts = append(parts, e.Column)
+ }
+ return strings.Join(parts, ".")
+ case *ast.BinaryExpr:
+ return q.omniExprName(e.Left) + omniBinaryOpName(e) + q.omniExprName(e.Right)
+ case *ast.InExpr:
+ var list []string
+ for _, expr := range e.List {
+ list = append(list, q.omniExprName(expr))
+ }
+ operator := " in "
+ if e.Not {
+ operator = " not in "
+ }
+ return q.omniExprName(e.Expr) + operator + "(" + strings.Join(list, ", ") + ")"
+ case *ast.IntLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return strconv.FormatInt(e.Value, 10)
+ case *ast.FloatLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return e.Value
+ case *ast.StringLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return e.Value
+ case *ast.BoolLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return strconv.FormatBool(e.Value)
+ case *ast.NullLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return "NULL"
+ case *ast.HexLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return e.Value
+ case *ast.BitLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return e.Value
+ case *ast.TemporalLit:
+ if name := q.omniSlice(e.Loc); name != "" {
+ return name
+ }
+ return e.Value
+ default:
+ if loc, ok := omniNodeLoc(e); ok {
+ return q.omniSlice(loc)
+ }
+ return ""
+ }
+}
+
+func omniBinaryOpName(expr *ast.BinaryExpr) string {
+ if expr == nil {
+ return ""
+ }
+ if expr.OriginalOp != "" {
+ return expr.OriginalOp
+ }
+ return omniBinaryOpNames[expr.Op]
+}
+
+var omniBinaryOpNames = map[ast.BinaryOp]string{
+ ast.BinOpAdd: "+",
+ ast.BinOpSub: "-",
+ ast.BinOpMul: "*",
+ ast.BinOpDiv: "/",
+ ast.BinOpMod: "%",
+ ast.BinOpEq: "=",
+ ast.BinOpNe: "!=",
+ ast.BinOpLt: "<",
+ ast.BinOpGt: ">",
+ ast.BinOpLe: "<=",
+ ast.BinOpGe: ">=",
+ ast.BinOpAnd: " and ",
+ ast.BinOpOr: " or ",
+ ast.BinOpXor: " xor ",
+ ast.BinOpBitAnd: "&",
+ ast.BinOpBitOr: "|",
+ ast.BinOpBitXor: "^",
+ ast.BinOpShiftLeft: "<<",
+ ast.BinOpShiftRight: ">>",
+ ast.BinOpDivInt: " div ",
+ ast.BinOpRegexp: " regexp ",
+ ast.BinOpLikeEscape: " like ",
+ ast.BinOpNullSafeEq: "<=>",
+ ast.BinOpAssign: ":=",
+ ast.BinOpJsonExtract: "->",
+ ast.BinOpJsonUnquote: "->>",
+ ast.BinOpSoundsLike: " sounds like ",
+}
+
+func (q *omniQuerySpanExtractor) omniSlice(loc ast.Loc) string {
+ if loc.Start < 0 || loc.End <= loc.Start || loc.End > len(q.source) {
+ return ""
+ }
+ return strings.TrimSpace(q.source[loc.Start:loc.End])
+}
+
+func omniNodeLoc(node ast.Node) (ast.Loc, bool) {
+ if loc, ok := omniExprNodeLoc(node); ok {
+ return loc, true
+ }
+ return omniLiteralNodeLoc(node)
+}
+
+func omniExprNodeLoc(node ast.Node) (ast.Loc, bool) {
+ switch n := node.(type) {
+ case *ast.ResTarget:
+ return n.Loc, true
+ case *ast.ColumnRef:
+ return n.Loc, true
+ case *ast.BinaryExpr:
+ return n.Loc, true
+ case *ast.UnaryExpr:
+ return n.Loc, true
+ case *ast.FuncCallExpr:
+ return n.Loc, true
+ case *ast.SubqueryExpr:
+ return n.Loc, true
+ case *ast.CaseExpr:
+ return n.Loc, true
+ case *ast.BetweenExpr:
+ return n.Loc, true
+ case *ast.InExpr:
+ return n.Loc, true
+ case *ast.LikeExpr:
+ return n.Loc, true
+ case *ast.IsExpr:
+ return n.Loc, true
+ case *ast.ExistsExpr:
+ return n.Loc, true
+ case *ast.CastExpr:
+ return n.Loc, true
+ case *ast.ExtractExpr:
+ return n.Loc, true
+ case *ast.IntervalExpr:
+ return n.Loc, true
+ case *ast.CollateExpr:
+ return n.Loc, true
+ case *ast.MatchExpr:
+ return n.Loc, true
+ case *ast.ConvertExpr:
+ return n.Loc, true
+ case *ast.DefaultExpr:
+ return n.Loc, true
+ case *ast.RowExpr:
+ return n.Loc, true
+ case *ast.MemberOfExpr:
+ return n.Loc, true
+ case *ast.ParenExpr:
+ return n.Loc, true
+ case *ast.StarExpr:
+ return n.Loc, true
+ default:
+ return ast.Loc{}, false
+ }
+}
+
+func omniLiteralNodeLoc(node ast.Node) (ast.Loc, bool) {
+ switch n := node.(type) {
+ case *ast.IntLit:
+ return n.Loc, true
+ case *ast.FloatLit:
+ return n.Loc, true
+ case *ast.StringLit:
+ return n.Loc, true
+ case *ast.BoolLit:
+ return n.Loc, true
+ case *ast.NullLit:
+ return n.Loc, true
+ case *ast.HexLit:
+ return n.Loc, true
+ case *ast.BitLit:
+ return n.Loc, true
+ case *ast.TemporalLit:
+ return n.Loc, true
+ case *ast.VariableRef:
+ return n.Loc, true
+ default:
+ return ast.Loc{}, false
+ }
+}
+
+func classifyOmniQueryType(node ast.Node, allSystems bool, source string) base.QueryType {
+ switch n := node.(type) {
+ case *ast.SelectStmt, *ast.TableStmt, *ast.ValuesStmt:
+ if allSystems {
+ return base.SelectInfoSchema
+ }
+ return base.Select
+ case *ast.ExplainStmt:
+ if isOmniDescribeStatement(source, n.Loc) {
+ return base.SelectInfoSchema
+ }
+ if n.Analyze {
+ switch n.Stmt.(type) {
+ case *ast.SelectStmt, *ast.TableStmt, *ast.ValuesStmt:
+ return base.Select
+ default:
+ return base.DML
+ }
+ }
+ return base.Explain
+ case *ast.ShowStmt:
+ return base.SelectInfoSchema
+ case *ast.SetStmt, *ast.SetDefaultRoleStmt, *ast.SetResourceGroupStmt, *ast.SetRoleStmt, *ast.SetTransactionStmt:
+ return base.Select
+ case *ast.SetPasswordStmt, *ast.HelpStmt:
+ return base.QueryTypeUnknown
+ case *ast.CreateDatabaseStmt, *ast.CreateTableStmt, *ast.CreateIndexStmt, *ast.CreateViewStmt,
+ *ast.CreateEventStmt, *ast.CreateTriggerStmt, *ast.CreateFunctionStmt,
+ *ast.CreateUserStmt, *ast.CreateRoleStmt, *ast.CreateTablespaceStmt, *ast.CreateServerStmt,
+ *ast.CreateLogfileGroupStmt, *ast.CreateSpatialRefSysStmt, *ast.CreateResourceGroupStmt,
+ *ast.AlterDatabaseStmt, *ast.AlterTableStmt, *ast.AlterViewStmt, *ast.AlterEventStmt,
+ *ast.AlterUserStmt, *ast.AlterRoutineStmt, *ast.AlterTablespaceStmt, *ast.AlterServerStmt,
+ *ast.AlterLogfileGroupStmt, *ast.AlterResourceGroupStmt, *ast.AlterInstanceStmt,
+ *ast.DropDatabaseStmt, *ast.DropTableStmt, *ast.DropIndexStmt, *ast.DropViewStmt,
+ *ast.DropEventStmt, *ast.DropTriggerStmt, *ast.DropRoutineStmt,
+ *ast.DropUserStmt, *ast.DropRoleStmt, *ast.DropTablespaceStmt, *ast.DropServerStmt,
+ *ast.DropLogfileGroupStmt, *ast.DropSpatialRefSysStmt, *ast.DropResourceGroupStmt,
+ *ast.RenameTableStmt, *ast.RenameUserStmt, *ast.TruncateStmt, *ast.ImportTableStmt,
+ *ast.GrantStmt, *ast.RevokeStmt, *ast.GrantRoleStmt, *ast.RevokeRoleStmt,
+ *ast.InstallPluginStmt, *ast.UninstallPluginStmt, *ast.InstallComponentStmt,
+ *ast.UninstallComponentStmt, *ast.CloneStmt:
+ return base.DDL
+ case *ast.InsertStmt, *ast.UpdateStmt, *ast.DeleteStmt, *ast.BeginStmt, *ast.CommitStmt,
+ *ast.RollbackStmt, *ast.SavepointStmt, *ast.LockTablesStmt, *ast.UnlockTablesStmt,
+ *ast.LoadDataStmt, *ast.PrepareStmt, *ast.ExecuteStmt, *ast.DeallocateStmt,
+ *ast.CallStmt, *ast.DoStmt, *ast.HandlerOpenStmt, *ast.HandlerReadStmt, *ast.HandlerCloseStmt,
+ *ast.AnalyzeTableStmt, *ast.OptimizeTableStmt, *ast.CheckTableStmt, *ast.RepairTableStmt,
+ *ast.FlushStmt, *ast.KillStmt, *ast.ShutdownStmt, *ast.RestartStmt, *ast.XAStmt,
+ *ast.SignalStmt, *ast.ResignalStmt, *ast.GetDiagnosticsStmt, *ast.DeclareVarStmt,
+ *ast.DeclareConditionStmt, *ast.DeclareHandlerStmt, *ast.DeclareCursorStmt,
+ *ast.IfStmt, *ast.WhileStmt, *ast.RepeatStmt, *ast.LoopStmt, *ast.LeaveStmt,
+ *ast.IterateStmt, *ast.ReturnStmt, *ast.OpenCursorStmt, *ast.FetchCursorStmt,
+ *ast.CloseCursorStmt, *ast.LockInstanceStmt, *ast.UnlockInstanceStmt, *ast.BinlogStmt,
+ *ast.CacheIndexStmt, *ast.LoadIndexIntoCacheStmt, *ast.ResetPersistStmt,
+ *ast.ChangeReplicationSourceStmt, *ast.ChangeReplicationFilterStmt,
+ *ast.StartReplicaStmt, *ast.StopReplicaStmt, *ast.ResetReplicaStmt,
+ *ast.PurgeBinaryLogsStmt, *ast.ResetMasterStmt,
+ *ast.StartGroupReplicationStmt, *ast.StopGroupReplicationStmt:
+ return base.DML
+ default:
+ return base.QueryTypeUnknown
+ }
+}
+
+func isOmniDescribeStatement(source string, loc ast.Loc) bool {
+ statement := strings.TrimSpace(source)
+ if loc.Start >= 0 && loc.End > loc.Start && loc.End <= len(source) {
+ statement = strings.TrimSpace(source[loc.Start:loc.End])
+ }
+ upper := strings.ToUpper(statement)
+ fields := strings.Fields(upper)
+ return len(fields) > 0 && (fields[0] == "DESCRIBE" || fields[0] == "DESC")
+}
+
+func collectOmniAccessTables(root ast.Node, defaultDatabase string) base.SourceColumnSet {
+ result := make(base.SourceColumnSet)
+ collectOmniAccessTablesFromNode(result, root, defaultDatabase)
+ return result
+}
+
+func collectOmniAccessTablesFromNode(result base.SourceColumnSet, node ast.Node, defaultDatabase string) {
+ switch n := node.(type) {
+ case nil:
+ case *ast.SelectStmt:
+ if n == nil {
+ return
+ }
+ for _, cte := range n.CTEs {
+ if cte != nil {
+ collectOmniAccessTablesFromNode(result, cte.Select, defaultDatabase)
+ }
+ }
+ if n.Left != nil {
+ collectOmniAccessTablesFromNode(result, n.Left, defaultDatabase)
+ }
+ if n.Right != nil {
+ collectOmniAccessTablesFromNode(result, n.Right, defaultDatabase)
+ }
+ if inner := n.ParenSource; inner != nil {
+ collectOmniAccessTablesFromNode(result, inner, defaultDatabase)
+ }
+ if tableStmt := n.TableSource; tableStmt != nil {
+ collectOmniAccessTablesFromNode(result, tableStmt, defaultDatabase)
+ }
+ if valuesStmt := n.ValuesSource; valuesStmt != nil {
+ collectOmniAccessTablesFromNode(result, valuesStmt, defaultDatabase)
+ }
+ for _, target := range n.TargetList {
+ collectOmniAccessTablesFromExpr(result, target, defaultDatabase)
+ }
+ for _, tableExpr := range n.From {
+ collectOmniAccessTablesFromTableExpr(result, tableExpr, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, n.Where, defaultDatabase)
+ for _, groupBy := range n.GroupBy {
+ collectOmniAccessTablesFromExpr(result, groupBy, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, n.Having, defaultDatabase)
+ for _, orderBy := range n.OrderBy {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+ case *ast.ExplainStmt:
+ collectOmniAccessTablesFromNode(result, n.Stmt, defaultDatabase)
+ case *ast.InsertStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ for _, row := range n.Values {
+ for _, expr := range row {
+ collectOmniAccessTablesFromExpr(result, expr, defaultDatabase)
+ }
+ }
+ collectOmniAccessTablesFromNode(result, n.Select, defaultDatabase)
+ collectOmniAccessTablesFromNode(result, n.TableSource, defaultDatabase)
+ for _, assignment := range n.SetList {
+ if assignment != nil {
+ collectOmniAccessTablesFromExpr(result, assignment.Value, defaultDatabase)
+ }
+ }
+ for _, assignment := range n.OnDuplicateKey {
+ if assignment != nil {
+ collectOmniAccessTablesFromExpr(result, assignment.Value, defaultDatabase)
+ }
+ }
+ case *ast.UpdateStmt:
+ for _, tableExpr := range n.Tables {
+ collectOmniAccessTablesFromTableExpr(result, tableExpr, defaultDatabase)
+ }
+ for _, assignment := range n.SetList {
+ if assignment != nil {
+ collectOmniAccessTablesFromExpr(result, assignment.Value, defaultDatabase)
+ }
+ }
+ collectOmniAccessTablesFromExpr(result, n.Where, defaultDatabase)
+ for _, orderBy := range n.OrderBy {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+ case *ast.DeleteStmt:
+ for _, tableExpr := range n.Tables {
+ collectOmniAccessTablesFromTableExpr(result, tableExpr, defaultDatabase)
+ }
+ for _, tableExpr := range n.Using {
+ collectOmniAccessTablesFromTableExpr(result, tableExpr, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, n.Where, defaultDatabase)
+ for _, orderBy := range n.OrderBy {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+ case *ast.CreateTableStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ collectOmniAccessTablesFromTableRef(result, n.Like, defaultDatabase)
+ collectOmniAccessTablesFromNode(result, n.Select, defaultDatabase)
+ case *ast.CreateIndexStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ for _, column := range n.Columns {
+ if column != nil {
+ collectOmniAccessTablesFromExpr(result, column.Expr, defaultDatabase)
+ }
+ }
+ case *ast.CreateViewStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Name, defaultDatabase)
+ collectOmniAccessTablesFromNode(result, n.Select, defaultDatabase)
+ case *ast.AlterTableStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ for _, command := range n.Commands {
+ if command == nil {
+ continue
+ }
+ collectOmniAccessTablesFromExpr(result, command.DefaultExpr, defaultDatabase)
+ collectOmniAccessTablesFromTableRef(result, command.ExchangeTable, defaultDatabase)
+ collectOmniAccessTablesFromOrderBy(result, command.OrderByItems, defaultDatabase)
+ }
+ case *ast.DropTableStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.DropIndexStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ case *ast.DropViewStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Views, defaultDatabase)
+ case *ast.RenameTableStmt:
+ for _, pair := range n.Pairs {
+ if pair == nil {
+ continue
+ }
+ collectOmniAccessTablesFromTableRef(result, pair.Old, defaultDatabase)
+ collectOmniAccessTablesFromTableRef(result, pair.New, defaultDatabase)
+ }
+ case *ast.TruncateStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.AnalyzeTableStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.OptimizeTableStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.CheckTableStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.RepairTableStmt:
+ collectOmniAccessTablesFromTableRefs(result, n.Tables, defaultDatabase)
+ case *ast.TableStmt:
+ if n == nil {
+ return
+ }
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ collectOmniAccessTablesFromOrderBy(result, n.OrderBy, defaultDatabase)
+ collectOmniAccessTablesFromLimit(result, n.Limit, defaultDatabase)
+ case *ast.ValuesStmt:
+ for _, row := range n.Rows {
+ for _, expr := range row {
+ collectOmniAccessTablesFromExpr(result, expr, defaultDatabase)
+ }
+ }
+ collectOmniAccessTablesFromOrderBy(result, n.OrderBy, defaultDatabase)
+ collectOmniAccessTablesFromLimit(result, n.Limit, defaultDatabase)
+ case *ast.CallStmt:
+ for _, arg := range n.Args {
+ collectOmniAccessTablesFromExpr(result, arg, defaultDatabase)
+ }
+ case *ast.SetStmt:
+ for _, assignment := range n.Assignments {
+ if assignment != nil {
+ collectOmniAccessTablesFromExpr(result, assignment.Value, defaultDatabase)
+ }
+ }
+ case *ast.DoStmt:
+ for _, expr := range n.Exprs {
+ collectOmniAccessTablesFromExpr(result, expr, defaultDatabase)
+ }
+ case *ast.HandlerOpenStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ case *ast.HandlerReadStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, n.Where, defaultDatabase)
+ case *ast.HandlerCloseStmt:
+ collectOmniAccessTablesFromTableRef(result, n.Table, defaultDatabase)
+ case *ast.LockTablesStmt:
+ for _, table := range n.Tables {
+ if table != nil {
+ collectOmniAccessTablesFromTableRef(result, table.Table, defaultDatabase)
+ }
+ }
+ default:
+ }
+}
+
+func collectOmniAccessTablesFromOrderBy(result base.SourceColumnSet, orderByItems []*ast.OrderByItem, defaultDatabase string) {
+ for _, orderBy := range orderByItems {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+}
+
+func collectOmniAccessTablesFromLimit(result base.SourceColumnSet, limit *ast.Limit, defaultDatabase string) {
+ if limit == nil {
+ return
+ }
+ collectOmniAccessTablesFromExpr(result, limit.Count, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, limit.Offset, defaultDatabase)
+}
+
+func collectOmniAccessTablesFromTableRefs(result base.SourceColumnSet, tableRefs []*ast.TableRef, defaultDatabase string) {
+ for _, tableRef := range tableRefs {
+ collectOmniAccessTablesFromTableRef(result, tableRef, defaultDatabase)
+ }
+}
+
+func collectOmniAccessTablesFromTableRef(result base.SourceColumnSet, tableRef *ast.TableRef, defaultDatabase string) {
+ if tableRef == nil {
+ return
+ }
+ if isOmniDualTable(tableRef) {
+ return
+ }
+ database := tableRef.Schema
+ if database == "" {
+ database = defaultDatabase
+ }
+ result[base.ColumnResource{
+ Database: database,
+ Table: tableRef.Name,
+ }] = true
+}
+
+func isOmniDualTable(tableRef *ast.TableRef) bool {
+ return tableRef != nil && tableRef.Schema == "" && strings.EqualFold(tableRef.Name, "dual")
+}
+
+func collectOmniAccessTablesFromTableExpr(result base.SourceColumnSet, tableExpr ast.TableExpr, defaultDatabase string) {
+ switch n := tableExpr.(type) {
+ case *ast.TableRef:
+ collectOmniAccessTablesFromTableRef(result, n, defaultDatabase)
+ case *ast.JoinClause:
+ collectOmniAccessTablesFromTableExpr(result, n.Left, defaultDatabase)
+ collectOmniAccessTablesFromTableExpr(result, n.Right, defaultDatabase)
+ switch condition := n.Condition.(type) {
+ case *ast.OnCondition:
+ collectOmniAccessTablesFromExpr(result, condition.Expr, defaultDatabase)
+ default:
+ }
+ case *ast.SubqueryExpr:
+ collectOmniAccessTablesFromNode(result, n.Select, defaultDatabase)
+ case *ast.JsonTableExpr:
+ collectOmniAccessTablesFromExpr(result, n.Expr, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, n.Path, defaultDatabase)
+ default:
+ }
+}
+
+func collectOmniAccessTablesFromExpr(result base.SourceColumnSet, expr ast.ExprNode, defaultDatabase string) {
+ switch e := expr.(type) {
+ case nil:
+ case *ast.ResTarget:
+ collectOmniAccessTablesFromExpr(result, e.Val, defaultDatabase)
+ case *ast.BinaryExpr:
+ collectOmniAccessTablesFromExpr(result, e.Left, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.Right, defaultDatabase)
+ case *ast.UnaryExpr:
+ collectOmniAccessTablesFromExpr(result, e.Operand, defaultDatabase)
+ case *ast.FuncCallExpr:
+ for _, arg := range e.Args {
+ collectOmniAccessTablesFromExpr(result, arg, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, e.Separator, defaultDatabase)
+ for _, orderBy := range e.OrderBy {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+ if e.Over != nil {
+ for _, partitionBy := range e.Over.PartitionBy {
+ collectOmniAccessTablesFromExpr(result, partitionBy, defaultDatabase)
+ }
+ for _, orderBy := range e.Over.OrderBy {
+ if orderBy != nil {
+ collectOmniAccessTablesFromExpr(result, orderBy.Expr, defaultDatabase)
+ }
+ }
+ }
+ case *ast.SubqueryExpr:
+ collectOmniAccessTablesFromNode(result, e.Select, defaultDatabase)
+ case *ast.CaseExpr:
+ collectOmniAccessTablesFromExpr(result, e.Operand, defaultDatabase)
+ for _, when := range e.Whens {
+ if when == nil {
+ continue
+ }
+ collectOmniAccessTablesFromExpr(result, when.Cond, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, when.Result, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, e.Default, defaultDatabase)
+ case *ast.BetweenExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.Low, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.High, defaultDatabase)
+ case *ast.InExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ for _, item := range e.List {
+ collectOmniAccessTablesFromExpr(result, item, defaultDatabase)
+ }
+ collectOmniAccessTablesFromNode(result, e.Select, defaultDatabase)
+ case *ast.LikeExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.Pattern, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.Escape, defaultDatabase)
+ case *ast.IsExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.ExistsExpr:
+ collectOmniAccessTablesFromNode(result, e.Select, defaultDatabase)
+ case *ast.CastExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.ExtractExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.IntervalExpr:
+ collectOmniAccessTablesFromExpr(result, e.Value, defaultDatabase)
+ case *ast.CollateExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.MatchExpr:
+ for _, column := range e.Columns {
+ collectOmniAccessTablesFromExpr(result, column, defaultDatabase)
+ }
+ collectOmniAccessTablesFromExpr(result, e.Against, defaultDatabase)
+ case *ast.ConvertExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.RowExpr:
+ for _, item := range e.Items {
+ collectOmniAccessTablesFromExpr(result, item, defaultDatabase)
+ }
+ case *ast.MemberOfExpr:
+ collectOmniAccessTablesFromExpr(result, e.Value, defaultDatabase)
+ collectOmniAccessTablesFromExpr(result, e.Array, defaultDatabase)
+ case *ast.ParenExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ case *ast.WeightStringExpr:
+ collectOmniAccessTablesFromExpr(result, e.Expr, defaultDatabase)
+ default:
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/query_span_extractor_test.go b/backend/plugin/parser/oceanbase/query_span_extractor_test.go
new file mode 100644
index 0000000000..295eb3d2c6
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span_extractor_test.go
@@ -0,0 +1,1568 @@
+package oceanbase
+
+import (
+ "context"
+ "testing"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestOmniQuerySpanScaffold_QueryTypesAndAccessTables(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ wantType base.QueryType
+ wantResources []base.ColumnResource
+ }{
+ {
+ name: "explain_analyze_select_accesses_table",
+ statement: "EXPLAIN ANALYZE SELECT * FROM t",
+ wantType: base.Select,
+ wantResources: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ },
+ },
+ {
+ name: "set_is_select_with_no_access_tables",
+ statement: "SET CHARSET DEFAULT",
+ wantType: base.Select,
+ },
+ {
+ name: "show_is_select_info_schema",
+ statement: "SHOW DATABASES",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "plain_explain_keeps_the_tables_it_plans",
+ statement: "EXPLAIN SELECT * FROM t",
+ wantType: base.Explain,
+ wantResources: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ },
+ },
+ {
+ name: "describe_is_info_schema",
+ statement: "DESCRIBE t",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "desc_tab_is_info_schema",
+ statement: "DESC\t t",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "desc_newline_is_info_schema",
+ statement: "DESC\n t",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "ddl",
+ statement: "CREATE TABLE t(a INT)",
+ wantType: base.DDL,
+ wantResources: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "dml",
+ statement: "INSERT INTO t VALUES(1)",
+ wantType: base.DML,
+ wantResources: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "system_select",
+ statement: "SELECT * FROM mysql.user",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "standard_select_accesses_table",
+ statement: "SELECT * FROM t WHERE a > 0",
+ wantType: base.Select,
+ wantResources: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ },
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.wantType, span.Type)
+ require.Equal(t, sourceColumnSetFromResources(tc.wantResources), span.SourceColumns)
+ if tc.wantType != base.Select {
+ require.Empty(t, span.Results)
+ }
+ require.Empty(t, span.PredicateColumns)
+ })
+ }
+}
+
+func TestOmniQuerySpanPhase1_SimpleSelectResultColumns(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ }{
+ {
+ name: "constant",
+ statement: "SELECT 1",
+ want: []base.QuerySpanResult{
+ {Name: "1", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ },
+ },
+ {
+ name: "bare_column",
+ statement: "SELECT a FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "alias",
+ statement: "SELECT a AS x FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "qualified_columns",
+ statement: "SELECT a, t.b, db.t.c FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "star",
+ statement: "SELECT * FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "star_and_column",
+ statement: "SELECT *, a FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "table_star",
+ statement: "SELECT t.* FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ }
+
+ gCtx := newOmniTestQuerySpanContext()
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, base.Select, span.Type)
+ require.Equal(t, tc.want, span.Results)
+ })
+ }
+}
+
+func TestOmniQuerySpanPhase2_ExpressionSourceMerging(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT max(a), a-b AS c1, a=b AS c2, a>b, b in (a, c) FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {
+ Name: "max(a)",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}),
+ IsPlainField: false,
+ },
+ {
+ Name: "c1",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ }),
+ IsPlainField: false,
+ },
+ {
+ Name: "c2",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ }),
+ IsPlainField: false,
+ },
+ {
+ Name: "a>b",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ }),
+ IsPlainField: false,
+ },
+ {
+ Name: "b in (a, c)",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ {Database: "db", Table: "t", Column: "c"},
+ }),
+ IsPlainField: false,
+ },
+ }, span.Results)
+}
+
+// TestOmniQuerySpanKeywordArgAndWeightString covers the omni AST nodes
+// introduced with the $-token bump: KeywordArg (the unit selector in
+// TIMESTAMPDIFF/TIMESTAMPADD/GET_FORMAT — a keyword, not a column, so no
+// lineage) and WeightStringExpr (lineage follows the real operand).
+// TIMESTAMPDIFF regressed to "unsupported omni MySQL expression" without
+// these cases.
+func TestOmniQuerySpanKeywordArgAndWeightString(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT TIMESTAMPDIFF(SECOND, a, b) AS d1, TIMESTAMPADD(MINUTE, 5, a) AS d2, GET_FORMAT(DATE, 'ISO') AS d3, WEIGHT_STRING(c AS CHAR(10)) AS w FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {
+ Name: "d1",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ }),
+ IsPlainField: false,
+ },
+ {
+ Name: "d2",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ }),
+ IsPlainField: false,
+ },
+ {
+ Name: "d3",
+ SourceColumns: base.SourceColumnSet{},
+ IsPlainField: false,
+ },
+ {
+ Name: "w",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "c"},
+ }),
+ IsPlainField: false,
+ },
+ }, span.Results)
+}
+
+func TestOmniQuerySpanPhase3_FromJoinAliasAndScope(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ }{
+ {
+ name: "table_alias",
+ statement: "SELECT x.a FROM t AS x",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "join_on_with_qualified_star_and_column",
+ statement: "SELECT t1.*, t2.c, 0 FROM t1 JOIN t2 ON 1 = 1",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "c"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "c"}}), IsPlainField: true},
+ {Name: "0", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ },
+ },
+ {
+ name: "join_using_merges_star_columns",
+ statement: "SELECT * FROM t AS t1 JOIN t AS t2 USING(a)",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ }
+
+ gCtx := newOmniTestQuerySpanContext()
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ })
+ }
+}
+
+func TestOmniQuerySpanPhase4_SubqueryExpressions(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("scalar_subquery_results", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT 1 AS col_1, (SELECT(2)) AS col_2, (SELECT AVG(a + b * c) FROM t) AS avg_a_b_c FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "col_1", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ {Name: "col_2", SourceColumns: base.SourceColumnSet{}, IsPlainField: false},
+ {
+ Name: "avg_a_b_c",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t", Column: "a"},
+ {Database: "db", Table: "t", Column: "b"},
+ {Database: "db", Table: "t", Column: "c"},
+ }),
+ IsPlainField: false,
+ },
+ }, span.Results)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t"}}), span.SourceColumns)
+ })
+
+ t.Run("correlated_subquery_access_tables", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT city, (SELECT COUNT(*) FROM paintings p WHERE g.id = p.gallery_id) AS total_paintings FROM galleries g",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "city", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "galleries", Column: "city"}}), IsPlainField: true},
+ {Name: "total_paintings", SourceColumns: base.SourceColumnSet{}, IsPlainField: false},
+ }, span.Results)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "galleries"},
+ {Database: "db", Table: "paintings"},
+ }), span.SourceColumns)
+ })
+}
+
+func TestOmniQuerySpanPhase5And6_CTEAndSetOperations(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ }{
+ {
+ name: "simple_cte",
+ statement: "WITH t1 AS (SELECT * FROM t) SELECT * FROM t1",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "cte_column_aliases",
+ statement: "WITH t1(x, y, z) AS (SELECT * FROM t) SELECT * FROM t1",
+ want: []base.QuerySpanResult{
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "y", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "z", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "union_merges_positionally",
+ statement: "SELECT 1 AS c1 UNION SELECT a FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "c1", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: false},
+ },
+ },
+ {
+ name: "recursive_keyword_non_recursive_cte",
+ statement: "WITH RECURSIVE t1 AS (SELECT 1 AS c1 UNION SELECT a FROM t) SELECT * FROM t1",
+ want: []base.QuerySpanResult{
+ {Name: "c1", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: false},
+ },
+ },
+ }
+
+ gCtx := newOmniTestQuerySpanContext()
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ })
+ }
+}
+
+func TestOmniQuerySpanPhase7_JSONTable(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(
+ context.Background(),
+ `SELECT *
+FROM products,
+JSON_TABLE(product_info, '$' COLUMNS (
+ product_id INT PATH '$.id',
+ product_name VARCHAR(50) PATH '$.name'
+)) AS jt`,
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "product_info", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ {Name: "product_id", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ {Name: "product_name", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ }, span.Results)
+}
+
+func TestOmniQuerySpanPhase9_ResourceNotFoundFailOpen(t *testing.T) {
+ metadata := &metadatapb.DatabaseSchemaMetadata{Name: "db"}
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+ span, err := newOmniQuerySpanExtractor("db", base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: storepb.Engine_OCEANBASE,
+ }, false).getOmniQuerySpan(context.Background(), "SELECT * FROM t WHERE a > 0")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, span.Type)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t"}}), span.SourceColumns)
+ require.Empty(t, span.Results)
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+}
+
+func TestOmniQuerySpanSystematicMigrationRegressions(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("derived_table_column_aliases_are_applied", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT x.c1 FROM (SELECT a, b FROM t) AS x(c1, c2)",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "c1", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("in_subquery_sources_are_part_of_result_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT a IN (SELECT t2.c FROM t2) AS matched FROM t1",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {
+ Name: "matched",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t1", Column: "a"},
+ {Database: "db", Table: "t2", Column: "c"},
+ }),
+ IsPlainField: false,
+ },
+ }, span.Results)
+ })
+
+ t.Run("explicit_expression_nodes_do_not_drop_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ `SELECT
+ EXISTS (SELECT t2.a FROM t2 WHERE t2.a = t.a) AS exists_field,
+ CONVERT(a USING utf8mb4) AS converted,
+ a COLLATE utf8mb4_bin AS collated,
+ MATCH(a) AGAINST (b) AS matched,
+ ROW(a, b) AS row_field,
+ a MEMBER OF(c) AS member_field,
+ a + INTERVAL b DAY AS interval_field
+FROM t`,
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {
+ Name: "exists_field",
+ SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{
+ {Database: "db", Table: "t2", Column: "a"},
+ }),
+ IsPlainField: false,
+ },
+ {Name: "converted", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: false},
+ {Name: "collated", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: false},
+ {Name: "matched", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "b"}}), IsPlainField: false},
+ {Name: "row_field", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "b"}}), IsPlainField: false},
+ {Name: "member_field", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "c"}}), IsPlainField: false},
+ {Name: "interval_field", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "b"}}), IsPlainField: false},
+ }, span.Results)
+ })
+
+ t.Run("legacy_dml_roots_stay_dml", func(t *testing.T) {
+ tests := []string{
+ "CALL p()",
+ "DO 1",
+ "HANDLER t OPEN",
+ "HANDLER t READ FIRST",
+ "HANDLER t CLOSE",
+ }
+ for _, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, base.DML, span.Type, statement)
+ require.Empty(t, span.Results, statement)
+ }
+ })
+
+ t.Run("table_and_values_roots_return_select_results", func(t *testing.T) {
+ tableSpan, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "TABLE t")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, tableSpan.Type)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ }, tableSpan.Results)
+
+ valuesSpan, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "VALUES ROW(1, 2 + 3)")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, valuesSpan.Type)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "1", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ {Name: "2+3", SourceColumns: base.SourceColumnSet{}, IsPlainField: false},
+ }, valuesSpan.Results)
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch1_RootAndQueryTypeCoverage(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("select_family_roots", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ wantType base.QueryType
+ wantResults []base.QuerySpanResult
+ wantResources []base.ColumnResource
+ }{
+ {
+ name: "values_default",
+ statement: "VALUES ROW(DEFAULT)",
+ wantType: base.Select,
+ wantResults: []base.QuerySpanResult{
+ {Name: "DEFAULT", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ },
+ },
+ {
+ name: "explain_analyze_table",
+ statement: "EXPLAIN ANALYZE TABLE t",
+ wantType: base.Select,
+ wantResources: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "explain_analyze_values",
+ statement: "EXPLAIN ANALYZE VALUES ROW(1, 2 + 3)",
+ wantType: base.Select,
+ },
+ {
+ name: "explain_analyze_insert",
+ statement: "EXPLAIN ANALYZE INSERT INTO t VALUES(1, 2, 3)",
+ wantType: base.DML,
+ wantResources: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ }
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.wantType, span.Type)
+ require.Equal(t, tc.wantResults, span.Results)
+ require.Equal(t, sourceColumnSetFromResources(tc.wantResources), span.SourceColumns)
+ })
+ }
+ })
+
+ t.Run("multiple_statements_are_rejected", func(t *testing.T) {
+ _, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT 1; SELECT 2;")
+ require.ErrorContains(t, err, "expected exactly 1 statement")
+ })
+
+ t.Run("ddl_bucket_roots", func(t *testing.T) {
+ tests := []string{
+ "CREATE DATABASE d",
+ "CREATE VIEW v AS SELECT a FROM t",
+ "ALTER TABLE t ADD COLUMN d INT",
+ "DROP TABLE t",
+ "RENAME TABLE t TO t_new",
+ "TRUNCATE TABLE t",
+ }
+ for _, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, base.DDL, span.Type, statement)
+ require.Empty(t, span.Results, statement)
+ }
+ })
+
+ t.Run("dml_bucket_roots", func(t *testing.T) {
+ tests := []string{
+ "UPDATE t SET a = 1",
+ "DELETE FROM t WHERE a = 1",
+ "BEGIN",
+ "COMMIT",
+ "ROLLBACK",
+ "SAVEPOINT s",
+ "LOCK TABLES t READ",
+ "UNLOCK TABLES",
+ "PREPARE stmt FROM 'SELECT 1'",
+ "EXECUTE stmt",
+ "DEALLOCATE PREPARE stmt",
+ }
+ for _, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, base.DML, span.Type, statement)
+ require.Empty(t, span.Results, statement)
+ }
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch4_QueryTypeEdges(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("legacy_query_type_buckets", func(t *testing.T) {
+ tests := []struct {
+ statement string
+ want base.QueryType
+ }{
+ {statement: "SET PASSWORD = 'new_password'", want: base.QueryTypeUnknown},
+ {statement: "CREATE USER u IDENTIFIED BY 'p'", want: base.DDL},
+ {statement: "ALTER USER u IDENTIFIED BY 'p2'", want: base.DDL},
+ {statement: "DROP USER u", want: base.DDL},
+ {statement: "GRANT SELECT ON *.* TO u", want: base.DDL},
+ {statement: "REVOKE SELECT ON *.* FROM u", want: base.DDL},
+ {statement: "IMPORT TABLE FROM '/tmp/t.sdi'", want: base.DDL},
+ {statement: "REPLACE INTO t VALUES(1, 2, 3)", want: base.DML},
+ {statement: "LOAD DATA INFILE '/tmp/t.csv' INTO TABLE t", want: base.DML},
+ {statement: "CHANGE REPLICATION SOURCE TO SOURCE_HOST = '127.0.0.1'", want: base.DML},
+ {statement: "START REPLICA", want: base.DML},
+ {statement: "STOP REPLICA", want: base.DML},
+ {statement: "RESET REPLICA", want: base.DML},
+ {statement: "PURGE BINARY LOGS TO 'mysql-bin.010'", want: base.DML},
+ {statement: "RESET MASTER", want: base.DML},
+ {statement: "START GROUP_REPLICATION", want: base.DML},
+ {statement: "STOP GROUP_REPLICATION", want: base.DML},
+ {statement: "HELP 'contents'", want: base.QueryTypeUnknown},
+ }
+ for _, tc := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err, tc.statement)
+ require.Equal(t, tc.want, span.Type, tc.statement)
+ require.Empty(t, span.Results, tc.statement)
+ }
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch1_ExpressionCoverage(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("quoted_identifier_names", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT `select`, `Camel` AS `ExactCase` FROM keyword_table",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "select", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "keyword_table", Column: "select"}}), IsPlainField: true},
+ {Name: "ExactCase", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "keyword_table", Column: "Camel"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("variable_refs_have_empty_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT @x AS user_var, @@version AS system_var",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "user_var", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ {Name: "system_var", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("json_extract_operator_uses_object_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT product_info->'$.id' AS id FROM products",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "id", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: false},
+ }, span.Results)
+ })
+
+ t.Run("group_concat_separator_contributes_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT GROUP_CONCAT(a SEPARATOR b) AS gc FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "gc", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "b"}}), IsPlainField: false},
+ }, span.Results)
+ })
+
+ t.Run("group_concat_order_by_contributes_lineage", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT GROUP_CONCAT(a ORDER BY b) AS gc FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "gc", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t", Column: "b"}}), IsPlainField: false},
+ }, span.Results)
+ })
+
+ t.Run("duplicate_output_names_are_preserved", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT a AS x, b AS x FROM t",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ }, span.Results)
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch2_FromJoinAndScopeCoverage(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("table_source_variants", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ wantSrc []base.ColumnResource
+ }{
+ {
+ name: "database_qualified_table",
+ statement: "SELECT db.t.a FROM db.t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "parenthesized_single_table",
+ statement: "SELECT a FROM (t)",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "comma_separated_tables",
+ statement: "SELECT t1.a, t2.b FROM t1, t2",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "b"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{{Database: "db", Table: "t1"}, {Database: "db", Table: "t2"}},
+ },
+ {
+ name: "dual",
+ statement: "SELECT 1 FROM DUAL",
+ want: []base.QuerySpanResult{
+ {Name: "1", SourceColumns: base.SourceColumnSet{}, IsPlainField: true},
+ },
+ },
+ {
+ name: "dual_join_right",
+ statement: "SELECT t.a FROM t JOIN DUAL",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ {
+ name: "dual_join_left",
+ statement: "SELECT t.a FROM DUAL JOIN t",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{{Database: "db", Table: "t"}},
+ },
+ }
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ require.Equal(t, sourceColumnSetFromResources(tc.wantSrc), span.SourceColumns)
+ })
+ }
+ })
+
+ t.Run("join_variants_expose_columns", func(t *testing.T) {
+ tests := []string{
+ "SELECT * FROM t1 STRAIGHT_JOIN t2",
+ "SELECT * FROM t1 LEFT JOIN t2 ON t1.a = t2.a",
+ "SELECT * FROM t1 RIGHT JOIN t2 ON t1.a = t2.a",
+ "SELECT * FROM t1 NATURAL LEFT JOIN t2",
+ "SELECT * FROM t1 NATURAL RIGHT JOIN t2",
+ }
+ want := []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "c"}}), IsPlainField: true},
+ }
+ wantNonNatural := append([]base.QuerySpanResult{}, want...)
+ wantNonNatural = append(wantNonNatural,
+ base.QuerySpanResult{Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "a"}}), IsPlainField: true},
+ base.QuerySpanResult{Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "b"}}), IsPlainField: true},
+ base.QuerySpanResult{Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "c"}}), IsPlainField: true},
+ )
+ for i, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ if i < 3 {
+ require.Equal(t, wantNonNatural, span.Results, statement)
+ } else {
+ require.Equal(t, want, span.Results, statement)
+ }
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1"}, {Database: "db", Table: "t2"}}), span.SourceColumns, statement)
+ }
+ })
+
+ t.Run("derived_table_edges", func(t *testing.T) {
+ _, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT * FROM (SELECT a, b FROM t) AS x(c1)",
+ )
+ require.ErrorContains(t, err, "derived table column list length")
+
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT y.c1 FROM (SELECT x.c1 FROM (SELECT a FROM t) AS x(c1)) AS y",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "c1", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT x.a FROM t, LATERAL (SELECT t.a) AS x",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("join_dependency_edges", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ wantSrc []base.ColumnResource
+ }{
+ {
+ name: "join_on_subquery_contributes_access_table",
+ statement: "SELECT t1.a FROM t1 JOIN t2 ON EXISTS (SELECT t.a FROM t WHERE t.a = t2.a)",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{
+ {Database: "db", Table: "t1"},
+ {Database: "db", Table: "t2"},
+ {Database: "db", Table: "t"},
+ },
+ },
+ {
+ name: "nested_join_tree_preserves_visible_order",
+ statement: "SELECT * FROM t1 JOIN (t2 JOIN t ON t2.a = t.a) ON t1.a = t2.a",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "c"}}), IsPlainField: true},
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "c"}}), IsPlainField: true},
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ {Name: "c", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "c"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{
+ {Database: "db", Table: "t1"},
+ {Database: "db", Table: "t2"},
+ {Database: "db", Table: "t"},
+ },
+ },
+ {
+ name: "parenthesized_table_reference_list",
+ statement: "SELECT t1.a, t2.b FROM (t1, t2)",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "b"}}), IsPlainField: true},
+ },
+ wantSrc: []base.ColumnResource{
+ {Database: "db", Table: "t1"},
+ {Database: "db", Table: "t2"},
+ },
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ require.Equal(t, sourceColumnSetFromResources(tc.wantSrc), span.SourceColumns)
+ })
+ }
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch2_SubqueryCTEAndSetCoverage(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("subquery_access_locations", func(t *testing.T) {
+ tests := []string{
+ "SELECT a FROM t WHERE EXISTS (SELECT t2.a FROM t2)",
+ "SELECT a FROM t GROUP BY a HAVING EXISTS (SELECT t2.a FROM t2)",
+ "SELECT a FROM t ORDER BY (SELECT t2.a FROM t2)",
+ }
+ for _, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t"}, {Database: "db", Table: "t2"}}), span.SourceColumns, statement)
+ }
+ })
+
+ t.Run("cte_and_set_error_edges", func(t *testing.T) {
+ _, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "WITH c(x) AS (SELECT a, b FROM t) SELECT * FROM c",
+ )
+ require.ErrorContains(t, err, "CTE column list")
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "WITH RECURSIVE c(x) AS (SELECT a, b FROM t UNION SELECT a, b FROM t2) SELECT * FROM c",
+ )
+ require.ErrorContains(t, err, "different column counts")
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "SELECT a FROM t UNION SELECT a, b FROM t2",
+ )
+ require.ErrorContains(t, err, "UNION operator left has 1 fields, right has 2 fields")
+
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "WITH c1 AS (SELECT a FROM c2), c2 AS (SELECT a FROM t) SELECT * FROM c1",
+ )
+ require.NoError(t, err)
+ require.Empty(t, span.Results)
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+ })
+
+ t.Run("set_operation_in_derived_and_cte", func(t *testing.T) {
+ tests := []string{
+ "SELECT x.a FROM (SELECT a FROM t UNION SELECT a FROM t2) AS x",
+ "WITH c AS (SELECT a FROM t UNION SELECT a FROM t2) SELECT a FROM c",
+ }
+ for _, statement := range tests {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "a"}}), IsPlainField: true},
+ }, span.Results, statement)
+ }
+ })
+
+ t.Run("additional_set_operation_edges", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ }{
+ {
+ name: "intersect",
+ statement: "SELECT a FROM t INTERSECT SELECT a FROM t2",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "a"}}), IsPlainField: false},
+ },
+ },
+ {
+ name: "except",
+ statement: "SELECT a FROM t EXCEPT SELECT a FROM t2",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "a"}}), IsPlainField: false},
+ },
+ },
+ {
+ name: "parenthesized_grouping",
+ statement: "SELECT a FROM t UNION (SELECT a FROM t2 UNION SELECT b FROM t1)",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "a"}, {Database: "db", Table: "t1", Column: "b"}}), IsPlainField: false},
+ },
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ })
+ }
+ })
+
+ t.Run("scope_resolution_edges", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ want []base.QuerySpanResult
+ }{
+ {
+ name: "nested_subquery_nearest_scope_alias",
+ statement: "SELECT (SELECT x.a FROM t2 AS x WHERE x.b = outer_t.b) AS inner_a FROM t AS outer_t",
+ want: []base.QuerySpanResult{
+ {Name: "inner_a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "unqualified_inner_column_uses_legacy_resolution_order",
+ statement: "SELECT (SELECT a FROM t2) AS inner_a FROM t1",
+ want: []base.QuerySpanResult{
+ {Name: "inner_a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "inner_alias_shadow_keeps_legacy_outer_first_lookup",
+ statement: "SELECT (SELECT x.a FROM t2 AS x) AS inner_a FROM t1 AS x",
+ want: []base.QuerySpanResult{
+ {Name: "inner_a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t1", Column: "a"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "cte_name_shadows_physical_table",
+ statement: "WITH t AS (SELECT b FROM t2) SELECT * FROM t",
+ want: []base.QuerySpanResult{
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t2", Column: "b"}}), IsPlainField: true},
+ },
+ },
+ {
+ name: "nested_cte_visibility_order",
+ statement: "WITH c1 AS (SELECT a FROM t), c2 AS (SELECT a FROM c1 UNION SELECT b FROM t2) SELECT * FROM c2",
+ want: []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "b"}}), IsPlainField: false},
+ },
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.want, span.Results)
+ })
+ }
+ })
+
+ t.Run("recursive_cte_reaches_stable_source_closure", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "WITH RECURSIVE c(x) AS (SELECT a FROM t UNION SELECT t2.b FROM t2 JOIN c ON c.x = t2.a) SELECT * FROM c",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "b"}}), IsPlainField: false},
+ }, span.Results)
+ })
+
+ t.Run("recursive_cte_left_deep_set_op_registers_before_recursive_left_branch", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(
+ context.Background(),
+ "WITH RECURSIVE c(x) AS (SELECT a FROM t UNION SELECT t2.b FROM t2 JOIN c ON c.x = t2.a UNION SELECT t2.c FROM t2 JOIN c ON c.x = t2.b) SELECT * FROM c",
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "x", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}, {Database: "db", Table: "t2", Column: "b"}, {Database: "db", Table: "t2", Column: "c"}}), IsPlainField: false},
+ }, span.Results)
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch4_JSONTableCoverage(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(
+ context.Background(),
+ `SELECT *
+FROM products,
+JSON_TABLE(product_info, '$' COLUMNS (
+ product_id INT PATH '$.id',
+ NESTED PATH '$.variants[*]' COLUMNS (
+ variant_id INT PATH '$.id',
+ variant_name VARCHAR(50) PATH '$.name'
+ )
+)) AS jt`,
+ )
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "product_info", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ {Name: "product_id", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ {Name: "variant_id", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ {Name: "variant_name", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "products", Column: "product_info"}}), IsPlainField: true},
+ }, span.Results)
+
+ _, err = newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), false).getOmniQuerySpan(
+ context.Background(),
+ `SELECT *
+FROM products,
+JSON_TABLE(product_info, '$' COLUMNS (
+ product_id INT PATH '$.id'
+))`,
+ )
+ require.Error(t, err)
+}
+
+func TestOmniQuerySpanScenarioBatch4_AccessTableExpressions(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ tests := []struct {
+ name string
+ statement string
+ want []base.ColumnResource
+ }{
+ {
+ name: "function_argument_subquery",
+ statement: "SELECT COALESCE((SELECT t2.a FROM t2), a) FROM t",
+ want: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ {Database: "db", Table: "t2"},
+ },
+ },
+ {
+ name: "function_order_by_subquery",
+ statement: "SELECT GROUP_CONCAT(a ORDER BY (SELECT t2.b FROM t2)) FROM t",
+ want: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ {Database: "db", Table: "t2"},
+ },
+ },
+ {
+ name: "json_table_document_subquery",
+ statement: "SELECT * FROM JSON_TABLE((SELECT product_info FROM products), '$' COLUMNS (product_id INT PATH '$.id')) AS jt",
+ want: []base.ColumnResource{
+ {Database: "db", Table: "products"},
+ },
+ },
+ {
+ name: "values_subquery",
+ statement: "VALUES ROW((SELECT a FROM t))",
+ want: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ },
+ },
+ {
+ name: "set_assignment_subquery",
+ statement: "SET @x = (SELECT a FROM t)",
+ want: []base.ColumnResource{
+ {Database: "db", Table: "t"},
+ },
+ },
+ }
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, sourceColumnSetFromResources(tc.want), span.SourceColumns)
+ })
+ }
+}
+
+func TestOmniQuerySpanScenarioBatch3_ErrorAndMetadataCoverage(t *testing.T) {
+ t.Run("error_semantics", func(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ _, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT a INTO @x FROM t")
+ require.ErrorContains(t, err, "unsupported select statement with into")
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "TABLE t INTO @x")
+ require.ErrorContains(t, err, "unsupported table statement with into")
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT FROM")
+ require.Error(t, err)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT * FORM invalid_table;")
+ require.Error(t, err)
+
+ _, err = GetQuerySpan(context.Background(), gCtx, base.Statement{
+ Text: "SELECT * FORM invalid_table;",
+ Start: &storepb.Position{Line: 3, Column: 1},
+ }, "db", "", false)
+ var syntaxErr *base.SyntaxError
+ require.ErrorAs(t, err, &syntaxErr)
+ require.Equal(t, int32(3), syntaxErr.Position.Line)
+
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, span.Type)
+ require.Empty(t, span.Results)
+ require.Empty(t, span.SourceColumns)
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "EXPLAIN ANALYZE SELECT * FROM missing")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, span.Type)
+ require.Empty(t, span.Results)
+ require.Nil(t, span.NotFoundError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "INSERT INTO t SELECT * FROM mysql.user")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "CREATE TABLE new_t AS SELECT * FROM mysql.user")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "EXPLAIN SELECT * FROM t, mysql.user")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "CALL p((SELECT a FROM t), (SELECT user FROM mysql.user))")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SET @x = (SELECT a FROM t), @y = (SELECT user FROM mysql.user)")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "TABLE t ORDER BY (SELECT user FROM mysql.user)")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "TABLE t LIMIT (SELECT COUNT(*) FROM mysql.user)")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "LOCK TABLES t READ, mysql.user READ")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "DROP TABLE t, mysql.user")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+
+ _, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "RENAME TABLE t TO t_new, mysql.user TO mysql.user_new")
+ require.ErrorIs(t, err, base.MixUserSystemTablesError)
+ })
+
+ t.Run("view_lineage", func(t *testing.T) {
+ gCtx := newOmniViewTestQuerySpanContext()
+
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT * FROM v")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "va", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ {Name: "b", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "b"}}), IsPlainField: true},
+ }, span.Results)
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT * FROM v2")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "va", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("missing_view_dependency_fails_open", func(t *testing.T) {
+ gCtx := newOmniViewTestQuerySpanContext()
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT * FROM broken_v")
+ require.NoError(t, err)
+ require.Equal(t, base.Select, span.Type)
+ require.Empty(t, span.Results)
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+ })
+
+ t.Run("system_schema_detection", func(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ ignoreCaseSensitive bool
+ wantType base.QueryType
+ wantSource []base.ColumnResource
+ wantNotFound bool
+ }{
+ {
+ name: "information_schema_lowercase",
+ statement: "SELECT * FROM information_schema.tables",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "information_schema_uppercase_ignore_case",
+ statement: "SELECT * FROM INFORMATION_SCHEMA.tables",
+ ignoreCaseSensitive: true,
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "information_schema_uppercase_case_sensitive",
+ statement: "SELECT * FROM INFORMATION_SCHEMA.tables",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "performance_schema_lowercase",
+ statement: "SELECT * FROM performance_schema.events_statements_current",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "mysql_lowercase",
+ statement: "SELECT * FROM mysql.user",
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "mysql_uppercase_ignore_case",
+ statement: "SELECT * FROM MYSQL.user",
+ ignoreCaseSensitive: true,
+ wantType: base.SelectInfoSchema,
+ },
+ {
+ name: "mysql_uppercase_case_sensitive",
+ statement: "SELECT * FROM MYSQL.user",
+ wantType: base.Select,
+ wantNotFound: true,
+ wantSource: []base.ColumnResource{
+ {Database: "MYSQL", Table: "user"},
+ },
+ },
+ }
+
+ for _, tc := range tests {
+ t.Run(tc.name, func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", newOmniTestQuerySpanContext(), tc.ignoreCaseSensitive).getOmniQuerySpan(context.Background(), tc.statement)
+ require.NoError(t, err)
+ require.Equal(t, tc.wantType, span.Type)
+ require.Equal(t, sourceColumnSetFromResources(tc.wantSource), span.SourceColumns)
+ if tc.wantNotFound {
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+ } else {
+ require.NoError(t, span.NotFoundError)
+ }
+ })
+ }
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch4_CaseSensitivityCoverage(t *testing.T) {
+ gCtx := newOmniTestQuerySpanContext()
+
+ t.Run("table_alias_case_sensitivity", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT X.a FROM t AS x")
+ require.NoError(t, err)
+ require.Empty(t, span.Results)
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, true).getOmniQuerySpan(context.Background(), "SELECT X.a FROM t AS x")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("derived_table_alias_case_sensitivity", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT X.a FROM (SELECT a FROM t) AS x")
+ require.NoError(t, err)
+ require.Empty(t, span.Results)
+ require.ErrorAs(t, span.NotFoundError, new(*base.ResourceNotFoundError))
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, true).getOmniQuerySpan(context.Background(), "SELECT X.a FROM (SELECT a FROM t) AS x")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+
+ t.Run("cte_name_case_sensitivity", func(t *testing.T) {
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "WITH c AS (SELECT a FROM t) SELECT C.a FROM c AS C")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ })
+}
+
+func TestOmniQuerySpanScenarioBatch5_MetadataCoverage(t *testing.T) {
+ t.Run("duplicate_database_case_uses_ignore_case_setting", func(t *testing.T) {
+ gCtx := newOmniCaseCollisionTestQuerySpanContext()
+
+ span, err := newOmniQuerySpanExtractor("db", gCtx, false).getOmniQuerySpan(context.Background(), "SELECT DB.t.a FROM DB.t")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "DB", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "DB", Table: "t"}}), span.SourceColumns)
+
+ span, err = newOmniQuerySpanExtractor("db", gCtx, true).getOmniQuerySpan(context.Background(), "SELECT DB.t.a FROM DB.t")
+ require.NoError(t, err)
+ require.Equal(t, []base.QuerySpanResult{
+ {Name: "a", SourceColumns: sourceColumnSetFromResources([]base.ColumnResource{{Database: "db", Table: "t", Column: "a"}}), IsPlainField: true},
+ }, span.Results)
+ require.Equal(t, sourceColumnSetFromResources([]base.ColumnResource{{Database: "DB", Table: "t"}}), span.SourceColumns)
+ })
+}
+
+func sourceColumnSetFromResources(resources []base.ColumnResource) base.SourceColumnSet {
+ result := make(base.SourceColumnSet)
+ for _, resource := range resources {
+ result[resource] = true
+ }
+ return result
+}
+
+func newOmniViewTestQuerySpanContext() base.GetQuerySpanContext {
+ metadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: "db",
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Tables: []*metadatapb.TableMetadata{
+ {
+ Name: "t",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ {Name: "b"},
+ },
+ },
+ },
+ Views: []*metadatapb.ViewMetadata{
+ {
+ Name: "v",
+ Definition: "SELECT a AS va, b FROM t",
+ },
+ {
+ Name: "v2",
+ Definition: "SELECT va FROM v",
+ },
+ {
+ Name: "broken_v",
+ Definition: "SELECT missing FROM t",
+ },
+ },
+ },
+ },
+ }
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+ return base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: storepb.Engine_OCEANBASE,
+ }
+}
+
+func newOmniTestQuerySpanContext() base.GetQuerySpanContext {
+ metadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: "db",
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Tables: []*metadatapb.TableMetadata{
+ {
+ Name: "t",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ {Name: "b"},
+ {Name: "c"},
+ },
+ },
+ {
+ Name: "t1",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ {Name: "b"},
+ {Name: "c"},
+ },
+ },
+ {
+ Name: "t2",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ {Name: "b"},
+ {Name: "c"},
+ },
+ },
+ {
+ Name: "galleries",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "id"},
+ {Name: "city"},
+ },
+ },
+ {
+ Name: "paintings",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "id"},
+ {Name: "gallery_id"},
+ },
+ },
+ {
+ Name: "products",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "product_info"},
+ },
+ },
+ {
+ Name: "keyword_table",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "select"},
+ {Name: "Camel"},
+ },
+ },
+ },
+ },
+ },
+ }
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+ return base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: storepb.Engine_OCEANBASE,
+ }
+}
+
+func newOmniCaseCollisionTestQuerySpanContext() base.GetQuerySpanContext {
+ dbMetadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: "db",
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Tables: []*metadatapb.TableMetadata{
+ {
+ Name: "t",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ },
+ },
+ },
+ },
+ },
+ }
+ upperMetadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: "DB",
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Tables: []*metadatapb.TableMetadata{
+ {
+ Name: "t",
+ Columns: []*metadatapb.ColumnMetadata{
+ {Name: "a"},
+ },
+ },
+ },
+ },
+ },
+ }
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{dbMetadata, upperMetadata})
+ return base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: storepb.Engine_OCEANBASE,
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/query_span_parity_test.go b/backend/plugin/parser/oceanbase/query_span_parity_test.go
new file mode 100644
index 0000000000..db7f5a7bd5
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span_parity_test.go
@@ -0,0 +1,128 @@
+package oceanbase
+
+import (
+ "context"
+ "fmt"
+ "io"
+ "os"
+ "reflect"
+ "strings"
+ "testing"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/stretchr/testify/require"
+ "gopkg.in/yaml.v3"
+
+ "github.com/bytebase/bytebase/backend/common"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+// TestOmniQuerySpanGoldenHarness is the strict cutover guard. It compares
+// the package-internal omni path against the existing YAML corpus instead of
+// comparing GetQuerySpan to itself after the production cutover.
+func TestOmniQuerySpanGoldenHarness(t *testing.T) {
+ type testCase struct {
+ Description string `yaml:"description,omitempty"`
+ Statement string `yaml:"statement,omitempty"`
+ DefaultDatabase string `yaml:"defaultDatabase,omitempty"`
+ IgnoreCaseSensitve bool `yaml:"ignoreCaseSensitive,omitempty"`
+ Metadata string `yaml:"metadata,omitempty"`
+ QuerySpan *base.YamlQuerySpan `yaml:"querySpan,omitempty"`
+ }
+
+ type diff struct {
+ fixture string
+ index int
+ description string
+ statement string
+ details string
+ }
+
+ var diffs []diff
+ total := 0
+ for _, testDataPath := range mysqlOmniProbeFixturePaths {
+ engine := storepb.Engine_OCEANBASE
+
+ yamlFile, err := os.Open(testDataPath)
+ if err != nil {
+ t.Fatalf("open %s: %v", testDataPath, err)
+ }
+ byteValue, err := io.ReadAll(yamlFile)
+ if closeErr := yamlFile.Close(); closeErr != nil && err == nil {
+ err = closeErr
+ }
+ if err != nil {
+ t.Fatalf("read %s: %v", testDataPath, err)
+ }
+
+ var testCases []testCase
+ if err := yaml.Unmarshal(byteValue, &testCases); err != nil {
+ t.Fatalf("yaml %s: %v", testDataPath, err)
+ }
+
+ for i, tc := range testCases {
+ if strings.TrimSpace(tc.Statement) == "" {
+ continue
+ }
+ total++
+
+ omni, err := runMySQLOmniGoldenCase(context.Background(), tc.Statement, tc.Metadata, tc.DefaultDatabase, engine, tc.IgnoreCaseSensitve)
+ if err != nil {
+ diffs = append(diffs, diff{
+ fixture: testDataPath,
+ index: i,
+ description: tc.Description,
+ statement: tc.Statement,
+ details: err.Error(),
+ })
+ continue
+ }
+ if !reflect.DeepEqual(tc.QuerySpan, omni) {
+ diffs = append(diffs, diff{
+ fixture: testDataPath,
+ index: i,
+ description: tc.Description,
+ statement: tc.Statement,
+ details: fmt.Sprintf("want=%+v omni=%+v", tc.QuerySpan, omni),
+ })
+ }
+ }
+ }
+
+ t.Logf("MySQL omni query-span golden: %d/%d matched, %d diffs", total-len(diffs), total, len(diffs))
+ for i, d := range diffs {
+ if i >= 10 {
+ t.Logf("... %d more diffs omitted", len(diffs)-i)
+ break
+ }
+ t.Logf("[%s case %d %q] %s\n SQL: %s", d.fixture, d.index, d.description, d.details, firstMySQLOmniProbeLine(d.statement))
+ }
+ require.Empty(t, diffs)
+}
+
+func runMySQLOmniGoldenCase(
+ ctx context.Context,
+ statement string,
+ metadataText string,
+ defaultDatabase string,
+ engine storepb.Engine,
+ ignoreCaseSensitive bool,
+) (*base.YamlQuerySpan, error) {
+ metadata := &metadatapb.DatabaseSchemaMetadata{}
+ if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(metadataText), metadata); err != nil {
+ return nil, err
+ }
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+ gCtx := base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: engine,
+ }
+
+ omni, err := newOmniQuerySpanExtractor(defaultDatabase, gCtx, ignoreCaseSensitive).getOmniQuerySpan(ctx, statement)
+ if err != nil {
+ return nil, err
+ }
+ return omni.ToYaml(), nil
+}
diff --git a/backend/plugin/parser/oceanbase/query_span_probe_test.go b/backend/plugin/parser/oceanbase/query_span_probe_test.go
new file mode 100644
index 0000000000..feda22e77e
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span_probe_test.go
@@ -0,0 +1,259 @@
+package oceanbase
+
+import (
+ "errors"
+ "io"
+ "os"
+ "slices"
+ "strings"
+ "testing"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/stretchr/testify/require"
+ "gopkg.in/yaml.v3"
+)
+
+// TestOmniQuerySpanMigrationProbe verifies that omni can parse and expose
+// the AST shapes the MySQL query-span migration will rely on. It does not use
+// or change the production query-span path.
+func TestOmniQuerySpanMigrationProbe(t *testing.T) {
+ t.Run("FixtureParseCoverage", probeMySQLOmniFixtureParseCoverage)
+ t.Run("StructuralInvariants", probeMySQLOmniStructuralInvariants)
+}
+
+type mysqlOmniProbeFixtureEntry struct {
+ Description string `yaml:"description"`
+ Statement string `yaml:"statement"`
+}
+
+var mysqlOmniProbeFixturePaths = []string{
+ "test-data/query-span/query_type.yaml",
+ "test-data/query-span/standard.yaml",
+ "test-data/query-span/case_insensitive.yaml",
+}
+
+func probeMySQLOmniFixtureParseCoverage(t *testing.T) {
+ type failure struct {
+ fixture string
+ index int
+ statement string
+ err error
+ }
+
+ totals := map[string][2]int{} // fixture -> [total, passed]
+ var failures []failure
+ for _, path := range mysqlOmniProbeFixturePaths {
+ f, err := os.Open(path)
+ require.NoError(t, err)
+ data, err := io.ReadAll(f)
+ require.NoError(t, err)
+ require.NoError(t, f.Close())
+
+ var entries []mysqlOmniProbeFixtureEntry
+ require.NoError(t, yaml.Unmarshal(data, &entries))
+
+ total := 0
+ passed := 0
+ for i, entry := range entries {
+ if strings.TrimSpace(entry.Statement) == "" {
+ continue
+ }
+ total++
+ list, err := ParseOceanBase(entry.Statement)
+ if err != nil {
+ failures = append(failures, failure{
+ fixture: path,
+ index: i,
+ statement: entry.Statement,
+ err: err,
+ })
+ continue
+ }
+ if list == nil || list.Len() == 0 {
+ failures = append(failures, failure{
+ fixture: path,
+ index: i,
+ statement: entry.Statement,
+ err: errEmptyOmniStatement,
+ })
+ continue
+ }
+ passed++
+ }
+ totals[path] = [2]int{total, passed}
+ }
+
+ t.Log("=== MySQL omni parse coverage per fixture ===")
+ var keys []string
+ for k := range totals {
+ keys = append(keys, k)
+ }
+ slices.Sort(keys)
+ totalAll, passedAll := 0, 0
+ for _, k := range keys {
+ v := totals[k]
+ totalAll += v[0]
+ passedAll += v[1]
+ t.Logf(" %s: %d/%d", k, v[1], v[0])
+ }
+ t.Logf(" TOTAL: %d/%d", passedAll, totalAll)
+
+ if len(failures) > 0 {
+ t.Logf("=== %d parse failures ===", len(failures))
+ for _, f := range failures {
+ t.Logf(" [%s case %d] err: %v\n SQL: %s", f.fixture, f.index, f.err, firstMySQLOmniProbeLine(f.statement))
+ }
+ t.Errorf("omni failed to parse %d/%d fixture statements", len(failures), totalAll)
+ }
+}
+
+var errEmptyOmniStatement = errors.New("omni returned no statements")
+
+func firstMySQLOmniProbeLine(s string) string {
+ s = strings.TrimSpace(s)
+ if i := strings.IndexByte(s, '\n'); i >= 0 {
+ return s[:i] + " ..."
+ }
+ return s
+}
+
+func probeMySQLOmniStructuralInvariants(t *testing.T) {
+ t.Run("select_targets_aliases_and_stars", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "SELECT a, b AS alias_b, db.t.c, t.* FROM db.t AS t")
+ require.Len(t, sel.TargetList, 4)
+
+ first := mustMySQLOmniTargetColumn(t, sel.TargetList[0])
+ require.Equal(t, "a", first.Column)
+ require.Empty(t, first.Table)
+ require.False(t, first.Star)
+
+ aliasTarget, ok := sel.TargetList[1].(*ast.ResTarget)
+ require.Truef(t, ok, "second target is %T", sel.TargetList[1])
+ require.Equal(t, "alias_b", aliasTarget.Name)
+ aliasColumn, ok := aliasTarget.Val.(*ast.ColumnRef)
+ require.Truef(t, ok, "alias target value is %T", aliasTarget.Val)
+ require.Equal(t, "b", aliasColumn.Column)
+
+ qualified := mustMySQLOmniTargetColumn(t, sel.TargetList[2])
+ require.Equal(t, "db", qualified.Schema)
+ require.Equal(t, "t", qualified.Table)
+ require.Equal(t, "c", qualified.Column)
+
+ tableStar := mustMySQLOmniTargetColumn(t, sel.TargetList[3])
+ require.Equal(t, "t", tableStar.Table)
+ require.True(t, tableStar.Star)
+ })
+
+ t.Run("join_on_and_using", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "SELECT * FROM t1 JOIN db.t2 AS t2 ON t1.a = t2.a JOIN t3 USING (id)")
+ require.Len(t, sel.From, 1)
+ require.Len(t, collectMySQLOmniNodes[*ast.TableRef](sel), 3)
+ require.NotEmpty(t, collectMySQLOmniNodes[*ast.OnCondition](sel))
+ using := collectMySQLOmniNodes[*ast.UsingCondition](sel)
+ require.Len(t, using, 1)
+ require.Equal(t, []string{"id"}, using[0].Columns)
+ })
+
+ t.Run("derived_table_alias_and_column_aliases", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "SELECT x.c1 FROM (SELECT a, b FROM t) AS x(c1, c2)")
+ require.Len(t, sel.From, 1)
+ subquery, ok := sel.From[0].(*ast.SubqueryExpr)
+ require.Truef(t, ok, "from item is %T", sel.From[0])
+ require.Equal(t, "x", subquery.Alias)
+ require.Equal(t, []string{"c1", "c2"}, subquery.Columns)
+ require.NotNil(t, subquery.Select)
+ })
+
+ t.Run("recursive_cte_with_set_operation", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "WITH RECURSIVE cte(a, b) AS (SELECT a, b FROM t UNION SELECT a, b FROM t2) SELECT * FROM cte")
+ require.Len(t, sel.CTEs, 1)
+ cte := sel.CTEs[0]
+ require.Equal(t, "cte", cte.Name)
+ require.True(t, cte.Recursive)
+ require.Equal(t, []string{"a", "b"}, cte.Columns)
+ require.NotNil(t, cte.Select)
+ require.Equal(t, ast.SetOpUnion, cte.Select.SetOp)
+ require.NotNil(t, cte.Select.Left)
+ require.NotNil(t, cte.Select.Right)
+ })
+
+ t.Run("correlated_scalar_subquery", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "SELECT city, (SELECT COUNT(*) FROM paintings p WHERE g.id = p.gallery_id) AS total FROM galleries g")
+ require.Len(t, sel.TargetList, 2)
+ subqueries := collectMySQLOmniNodes[*ast.SubqueryExpr](sel)
+ require.Len(t, subqueries, 1)
+ require.NotNil(t, subqueries[0].Select)
+
+ var sawOuterRef, sawInnerRef bool
+ for _, col := range collectMySQLOmniNodes[*ast.ColumnRef](sel) {
+ if col.Table == "g" && col.Column == "id" {
+ sawOuterRef = true
+ }
+ if col.Table == "p" && col.Column == "gallery_id" {
+ sawInnerRef = true
+ }
+ }
+ require.True(t, sawOuterRef, "expected correlated outer column g.id")
+ require.True(t, sawInnerRef, "expected inner column p.gallery_id")
+ })
+
+ t.Run("json_table_table_source", func(t *testing.T) {
+ sel := mustMySQLOmniSelect(t, "SELECT jt.id FROM t, JSON_TABLE(t.doc, '$[*]' COLUMNS(id INT PATH '$.id')) AS jt")
+ jsonTables := collectMySQLOmniNodes[*ast.JsonTableExpr](sel)
+ require.Len(t, jsonTables, 1)
+ require.Equal(t, "jt", jsonTables[0].Alias)
+ require.Len(t, jsonTables[0].Columns, 1)
+ require.Equal(t, "id", jsonTables[0].Columns[0].Name)
+ })
+
+ t.Run("query_type_statement_roots", func(t *testing.T) {
+ require.IsType(t, &ast.ExplainStmt{}, mustMySQLOmniNode(t, "EXPLAIN ANALYZE SELECT * FROM t"))
+ require.IsType(t, &ast.ShowStmt{}, mustMySQLOmniNode(t, "SHOW DATABASES"))
+ require.IsType(t, &ast.SetStmt{}, mustMySQLOmniNode(t, "SET CHARSET DEFAULT"))
+ require.IsType(t, &ast.CreateTableStmt{}, mustMySQLOmniNode(t, "CREATE TABLE t(a INT)"))
+ require.IsType(t, &ast.InsertStmt{}, mustMySQLOmniNode(t, "INSERT INTO t VALUES(1)"))
+ })
+}
+
+func mustMySQLOmniNode(t *testing.T, sql string) ast.Node {
+ t.Helper()
+ list, err := ParseOceanBase(sql)
+ require.NoError(t, err)
+ require.NotNil(t, list)
+ require.Len(t, list.Items, 1)
+ require.NotNil(t, list.Items[0])
+ return list.Items[0]
+}
+
+func mustMySQLOmniSelect(t *testing.T, sql string) *ast.SelectStmt {
+ t.Helper()
+ sel, ok := mustMySQLOmniNode(t, sql).(*ast.SelectStmt)
+ require.Truef(t, ok, "statement is not *ast.SelectStmt: %s", sql)
+ return sel
+}
+
+func mustMySQLOmniTargetColumn(t *testing.T, target ast.ExprNode) *ast.ColumnRef {
+ t.Helper()
+ switch v := target.(type) {
+ case *ast.ColumnRef:
+ return v
+ case *ast.ResTarget:
+ col, ok := v.Val.(*ast.ColumnRef)
+ require.Truef(t, ok, "target value is %T", v.Val)
+ return col
+ default:
+ t.Fatalf("target is %T", target)
+ return nil
+ }
+}
+
+func collectMySQLOmniNodes[T ast.Node](root ast.Node) []T {
+ var nodes []T
+ ast.Inspect(root, func(n ast.Node) bool {
+ if typed, ok := n.(T); ok {
+ nodes = append(nodes, typed)
+ }
+ return true
+ })
+ return nodes
+}
diff --git a/backend/plugin/parser/oceanbase/query_span_test.go b/backend/plugin/parser/oceanbase/query_span_test.go
new file mode 100644
index 0000000000..f35648a0bd
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_span_test.go
@@ -0,0 +1,184 @@
+package oceanbase
+
+import (
+ "context"
+ "io"
+ "os"
+ "testing"
+
+ metadatapb "github.com/bytebase/omni/metadata"
+ "github.com/pkg/errors"
+ "github.com/stretchr/testify/require"
+ "gopkg.in/yaml.v3"
+
+ "github.com/bytebase/bytebase/backend/common"
+ "github.com/bytebase/bytebase/backend/common/yamltest"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+func TestGetQuerySpan(t *testing.T) {
+ type testCase struct {
+ Description string `yaml:"description,omitempty"`
+ Statement string `yaml:"statement,omitempty"`
+ DefaultDatabase string `yaml:"defaultDatabase,omitempty"`
+ IgnoreCaseSensitve bool `yaml:"ignoreCaseSensitive,omitempty"`
+ // Metadata is the protojson encoded metadatapb.DatabaseSchemaMetadata,
+ // if it's empty, we will use the defaultDatabaseMetadata.
+ Metadata string `yaml:"metadata,omitempty"`
+ QuerySpan *base.YamlQuerySpan `yaml:"querySpan,omitempty"`
+ }
+
+ var (
+ record = false
+ testDataPaths = []string{
+ "test-data/query-span/query_type.yaml",
+ "test-data/query-span/standard.yaml",
+ "test-data/query-span/case_insensitive.yaml",
+ }
+ )
+
+ a := require.New(t)
+ for _, testDataPath := range testDataPaths {
+ engine := storepb.Engine_OCEANBASE
+
+ testDataPath := testDataPath
+
+ yamlFile, err := os.Open(testDataPath)
+ a.NoError(err)
+
+ var testCases []testCase
+ byteValue, err := io.ReadAll(yamlFile)
+ a.NoError(err)
+ a.NoError(yamlFile.Close())
+ a.NoError(yaml.Unmarshal(byteValue, &testCases))
+
+ for i, tc := range testCases {
+ metadata := &metadatapb.DatabaseSchemaMetadata{}
+ a.NoErrorf(common.ProtojsonUnmarshaler.Unmarshal([]byte(tc.Metadata), metadata), "cases %d", i+1)
+ databaseMetadataGetter, databaseNameLister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+ result, err := GetQuerySpan(context.TODO(), base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: databaseMetadataGetter,
+ ListDatabaseNamesFunc: databaseNameLister,
+ Engine: engine,
+ }, base.Statement{Text: tc.Statement}, tc.DefaultDatabase, "", tc.IgnoreCaseSensitve)
+ a.NoErrorf(err, "statement: %s", tc.Statement)
+ resultYaml := result.ToYaml()
+ if record {
+ testCases[i].QuerySpan = resultYaml
+ } else {
+ a.Equalf(tc.QuerySpan, resultYaml, "statement: %s", tc.Statement)
+ }
+ }
+
+ if record {
+ yamltest.Record(t, testDataPath, testCases)
+ }
+ }
+}
+
+func buildMockDatabaseMetadataGetter(databaseMetadata []*metadatapb.DatabaseSchemaMetadata) (base.GetDatabaseMetadataFunc, base.ListDatabaseNamesFunc) {
+ return func(_ context.Context, _, databaseName string) (string, *model.DatabaseMetadata, error) {
+ m := make(map[string]*model.DatabaseMetadata)
+ for _, metadata := range databaseMetadata {
+ m[metadata.Name] = model.NewDatabaseMetadata(metadata, nil, nil, storepb.Engine_OCEANBASE, true /* isObjectCaseSensitive */)
+ }
+
+ if databaseMetadata, ok := m[databaseName]; ok {
+ return "", databaseMetadata, nil
+ }
+
+ return "", nil, errors.Errorf("database %q not found", databaseName)
+ }, func(_ context.Context, _ string) ([]string, error) {
+ var names []string
+ for _, metadata := range databaseMetadata {
+ names = append(names, metadata.Name)
+ }
+ return names, nil
+ }
+}
+
+func TestGetQuerySpanCyclicViewReference(t *testing.T) {
+ metadata := &metadatapb.DatabaseSchemaMetadata{
+ Name: "db",
+ Schemas: []*metadatapb.SchemaMetadata{
+ {
+ Name: "",
+ Views: []*metadatapb.ViewMetadata{
+ {Name: "v1", Definition: "SELECT * FROM v2"},
+ {Name: "v2", Definition: "SELECT * FROM v1"},
+ },
+ },
+ },
+ }
+ getter, lister := buildMockDatabaseMetadataGetter([]*metadatapb.DatabaseSchemaMetadata{metadata})
+
+ _, err := GetQuerySpan(context.Background(), base.GetQuerySpanContext{
+ GetDatabaseMetadataFunc: getter,
+ ListDatabaseNamesFunc: lister,
+ Engine: storepb.Engine_OCEANBASE,
+ }, base.Statement{Text: "SELECT * FROM v1"}, "db", "", false)
+ require.Error(t, err)
+ require.ErrorContains(t, err, "cyclic view reference")
+}
+
+func TestExtractTableRefs(t *testing.T) {
+ tests := []struct {
+ statement string
+ expected []base.SchemaResource
+ }{
+ {
+ statement: "SELECT * FROM t1 WHERE c1 = 1;",
+ expected: []base.SchemaResource{
+ {
+ Database: "db",
+ Table: "t1",
+ },
+ },
+ },
+ {
+ statement: "SELECT * FROM db1.t1 JOIN db2.t2 ON t1.c1 = t2.c1;",
+ expected: []base.SchemaResource{
+ {
+ Database: "db1",
+ Table: "t1",
+ },
+ {
+ Database: "db2",
+ Table: "t2",
+ },
+ },
+ },
+ {
+ statement: "SELECT a > (select max(a) from t1) FROM t2;",
+ expected: []base.SchemaResource{
+ {
+ Database: "db",
+ Table: "t1",
+ },
+ {
+ Database: "db",
+ Table: "t2",
+ },
+ },
+ },
+ }
+
+ for _, test := range tests {
+ parseResult, err := ParseOceanBase(test.statement)
+ require.NoError(t, err, "failed to parse statement: %s", test.statement)
+ require.Len(t, parseResult.Items, 1, "expected one parse result for statement: %s", test.statement)
+
+ sourceColumns := collectOmniAccessTables(parseResult.Items[0], "db")
+ var resources []base.SchemaResource
+ for resource := range sourceColumns {
+ resources = append(resources, base.SchemaResource{
+ Database: resource.Database,
+ Schema: resource.Schema,
+ Table: resource.Table,
+ })
+ }
+ require.ElementsMatch(t, test.expected, resources, test.statement)
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/query_test.go b/backend/plugin/parser/oceanbase/query_test.go
new file mode 100644
index 0000000000..2b3c2f504c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/query_test.go
@@ -0,0 +1,142 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestValidateSQLForEditor(t *testing.T) {
+ tests := []struct {
+ statement string
+ valid bool
+ gotAllQuery bool
+ err bool
+ }{
+ {
+ statement: "SHOW CREATE TABLE bytebase;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: "DESC bytebase;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: "SELECT * FROM t1 WHERE c1 = 1; SELECT * FROM t2;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: "CREATE TABLE t1 (c1 INT);",
+ valid: false,
+ gotAllQuery: false,
+ },
+ {
+ statement: "UPDATE t1 SET c1 = 1;",
+ valid: false,
+ gotAllQuery: false,
+ },
+ {
+ statement: "EXPLAIN SELECT * FROM t1;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: "EXPLAIN FORMAT=JSON DELETE FROM t1;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: `select* from t`,
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: `explain select * from t;`,
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: `explain analyze select * from t`,
+ valid: false,
+ gotAllQuery: true,
+ },
+ {
+ statement: `explain analyze update t set a = 5`,
+ valid: false,
+ gotAllQuery: true,
+ },
+ {
+ statement: `
+ With t as (
+ select * from t1
+ ), tx as (
+ select * from t1
+ )
+ update t set a = 1;
+ `,
+ valid: false,
+ gotAllQuery: false,
+ },
+ {
+ statement: `
+ With t as (
+ select * from t1
+ ), tx as (
+ select * from t1
+ )
+ insert into t values (1, 2, 3);
+ `,
+ valid: false,
+ gotAllQuery: false,
+ },
+ {
+ statement: "select * from t where a = 'klasjdfkljsa$tag$; -- lkjdlkfajslkdfj'",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: `
+ With t as (
+ select * from t1 where a = 'insert'
+ ), tx as (` +
+ " select * from `delete`" +
+ `) /* UPDATE */` +
+ "select `update` from t;",
+ valid: true,
+ gotAllQuery: true,
+ },
+ {
+ statement: `create table t (a int);`,
+ valid: false,
+ gotAllQuery: false,
+ },
+ {
+ statement: `SET max_execution_time = 1000; select * from t`,
+ valid: true,
+ gotAllQuery: false,
+ },
+ {
+ statement: "SELECT * FORM invalid_table;",
+ err: true,
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.statement, func(t *testing.T) {
+ gotValid, gotAllQuery, err := validateQuery(test.statement)
+ if test.err {
+ require.Error(t, err)
+ require.ErrorAs(t, err, new(*base.SyntaxError))
+ } else {
+ require.NoError(t, err)
+ require.Equal(t, test.valid, gotValid, test.statement)
+ require.Equal(t, test.gotAllQuery, gotAllQuery, test.statement)
+ }
+ })
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/resource_change.go b/backend/plugin/parser/oceanbase/resource_change.go
new file mode 100644
index 0000000000..74b3fe6b90
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/resource_change.go
@@ -0,0 +1,212 @@
+package oceanbase
+
+import (
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+func init() {
+ base.RegisterExtractChangedResourcesFunc(storepb.Engine_OCEANBASE, extractChangedResources)
+}
+
+func extractChangedResources(currentDatabase string, _ string, dbMetadata *model.DatabaseMetadata, asts []base.AST, _ string) (*base.ChangeSummary, error) {
+ changedResources := model.NewChangedResources(dbMetadata)
+
+ var dmlCount, insertCount, skippedStatements int
+ var dmlStatements []string
+
+ // addObjectDatabase records a database-only write target for a non-table object DDL
+ // (view/function/routine/trigger) ONLY when the object's own name carries an explicit
+ // database qualifier (TableRef.Schema). Unqualified names record nothing (request-database
+ // fallback). The object's own qualifier is used — never an ON-table reference. SUP-222.
+ addObjectDatabase := func(ref *ast.TableRef) {
+ if ref != nil && ref.Schema != "" {
+ changedResources.AddDatabase(ref.Schema)
+ }
+ }
+
+ for _, unifiedAST := range asts {
+ omniAST, ok := unifiedAST.(*OmniAST)
+ if !ok {
+ return nil, errors.New("expected OmniAST for MySQL")
+ }
+ if omniAST.Node == nil {
+ continue
+ }
+
+ switch n := omniAST.Node.(type) {
+ case *ast.CreateTableStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+
+ case *ast.DropTableStmt:
+ for _, ref := range n.Tables {
+ db, table := omniTableRef(ref, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, true)
+ }
+
+ case *ast.TruncateStmt:
+ for _, ref := range n.Tables {
+ db, table := omniTableRef(ref, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, true)
+ }
+
+ case *ast.LoadDataStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+
+ case *ast.AlterTableStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, true)
+ }
+
+ case *ast.RenameTableStmt:
+ for _, pair := range n.Pairs {
+ if pair.Old != nil {
+ db, table := omniTableRef(pair.Old, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+ if pair.New != nil {
+ db, table := omniTableRef(pair.New, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+ }
+
+ case *ast.CreateIndexStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+
+ case *ast.DropIndexStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+
+ case *ast.InsertStmt:
+ if n.Table != nil {
+ db, table := omniTableRef(n.Table, currentDatabase)
+ changedResources.AddTable(db, "", &storepb.ChangedResourceTable{Name: table}, false)
+ }
+ if len(n.Values) > 0 {
+ insertCount += len(n.Values)
+ continue
+ }
+ // INSERT ... SET inserts exactly one row, and EXPLAIN gives no estimate for it.
+ if len(n.SetList) > 0 {
+ insertCount++
+ continue
+ }
+ dmlCount++
+ dmlStatements = append(dmlStatements, omniStatementText(omniAST))
+
+ case *ast.UpdateStmt:
+ for _, resource := range extractTableExprs(n.Tables, currentDatabase) {
+ changedResources.AddTable(resource.Database, "", &storepb.ChangedResourceTable{Name: resource.Table}, false)
+ }
+ dmlCount++
+ dmlStatements = append(dmlStatements, omniStatementText(omniAST))
+
+ case *ast.DeleteStmt:
+ for _, resource := range extractTableExprs(n.Tables, currentDatabase) {
+ changedResources.AddTable(resource.Database, "", &storepb.ChangedResourceTable{Name: resource.Table}, false)
+ }
+ for _, resource := range extractTableExprs(n.Using, currentDatabase) {
+ changedResources.AddTable(resource.Database, "", &storepb.ChangedResourceTable{Name: resource.Table}, false)
+ }
+ dmlCount++
+ dmlStatements = append(dmlStatements, omniStatementText(omniAST))
+
+ // Non-table object DDL: gate by the object's own explicit database qualifier only.
+ // CREATE TRIGGER is intentionally skipped — its AST name is unqualified (a bare string);
+ // inferring the database from the ON table is out of scope. SUP-222 / BYT-9698.
+ case *ast.CreateViewStmt:
+ addObjectDatabase(n.Name)
+ case *ast.AlterViewStmt:
+ addObjectDatabase(n.Name)
+ case *ast.DropViewStmt:
+ for _, ref := range n.Views {
+ addObjectDatabase(ref)
+ }
+ case *ast.CreateFunctionStmt:
+ addObjectDatabase(n.Name)
+ case *ast.AlterRoutineStmt:
+ addObjectDatabase(n.Name)
+ case *ast.DropRoutineStmt:
+ addObjectDatabase(n.Name)
+ case *ast.DropTriggerStmt:
+ addObjectDatabase(n.Name)
+
+ default:
+ }
+ }
+
+ return &base.ChangeSummary{
+ ChangedResources: changedResources,
+ DMLStatements: dmlStatements,
+ DMLCount: dmlCount,
+ InsertCount: insertCount,
+ SkippedStatements: skippedStatements,
+ }, nil
+}
+
+// omniTableRef extracts database and table name from an omni TableRef.
+func omniTableRef(ref *ast.TableRef, defaultDB string) (string, string) {
+ if ref == nil {
+ return defaultDB, ""
+ }
+ db := ref.Schema
+ if db == "" {
+ db = defaultDB
+ }
+ return db, ref.Name
+}
+
+// extractTableExprs collects schema resources from a slice of TableExpr.
+func extractTableExprs(exprs []ast.TableExpr, defaultDB string) []base.SchemaResource {
+ var result []base.SchemaResource
+ for _, expr := range exprs {
+ result = append(result, extractTableExpr(expr, defaultDB)...)
+ }
+ return result
+}
+
+// extractTableExpr recursively extracts schema resources from a single TableExpr.
+func extractTableExpr(expr ast.TableExpr, defaultDB string) []base.SchemaResource {
+ if expr == nil {
+ return nil
+ }
+ switch n := expr.(type) {
+ case *ast.TableRef:
+ db, table := omniTableRef(n, defaultDB)
+ return []base.SchemaResource{{Database: db, Table: table}}
+ case *ast.JoinClause:
+ var res []base.SchemaResource
+ res = append(res, extractTableExpr(n.Left, defaultDB)...)
+ res = append(res, extractTableExpr(n.Right, defaultDB)...)
+ return res
+ default:
+ return nil
+ }
+}
+
+// omniStatementText returns the text of a statement, ensuring it ends with a semicolon.
+func omniStatementText(a *OmniAST) string {
+ text := strings.TrimSpace(a.Text)
+ if !strings.HasSuffix(text, ";") {
+ text += ";"
+ }
+ return text
+}
diff --git a/backend/plugin/parser/oceanbase/resource_change_test.go b/backend/plugin/parser/oceanbase/resource_change_test.go
new file mode 100644
index 0000000000..a2ceb45d37
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/resource_change_test.go
@@ -0,0 +1,107 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+ "github.com/bytebase/bytebase/backend/store/model"
+)
+
+func TestExtractChangedResources(t *testing.T) {
+ statement := `CREATE TABLE t1 (c1 INT);
+ DROP TABLE t1;
+ ALTER TABLE t1 ADD COLUMN c1 INT;
+ RENAME TABLE t1 TO t2;
+ INSERT INTO t1 (c1) VALUES (1), (5);
+ INSERT INTO t1 SET c1 = 7;
+ UPDATE t1 SET c1 = 5;
+ CREATE PROCEDURE getUser(id INT) SELECT * FROM hello WHERE uid = id;
+ `
+ changedResources := model.NewChangedResources(nil /* dbMetadata */)
+ changedResources.AddTable(
+ "db",
+ "",
+ &storepb.ChangedResourceTable{
+ Name: "t1",
+ },
+ true,
+ )
+ changedResources.AddTable(
+ "db",
+ "",
+ &storepb.ChangedResourceTable{
+ Name: "t2",
+ },
+ false,
+ )
+ want := &base.ChangeSummary{
+ ChangedResources: changedResources,
+ DMLStatements: []string{
+ "UPDATE t1 SET c1 = 5;",
+ },
+ DMLCount: 1,
+ InsertCount: 3,
+ }
+
+ stmts, err := base.ParseStatements(storepb.Engine_OCEANBASE, statement)
+ require.NoError(t, err)
+ asts := base.ExtractASTs(stmts)
+ got, err := extractChangedResources("db", "", nil /* dbMetadata */, asts, statement)
+ require.NoError(t, err)
+ require.Equal(t, want, got)
+}
+
+func TestExtractChangedResourcesTruncate(t *testing.T) {
+ const statement = `TRUNCATE TABLE t;`
+
+ want := model.NewChangedResources(nil /* dbMetadata */)
+ want.AddTable("db", "", &storepb.ChangedResourceTable{Name: "t"}, true)
+
+ stmts, err := base.ParseStatements(storepb.Engine_OCEANBASE, statement)
+ require.NoError(t, err)
+ asts := base.ExtractASTs(stmts)
+ got, err := extractChangedResources("db", "", nil /* dbMetadata */, asts, statement)
+ require.NoError(t, err)
+ require.Equal(t, want, got.ChangedResources)
+}
+
+func TestExtractChangedResourcesLoadData(t *testing.T) {
+ const statement = `LOAD DATA INFILE '/tmp/f.csv' INTO TABLE other_db.t (a, b);`
+
+ want := model.NewChangedResources(nil /* dbMetadata */)
+ want.AddTable("other_db", "", &storepb.ChangedResourceTable{Name: "t"}, false)
+
+ stmts, err := base.ParseStatements(storepb.Engine_OCEANBASE, statement)
+ require.NoError(t, err)
+ asts := base.ExtractASTs(stmts)
+ got, err := extractChangedResources("db", "", nil /* dbMetadata */, asts, statement)
+ require.NoError(t, err)
+ require.Equal(t, want, got.ChangedResources)
+}
+
+func TestExtractChangedResourcesObjectDDLDatabaseOnly(t *testing.T) {
+ // Qualified non-table object DDL → a database-only target on the qualifier.
+ for _, statement := range []string{
+ `CREATE VIEW other_db.v AS SELECT 1;`,
+ `DROP VIEW other_db.v;`,
+ `ALTER PROCEDURE other_db.p COMMENT 'c';`,
+ } {
+ stmts, err := base.ParseStatements(storepb.Engine_OCEANBASE, statement)
+ require.NoError(t, err, statement)
+ asts := base.ExtractASTs(stmts)
+ got, err := extractChangedResources("db", "", nil /* dbMetadata */, asts, statement)
+ require.NoError(t, err, statement)
+ require.Equal(t, []string{"other_db"}, got.ChangedResources.GetDatabaseOnlyTargets(), statement)
+ }
+ // Unqualified → no database-only target (request-database fallback).
+ const unqualified = `CREATE VIEW v AS SELECT 1;`
+ stmts, err := base.ParseStatements(storepb.Engine_OCEANBASE, unqualified)
+ require.NoError(t, err)
+ asts := base.ExtractASTs(stmts)
+ got, err := extractChangedResources("db", "", nil /* dbMetadata */, asts, unqualified)
+ require.NoError(t, err)
+ require.Empty(t, got.ChangedResources.GetDatabaseOnlyTargets())
+}
diff --git a/backend/plugin/parser/oceanbase/split.go b/backend/plugin/parser/oceanbase/split.go
new file mode 100644
index 0000000000..f01cead2ea
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/split.go
@@ -0,0 +1,27 @@
+package oceanbase
+
+import (
+ omniparser "github.com/bytebase/omni/oceanbase/parser"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func init() {
+ base.RegisterSplitterFunc(storepb.Engine_OCEANBASE, SplitSQL)
+}
+
+// SplitSQL splits the given SQL statement into multiple SQL statements.
+// It uses omni's lexical splitter which handles quotes, comments, compound
+// statements (BEGIN...END, IF...END IF, etc.) and DELIMITER without
+// requiring valid SQL.
+func SplitSQL(statement string) ([]base.Statement, error) {
+ segments := omniparser.Split(statement)
+
+ result := make([]base.Statement, 0, len(segments))
+ positionMapper := base.NewByteOffsetPositionMapper(statement)
+ for _, seg := range segments {
+ result = append(result, base.NewStatementFromRange(statement, positionMapper, seg.ByteStart, seg.ByteEnd, seg.Empty()))
+ }
+ return result, nil
+}
diff --git a/backend/plugin/parser/oceanbase/split_test.go b/backend/plugin/parser/oceanbase/split_test.go
new file mode 100644
index 0000000000..c7fdea0746
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/split_test.go
@@ -0,0 +1,122 @@
+package oceanbase
+
+import (
+ "fmt"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestSplitSQL(t *testing.T) {
+ base.RunSplitTests(t, "test-data/test_split.yaml", base.SplitTestOptions{
+ SplitFunc: SplitSQL,
+ })
+}
+
+func TestSplitSQLLargeInsertScriptScalesLinearly(t *testing.T) {
+ const rowCount = 2000
+ padding := strings.Repeat("x", 1024)
+ var builder strings.Builder
+ for i := 0; i < rowCount; i++ {
+ fmt.Fprintf(&builder, "INSERT INTO perf_omni_mysql (id, payload) VALUES (%d, '%s');\n", i, padding)
+ }
+
+ started := time.Now()
+ statements, err := SplitSQL(builder.String())
+ elapsed := time.Since(started)
+
+ require.NoError(t, err)
+ require.Len(t, base.FilterEmptyStatements(statements), rowCount)
+ require.Less(t, elapsed, time.Second)
+}
+
+func TestSplitSQLDelimiterDirectives(t *testing.T) {
+ statement := "DELIMITER //\nCREATE PROCEDURE p()\nBEGIN\n SELECT delimiter FROM t;\nEND//\nDELIMITER ;\nCALL p();"
+
+ list, err := SplitSQL(statement)
+ require.NoError(t, err)
+
+ list = base.FilterEmptyStatements(list)
+ require.Len(t, list, 2)
+ require.Equal(t, "CREATE PROCEDURE p()\nBEGIN\n SELECT delimiter FROM t;\nEND", list[0].Text)
+ require.Equal(t, "CALL p();", list[1].Text)
+ require.Equal(t, statement[list[0].Range.Start:list[0].Range.End], list[0].Text)
+ require.Equal(t, statement[list[1].Range.Start:list[1].Range.End], list[1].Text)
+}
+
+func TestSplitSQLDelimiterLabelIsNotDirective(t *testing.T) {
+ statement := "DELIMITER: LOOP\n SELECT 1;\n LEAVE DELIMITER;\nEND LOOP DELIMITER;"
+
+ list, err := SplitSQL(statement)
+ require.NoError(t, err)
+
+ list = base.FilterEmptyStatements(list)
+ require.Len(t, list, 1)
+ require.Equal(t, statement, list[0].Text)
+}
+
+func TestSplitSQLDelimiterIdentifierIsNotDirective(t *testing.T) {
+ statement := "CREATE TABLE t (\n delimiter INT\n);\nSELECT delimiter FROM t;"
+
+ list, err := SplitSQL(statement)
+ require.NoError(t, err)
+
+ list = base.FilterEmptyStatements(list)
+ require.Len(t, list, 2)
+ require.Equal(t, "CREATE TABLE t (\n delimiter INT\n);", list[0].Text)
+ require.Equal(t, "\nSELECT delimiter FROM t;", list[1].Text)
+}
+
+func TestSplitStatements(t *testing.T) {
+ tests := []struct {
+ statement string
+ expected []string
+ }{
+ {
+ statement: "SELECT * FROM t1 WHERE c1 = 1; SELECT * FROM t2;",
+ expected: []string{
+ "SELECT * FROM t1 WHERE c1 = 1;",
+ " SELECT * FROM t2;",
+ },
+ },
+ {
+ statement: `CREATE PROCEDURE my_procedure (IN id INT, OUT name VARCHAR(255))
+ BEGIN
+ SELECT name INTO name FROM users WHERE id = id;
+ END; SELECT * FROM t2;`,
+ expected: []string{
+ `CREATE PROCEDURE my_procedure (IN id INT, OUT name VARCHAR(255))
+ BEGIN
+ SELECT name INTO name FROM users WHERE id = id;
+ END;`,
+ " SELECT * FROM t2;",
+ },
+ },
+ {
+ statement: `CREATE PROCEDURE my_procedure (IN id INT, OUT name VARCHAR(255))
+ BEGIN
+ SELECT IF(id = 1, 'one', 'other') INTO name FROM users;
+ END; SELECT REPEAT('123', a) FROM t2;`,
+ expected: []string{
+ `CREATE PROCEDURE my_procedure (IN id INT, OUT name VARCHAR(255))
+ BEGIN
+ SELECT IF(id = 1, 'one', 'other') INTO name FROM users;
+ END;`,
+ " SELECT REPEAT('123', a) FROM t2;",
+ },
+ },
+ }
+
+ for _, test := range tests {
+ list, err := SplitSQL(test.statement)
+ require.NoError(t, err)
+ require.Equal(t, len(test.expected), len(list))
+ for i, statement := range list {
+ require.Equal(t, test.expected[i], statement.Text)
+ }
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/statement_type.go b/backend/plugin/parser/oceanbase/statement_type.go
new file mode 100644
index 0000000000..30d0021294
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/statement_type.go
@@ -0,0 +1,152 @@
+package oceanbase
+
+import (
+ "strings"
+
+ "github.com/bytebase/omni/oceanbase/ast"
+ "github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func GetStatementTypes(asts []base.AST) ([]storepb.StatementType, error) {
+ sqlTypeSet := make(map[storepb.StatementType]bool)
+ for _, a := range asts {
+ node, ok := GetOmniNode(a)
+ if !ok {
+ return nil, errors.New("expected OmniAST for OceanBase")
+ }
+ t := classifyStatementType(node)
+ sqlTypeSet[t] = true
+ }
+ var sqlTypes []storepb.StatementType
+ for sqlType := range sqlTypeSet {
+ sqlTypes = append(sqlTypes, sqlType)
+ }
+ return sqlTypes, nil
+}
+
+// StatementTypeWithPosition contains a statement type and its position information.
+// It mirrors the PostgreSQL equivalent so the SDL statement-type gating in the release
+// service can report disallowed statements with line numbers.
+type StatementTypeWithPosition struct {
+ Type storepb.StatementType
+ // Line is the one-based line number where the statement ends.
+ Line int
+ Text string
+}
+
+// GetStatementTypesWithPositions returns statement types with position information,
+// preserving statement order. Line numbers are one-based. It mirrors
+// pg.GetStatementTypes so the declarative-release gating can surface disallowed SDL
+// statements with positions for MySQL.
+func GetStatementTypesWithPositions(asts []base.AST) ([]StatementTypeWithPosition, error) {
+ if len(asts) == 0 {
+ return []StatementTypeWithPosition{}, nil
+ }
+
+ var results []StatementTypeWithPosition
+ for _, a := range asts {
+ omniAST, ok := a.(*OmniAST)
+ if !ok {
+ return nil, errors.New("expected OmniAST for OceanBase")
+ }
+ if omniAST.Node == nil {
+ continue
+ }
+
+ // STATEMENT_TYPE_UNSPECIFIED entries (statements omni parses but the classifier
+ // does not know — GRANT, SET, CALL, …) are INCLUDED, with their positions and
+ // text, so the SDL statement-type gate fails closed: dropping them here would
+ // let an unclassified statement bypass the release-check allowlist entirely.
+ stmtType := classifyStatementType(omniAST.Node)
+
+ line := 0
+ if omniAST.StartPosition != nil {
+ line = int(omniAST.StartPosition.Line)
+ }
+ // End line = start line + embedded newlines in the statement text.
+ endLine := line
+ if omniAST.Text != "" {
+ endLine += strings.Count(omniAST.Text, "\n")
+ }
+
+ results = append(results, StatementTypeWithPosition{
+ Type: stmtType,
+ Line: endLine,
+ Text: omniAST.Text,
+ })
+ }
+
+ return results, nil
+}
+
+func classifyStatementType(node ast.Node) storepb.StatementType {
+ switch n := node.(type) {
+ // CREATE
+ case *ast.CreateDatabaseStmt:
+ return storepb.StatementType_CREATE_DATABASE
+ case *ast.CreateTableStmt:
+ return storepb.StatementType_CREATE_TABLE
+ case *ast.CreateIndexStmt:
+ return storepb.StatementType_CREATE_INDEX
+ case *ast.CreateViewStmt:
+ return storepb.StatementType_CREATE_VIEW
+ case *ast.CreateEventStmt:
+ return storepb.StatementType_CREATE_EVENT
+ case *ast.CreateTriggerStmt:
+ return storepb.StatementType_CREATE_TRIGGER
+ case *ast.CreateFunctionStmt:
+ if n.IsProcedure {
+ return storepb.StatementType_CREATE_PROCEDURE
+ }
+ return storepb.StatementType_CREATE_FUNCTION
+
+ // DROP
+ case *ast.DropDatabaseStmt:
+ return storepb.StatementType_DROP_DATABASE
+ case *ast.DropTableStmt:
+ return storepb.StatementType_DROP_TABLE
+ case *ast.DropIndexStmt:
+ return storepb.StatementType_DROP_INDEX
+ case *ast.DropViewStmt:
+ return storepb.StatementType_DROP_VIEW
+ case *ast.DropEventStmt:
+ return storepb.StatementType_DROP_EVENT
+ case *ast.DropTriggerStmt:
+ return storepb.StatementType_DROP_TRIGGER
+ case *ast.DropRoutineStmt:
+ if n.IsProcedure {
+ return storepb.StatementType_DROP_PROCEDURE
+ }
+ return storepb.StatementType_DROP_FUNCTION
+
+ // ALTER
+ case *ast.AlterTableStmt:
+ return storepb.StatementType_ALTER_TABLE
+ case *ast.AlterDatabaseStmt:
+ return storepb.StatementType_ALTER_DATABASE
+ case *ast.AlterViewStmt:
+ return storepb.StatementType_ALTER_VIEW
+ case *ast.AlterEventStmt:
+ return storepb.StatementType_ALTER_EVENT
+
+ // OTHER DDL
+ case *ast.TruncateStmt:
+ return storepb.StatementType_TRUNCATE
+ case *ast.RenameTableStmt:
+ return storepb.StatementType_RENAME
+
+ // DML
+ case *ast.InsertStmt:
+ return storepb.StatementType_INSERT
+ case *ast.UpdateStmt:
+ return storepb.StatementType_UPDATE
+ case *ast.DeleteStmt:
+ return storepb.StatementType_DELETE
+
+ default:
+ return storepb.StatementType_STATEMENT_TYPE_UNSPECIFIED
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/statement_type_test.go b/backend/plugin/parser/oceanbase/statement_type_test.go
new file mode 100644
index 0000000000..8579d5a879
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/statement_type_test.go
@@ -0,0 +1,77 @@
+package oceanbase
+
+import (
+ "io"
+ "os"
+ "testing"
+
+ "github.com/stretchr/testify/require"
+ "gopkg.in/yaml.v3"
+
+ "github.com/bytebase/bytebase/backend/common/yamltest"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+type statementTypeTest struct {
+ Statement string
+ Want []string
+}
+
+// TestGetStatementType runs the fixture under every engine this package
+// registers the classifier for (BYT-10136).
+func TestGetStatementType(t *testing.T) {
+ tests := []statementTypeTest{}
+
+ const (
+ record = false
+ )
+
+ var (
+ filepath = "test-data/test_statement_type.yaml"
+ )
+
+ a := require.New(t)
+ yamlFile, err := os.Open(filepath)
+ a.NoError(err)
+
+ byteValue, err := io.ReadAll(yamlFile)
+ a.NoError(yamlFile.Close())
+ a.NoError(err)
+ a.NoError(yaml.Unmarshal(byteValue, &tests))
+
+ engines := []storepb.Engine{
+ storepb.Engine_OCEANBASE,
+ storepb.Engine_OCEANBASE,
+ }
+ for _, engine := range engines {
+ t.Run(engine.String(), func(t *testing.T) {
+ a := require.New(t)
+ for i, test := range tests {
+ stmts, err := base.ParseStatements(engine, test.Statement)
+ a.NoError(err)
+ asts := base.ExtractASTs(stmts)
+
+ sqlType, err := GetStatementTypes(asts)
+ a.NoError(err)
+
+ // Convert enum to string for comparison
+ sqlTypeStrings := make([]string, len(sqlType))
+ for j, t := range sqlType {
+ sqlTypeStrings[j] = t.String()
+ }
+
+ // Record from the MySQL run only; the other engines must match it.
+ if record && engine == storepb.Engine_OCEANBASE {
+ tests[i].Want = sqlTypeStrings
+ } else {
+ a.Equal(test.Want, sqlTypeStrings)
+ }
+ }
+ })
+ }
+
+ if record {
+ yamltest.Record(t, filepath, tests)
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/system_resource_test.go b/backend/plugin/parser/oceanbase/system_resource_test.go
new file mode 100644
index 0000000000..7dc3c1e354
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/system_resource_test.go
@@ -0,0 +1,63 @@
+package oceanbase
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+func TestIsSystemResource(t *testing.T) {
+ cases := []struct {
+ name string
+ database string
+ ignoreCaseSensitive bool
+ want bool
+ }{
+ // information_schema — reserved by MySQL server, always case-insensitive.
+ {"info_schema lowercase, case-sensitive instance", "information_schema", false, true},
+ {"info_schema uppercase, case-sensitive instance", "INFORMATION_SCHEMA", false, true},
+ {"info_schema mixed case, case-sensitive instance", "Information_Schema", false, true},
+ {"info_schema uppercase, case-insensitive instance", "INFORMATION_SCHEMA", true, true},
+
+ // performance_schema — reserved by MySQL server, always case-insensitive.
+ {"perf_schema lowercase, case-sensitive instance", "performance_schema", false, true},
+ {"perf_schema uppercase, case-sensitive instance", "PERFORMANCE_SCHEMA", false, true},
+
+ // mysql — on-disk schema, only case-insensitive when the instance is
+ // (lower_case_table_names != 0). Case-sensitive instances can host a
+ // separate user schema named e.g. `MySQL`, which must NOT be treated
+ // as a system schema.
+ {"mysql lowercase, case-sensitive instance", "mysql", false, true},
+ {"mysql uppercase, case-sensitive instance (user schema)", "MYSQL", false, false},
+ {"mysql mixed case, case-sensitive instance (user schema)", "MySQL", false, false},
+ {"mysql uppercase, case-insensitive instance", "MYSQL", true, true},
+ {"mysql mixed case, case-insensitive instance", "MySQL", true, true},
+
+ // Arbitrary user schemas are never system.
+ {"user schema lowercase", "byt9309_db", false, false},
+ {"user schema uppercase", "BYT9309_DB", false, false},
+ }
+
+ for _, tc := range cases {
+ t.Run(tc.name, func(t *testing.T) {
+ got := isSystemResource(base.ColumnResource{Database: tc.database}, tc.ignoreCaseSensitive)
+ require.Equal(t, tc.want, got)
+ })
+ }
+}
+
+// TestIsSystemResourceBYT9309 pins the specific regression: uppercase
+// `INFORMATION_SCHEMA` on a case-sensitive instance must be recognized as
+// a system schema, so `isMixedQuery` can short-circuit and prevent the
+// span extractor from flagging it as a not-found user database — which
+// previously cascaded into a nil-pointer panic in the schema syncer.
+func TestIsSystemResourceBYT9309(t *testing.T) {
+ set := base.SourceColumnSet{
+ {Database: "INFORMATION_SCHEMA", Table: "PROCESSLIST"}: true,
+ }
+ allSystem, mixed := isMixedQuery(set, false /* case-sensitive instance */)
+ require.True(t, allSystem, "INFORMATION_SCHEMA.PROCESSLIST should be treated as system on a case-sensitive instance")
+ require.False(t, mixed)
+}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_cte_semijoin_materialization_scan.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_cte_semijoin_materialization_scan.json
new file mode 100644
index 0000000000..68d2c466da
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_cte_semijoin_materialization_scan.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"122.70"},"nested_loop":[{"table":{"table_name":"<subquery2>","access_type":"ALL","materialized_from_subquery":{"using_temporary_table":true,"query_block":{"table":{"table_name":"x","access_type":"ALL","rows_examined_per_scan":10,"rows_produced_per_join":10,"filtered":"100.00","cost_info":{"read_cost":"2.62","eval_cost":"1.00","prefix_cost":"3.62","data_read_per_join":"160"},"used_columns":["id"],"materialized_from_subquery":{"using_temporary_table":true,"dependent":false,"cacheable":true,"query_block":{"select_id":3,"cost_info":{"query_cost":"10.25"},"table":{"table_name":"s","access_type":"ALL","rows_examined_per_scan":100,"rows_produced_per_join":10,"filtered":"10.00","cost_info":{"read_cost":"9.25","eval_cost":"1.00","prefix_cost":"10.25","data_read_per_join":"80"},"used_columns":["id","flag"],"attached_condition":"(`probe`.`s`.`flag` = 1)"}}}}}}}},{"table":{"delete":true,"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","used_key_parts":["s_id"],"key_length":"4","ref":["<subquery2>.id"],"rows_examined_per_scan":113,"rows_produced_per_join":113,"filtered":"100.00","cost_info":{"read_cost":"2.77","eval_cost":"11.33","prefix_cost":"122.70","data_read_per_join":"1K"},"used_columns":["id","s_id","v"]}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_limit.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_limit.json
new file mode 100644
index 0000000000..45778dd2c3
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/delete_limit.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"delete":true,"table_name":"target_table","access_type":"ALL","rows_examined_per_scan":10,"filtered":"100.00"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/in_materialized_update.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/in_materialized_update.json
new file mode 100644
index 0000000000..500811841c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/in_materialized_update.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"40149.05"},"table":{"update":true,"table_name":"o","access_type":"ALL","rows_examined_per_scan":399648,"rows_produced_per_join":399648,"filtered":"100.00","cost_info":{"read_cost":"184.25","eval_cost":"39964.80","prefix_cost":"40149.05","data_read_per_join":"6M"},"used_columns":["id","join_key","target_flag"],"attached_condition":"<in_optimizer>(`test`.`o`.`join_key`,`test`.`o`.`join_key` in ( <materialize> (/* select#2 */ select `test`.`t`.`join_key` from `test`.`related_table` `t` where (`test`.`t`.`filter_column_1` = 'VALUE_A') group by `test`.`t`.`join_key` having (count(0) > 0) ), <primary_index_lookup>(`test`.`o`.`join_key` in <temporary table> on <auto_distinct_key> where ((`test`.`o`.`join_key` = `<materialized_subquery>`.`join_key`)))))","attached_subqueries":[{"table":{"table_name":"<materialized_subquery>","access_type":"eq_ref","key":"<auto_key>","key_length":"4","rows_examined_per_scan":1,"materialized_from_subquery":{"using_temporary_table":true,"dependent":true,"cacheable":false,"query_block":{"select_id":2,"cost_info":{"query_cost":"10095.45"},"grouping_operation":{"using_filesort":false,"table":{"table_name":"t","access_type":"index","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","rows_examined_per_scan":100232,"rows_produced_per_join":10023,"filtered":"10.00","cost_info":{"read_cost":"9093.13","eval_cost":"1002.32","prefix_cost":"10095.45","data_read_per_join":"1M"},"used_columns":["id","join_key","filter_column_1"],"attached_condition":"(`test`.`t`.`filter_column_1` = 'VALUE_A')"}}}}}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_buffer_result.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_buffer_result.json
new file mode 100644
index 0000000000..7c9f98664b
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_buffer_result.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"451.75"},"table":{"insert":true,"select_id":1,"table_name":"t2","access_type":"ALL"},"insert_from":{"buffer_result":{"using_temporary_table":true,"nested_loop":[{"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.75","eval_cost":"100.00","prefix_cost":"101.75","data_read_per_join":"101K"},"used_columns":["id","c","d","grp","v"]}},{"table":{"table_name":"t2","access_type":"eq_ref","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","ref":["probe.t.id"],"rows_examined_per_scan":1,"rows_produced_per_join":1000,"filtered":"100.00","not_exists":true,"using_index":true,"cost_info":{"read_cost":"250.00","eval_cost":"100.00","prefix_cost":"451.75","data_read_per_join":"101K"},"used_columns":["id"],"attached_condition":"<if>(found_match(t2), (`probe`.`t2`.`id` is null), true)"}}]}}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_filter.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_filter.json
new file mode 100644
index 0000000000..3c0c012135
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_filter.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"101.75"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":100,"filtered":"10.00","cost_info":{"read_cost":"91.75","eval_cost":"10.00","prefix_cost":"101.75","data_read_per_join":"10K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`d` = 3)"}}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_from_dual_not_exists.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_from_dual_not_exists.json
new file mode 100644
index 0000000000..c61d121fa7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_from_dual_not_exists.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"insert":true,"table_name":"t2","access_type":"ALL","attached_subqueries":[{"dependent":false,"cacheable":true,"query_block":{"select_id":2,"message":"no matching row in const table"}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_impossible_where.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_impossible_where.json
new file mode 100644
index 0000000000..fa8e537378
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_impossible_where.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"message":"Impossible WHERE"}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_join.json
new file mode 100644
index 0000000000..0c9c2cda0a
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"406.80"},"table":{"insert":true,"table_name":"big2","access_type":"ALL"},"insert_from":{"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"rows_examined_per_scan":100,"rows_produced_per_join":10,"filtered":"10.00","cost_info":{"read_cost":"9.25","eval_cost":"1.00","prefix_cost":"10.25","data_read_per_join":"80"},"used_columns":["id","flag"],"attached_condition":"(`probe`.`s`.`flag` = 1)"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","used_key_parts":["s_id"],"key_length":"4","ref":["probe.s.id"],"rows_examined_per_scan":113,"rows_produced_per_join":1133,"filtered":"100.00","cost_info":{"read_cost":"283.25","eval_cost":"113.30","prefix_cost":"406.80","data_read_per_join":"17K"},"used_columns":["id","s_id","v"]}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_parenthesized_limit.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_parenthesized_limit.json
new file mode 100644
index 0000000000..0678ec504d
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_parenthesized_limit.json
@@ -0,0 +1 @@
+{"query_block":{"unary_result":{"using_temporary_table":true,"select_id":2,"table_name":"<ordered/limited1>","access_type":"ALL","using_filesort":true,"query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":1,"cost_info":{"query_cost":"101.25"},"table":{"insert":true,"select_id":1,"table_name":"t2","access_type":"ALL"},"insert_from":{"ordering_operation":{"using_filesort":true,"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.25","eval_cost":"100.00","prefix_cost":"101.25","data_read_per_join":"101K"},"used_columns":["id","c","d","grp","v"]}}}}}]}}}
\ No newline at end of file
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_semijoin_materialization_lookup.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_semijoin_materialization_lookup.json
new file mode 100644
index 0000000000..3aaf15e7e0
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_semijoin_materialization_lookup.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"207.37"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"nested_loop":[{"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.75","eval_cost":"100.00","prefix_cost":"101.75","data_read_per_join":"101K"},"used_columns":["id","c","d","grp","v"]}},{"table":{"table_name":"<subquery2>","access_type":"eq_ref","key":"<auto_distinct_key>","key_length":"4","ref":["probe.t.grp"],"rows_examined_per_scan":1,"materialized_from_subquery":{"using_temporary_table":true,"query_block":{"table":{"table_name":"x","access_type":"ALL","rows_examined_per_scan":10,"rows_produced_per_join":10,"filtered":"100.00","cost_info":{"read_cost":"2.62","eval_cost":"1.00","prefix_cost":"3.62","data_read_per_join":"160"},"used_columns":["id"],"materialized_from_subquery":{"using_temporary_table":true,"dependent":false,"cacheable":true,"query_block":{"select_id":3,"cost_info":{"query_cost":"10.25"},"table":{"table_name":"s","access_type":"ALL","rows_examined_per_scan":100,"rows_produced_per_join":10,"filtered":"10.00","cost_info":{"read_cost":"9.25","eval_cost":"1.00","prefix_cost":"10.25","data_read_per_join":"80"},"used_columns":["id","flag"],"attached_condition":"(`probe`.`s`.`flag` = 1)"}}}}}}}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_all.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_all.json
new file mode 100644
index 0000000000..e724d9f532
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_all.json
@@ -0,0 +1 @@
+{"query_block":{"union_result":{"using_temporary_table":true,"select_id":3,"table_name":"<union1,2>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":1,"cost_info":{"query_cost":"45.26"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"table":{"table_name":"t","access_type":"range","possible_keys":["idx_c"],"key":"idx_c","used_key_parts":["c"],"key_length":"4","rows_examined_per_scan":100,"rows_produced_per_join":100,"filtered":"100.00","index_condition":"(`probe`.`t`.`c` < 10)","cost_info":{"read_cost":"35.26","eval_cost":"10.00","prefix_cost":"45.26","data_read_per_join":"10K"},"used_columns":["id","c","d","grp","v"]}}}},{"dependent":false,"cacheable":true,"query_block":{"select_id":2,"cost_info":{"query_cost":"101.75"},"table":{"table_name":"t","access_type":"ALL","possible_keys":["idx_c"],"rows_examined_per_scan":1000,"rows_produced_per_join":899,"filtered":"90.00","cost_info":{"read_cost":"11.75","eval_cost":"90.00","prefix_cost":"101.75","data_read_per_join":"91K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`c` >= 10)"}}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_except.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_except.json
new file mode 100644
index 0000000000..ed37ba9574
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_except.json
@@ -0,0 +1 @@
+{"query_block":{"union_result":{"using_temporary_table":true,"select_id":5,"table_name":"<union1,4>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":1,"cost_info":{"query_cost":"1.60"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"nested_loop":[{"table":{"table_name":"small","access_type":"index","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","rows_examined_per_scan":3,"rows_produced_per_join":3,"filtered":"100.00","using_index":true,"cost_info":{"read_cost":"0.25","eval_cost":"0.30","prefix_cost":"0.55","data_read_per_join":"48"},"used_columns":["id"]}},{"table":{"table_name":"t","access_type":"eq_ref","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","ref":["probe.small.id"],"rows_examined_per_scan":1,"rows_produced_per_join":3,"filtered":"100.00","cost_info":{"read_cost":"0.75","eval_cost":"0.30","prefix_cost":"1.60","data_read_per_join":"312"},"used_columns":["id","c","d","grp","v"]}}]}}},{"except_result":{"using_temporary_table":true,"select_id":4,"table_name":"<except2,3>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":2,"cost_info":{"query_cost":"101.25"},"table":{"table_name":"t","access_type":"ALL","possible_keys":["idx_c"],"rows_examined_per_scan":1000,"rows_produced_per_join":500,"filtered":"50.00","cost_info":{"read_cost":"51.25","eval_cost":"50.00","prefix_cost":"101.25","data_read_per_join":"50K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`c`<50)"}}},{"dependent":false,"cacheable":true,"query_block":{"select_id":3,"cost_info":{"query_cost":"101.25"},"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":100,"filtered":"10.00","cost_info":{"read_cost":"91.25","eval_cost":"10.00","prefix_cost":"101.25","data_read_per_join":"10K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`d`=1)"}}}]}}]}}}
\ No newline at end of file
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_intersect.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_intersect.json
new file mode 100644
index 0000000000..9a9372c62a
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_intersect.json
@@ -0,0 +1 @@
+{"query_block":{"union_result":{"using_temporary_table":true,"select_id":5,"table_name":"<union1,4>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":1,"cost_info":{"query_cost":"1.60"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"nested_loop":[{"table":{"table_name":"small","access_type":"index","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","rows_examined_per_scan":3,"rows_produced_per_join":3,"filtered":"100.00","using_index":true,"cost_info":{"read_cost":"0.25","eval_cost":"0.30","prefix_cost":"0.55","data_read_per_join":"48"},"used_columns":["id"]}},{"table":{"table_name":"t","access_type":"eq_ref","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","ref":["probe.small.id"],"rows_examined_per_scan":1,"rows_produced_per_join":3,"filtered":"100.00","cost_info":{"read_cost":"0.75","eval_cost":"0.30","prefix_cost":"1.60","data_read_per_join":"312"},"used_columns":["id","c","d","grp","v"]}}]}}},{"intersect_result":{"using_temporary_table":true,"select_id":4,"table_name":"<intersect2,3>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":2,"cost_info":{"query_cost":"101.25"},"table":{"table_name":"t","access_type":"ALL","possible_keys":["idx_c"],"rows_examined_per_scan":1000,"rows_produced_per_join":500,"filtered":"50.00","cost_info":{"read_cost":"51.25","eval_cost":"50.00","prefix_cost":"101.25","data_read_per_join":"50K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`c`<50)"}}},{"dependent":false,"cacheable":true,"query_block":{"select_id":3,"cost_info":{"query_cost":"101.25"},"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":100,"filtered":"10.00","cost_info":{"read_cost":"91.25","eval_cost":"10.00","prefix_cost":"101.25","data_read_per_join":"10K"},"used_columns":["id","c","d","grp","v"],"attached_condition":"(`probe`.`t`.`d`=1)"}}}]}}]}}}
\ No newline at end of file
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_without_tables.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_without_tables.json
new file mode 100644
index 0000000000..2d13676ced
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_union_without_tables.json
@@ -0,0 +1 @@
+{"query_block":{"union_result":{"using_temporary_table":true,"select_id":3,"table_name":"<union1,2>","access_type":"ALL","query_specifications":[{"dependent":false,"cacheable":true,"query_block":{"select_id":1,"table":{"insert":true,"table_name":"t2","access_type":"ALL"}}},{"dependent":false,"cacheable":true,"query_block":{"select_id":2,"message":"No tables used"}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_window_no_source.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_window_no_source.json
new file mode 100644
index 0000000000..20a033bf09
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_select_window_no_source.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"145.26"},"table":{"insert":true,"select_id":1,"table_name":"t2","access_type":"ALL"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_table.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_table.json
new file mode 100644
index 0000000000..021181aa2c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/insert_table.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"101.75"},"table":{"insert":true,"table_name":"t2","access_type":"ALL"},"insert_from":{"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.75","eval_cost":"100.00","prefix_cost":"101.75","data_read_per_join":"101K"},"used_columns":["id","c","d","grp","v"]}}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_all_rows.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_all_rows.json
new file mode 100644
index 0000000000..1a38f4cc72
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_all_rows.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"message":"Deleting all rows"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_impossible_where.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_impossible_where.json
new file mode 100644
index 0000000000..d1b86a015c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_impossible_where.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"message":"Impossible WHERE"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_join.json
new file mode 100644
index 0000000000..b2717d8279
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":0.1878414,"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":10,"attached_condition":"s.flag = 1"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","key_length":"4","used_key_parts":["s_id"],"ref":["probe.s.id"],"loops":10,"rows":100,"cost":0.1606866,"filtered":100}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin.json
new file mode 100644
index 0000000000..b2717d8279
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":0.1878414,"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":10,"attached_condition":"s.flag = 1"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","key_length":"4","used_key_parts":["s_id"],"ref":["probe.s.id"],"loops":10,"rows":100,"cost":0.1606866,"filtered":100}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin_materialization.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin_materialization.json
new file mode 100644
index 0000000000..e22ea5820f
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_delete_semijoin_materialization.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":3.3635308,"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":100}},{"table":{"table_name":"<subquery2>","access_type":"eq_ref","possible_keys":["distinct_key"],"key":"distinct_key","key_length":"4","used_key_parts":["s_id"],"ref":["func"],"rows":1,"filtered":100,"materialized":{"unique":1,"query_block":{"select_id":2,"nested_loop":[{"table":{"table_name":"big","access_type":"ALL","possible_keys":["idx_s"],"loops":1,"rows":10000,"cost":1.6588056,"filtered":100,"attached_condition":"big.v = 0"}}]}}}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_block_nl_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_block_nl_join.json
new file mode 100644
index 0000000000..dec3d3d35a
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_block_nl_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":4.741674304,"nested_loop":[{"table":{"table_name":"s","access_type":"range","possible_keys":["PRIMARY"],"key":"PRIMARY","key_length":"4","used_key_parts":["id"],"loops":1,"rows":49,"cost":0.01183867,"filtered":100,"attached_condition":"s.`id` < 50"}},{"block-nl-join":{"table":{"table_name":"t","access_type":"ALL","loops":49,"rows":1000,"cost":4.729835634,"filtered":100},"buffer_type":"flat","buffer_size":"348","join_type":"BNL","attached_condition":"t.d = s.flag"}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_filter.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_filter.json
new file mode 100644
index 0000000000..9d04f7c04d
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_filter.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":0.1764192,"nested_loop":[{"table":{"table_name":"t","access_type":"ALL","loops":1,"rows":1000,"cost":0.1764192,"filtered":14.30000019,"attached_condition":"t.d = 3"}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_join.json
new file mode 100644
index 0000000000..d729014ba7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":1.0526188,"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":10,"attached_condition":"s.flag = 1"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","key_length":"4","used_key_parts":["s_id"],"ref":["probe.s.id"],"loops":10,"rows":100,"cost":1.025464,"filtered":100}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_no_tables.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_no_tables.json
new file mode 100644
index 0000000000..6d7280a4e0
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_no_tables.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"message":"No tables used"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_order_limit.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_order_limit.json
new file mode 100644
index 0000000000..c2b88282d3
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_order_limit.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":0.1764192,"nested_loop":[{"read_sorted_file":{"filesort":{"sort_key":"t.d","table":{"table_name":"t","access_type":"ALL","loops":1,"rows":1000,"cost":0.1764192,"filtered":100}}}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_union_all.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_union_all.json
new file mode 100644
index 0000000000..36bcf5c677
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_union_all.json
@@ -0,0 +1 @@
+{"query_block":{"union_result":{"table_name":"<union1,2>","access_type":"ALL","query_specifications":[{"query_block":{"select_id":1,"cost":0.10505784,"nested_loop":[{"table":{"table_name":"t","access_type":"range","possible_keys":["idx_c"],"key":"idx_c","key_length":"4","used_key_parts":["c"],"loops":1,"rows":100,"cost":0.10505784,"filtered":100,"index_condition":"t.c < 10"}}]}},{"query_block":{"select_id":2,"operation":"UNION","cost":0.1764192,"nested_loop":[{"table":{"table_name":"t","access_type":"ALL","possible_keys":["idx_c"],"loops":1,"rows":1000,"cost":0.1764192,"filtered":90,"attached_condition":"t.c >= 10"}}]}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_window.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_window.json
new file mode 100644
index 0000000000..987f70c55c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_insert_select_window.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":0.10505784,"window_functions_computation":{"sorts":[{"filesort":{"sort_key":"t.grp, t.`id`"}}],"temporary_table":{"nested_loop":[{"table":{"table_name":"t","access_type":"range","possible_keys":["idx_c"],"key":"idx_c","key_length":"4","used_key_parts":["c"],"loops":1,"rows":100,"cost":0.10505784,"filtered":100,"index_condition":"t.c < 10"}}]}}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_all_rows.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_all_rows.json
new file mode 100644
index 0000000000..cc51e45541
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_all_rows.json
@@ -0,0 +1,22 @@
+{
+ "query_block": {
+ "select_id": 1,
+ "cost": 1.47862472,
+ "nested_loop": [
+ {
+ "table": {
+ "table_name": "big",
+ "access_type": "index",
+ "key": "idx_s",
+ "key_length": "4",
+ "used_key_parts": ["s_id"],
+ "loops": 1,
+ "rows": 10000,
+ "cost": 1.47862472,
+ "filtered": 100,
+ "using_index": true
+ }
+ }
+ ]
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_range_filter.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_range_filter.json
new file mode 100644
index 0000000000..aa661e48bf
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_select_for_delete_range_filter.json
@@ -0,0 +1,24 @@
+{
+ "query_block": {
+ "select_id": 1,
+ "cost": 0.10505784,
+ "nested_loop": [
+ {
+ "table": {
+ "table_name": "t",
+ "access_type": "range",
+ "possible_keys": ["idx_c"],
+ "key": "idx_c",
+ "key_length": "4",
+ "used_key_parts": ["c"],
+ "loops": 1,
+ "rows": 100,
+ "cost": 0.10505784,
+ "filtered": 14.30000019,
+ "index_condition": "t.c < 10",
+ "attached_condition": "t.d = 3"
+ }
+ }
+ ]
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update.json
new file mode 100644
index 0000000000..5302f6f379
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"update":1,"table_name":"o","access_type":"index","key":"PRIMARY","key_length":"","used_key_parts":["id"],"rows":10000,"attached_condition":"o.target_flag is null and <in_optimizer>(1,exists(subquery#2))"},"subqueries":[{"query_block":{"select_id":2,"cost":0.00345856,"nested_loop":[{"table":{"table_name":"t","access_type":"ref","possible_keys":["idx_join_key"],"key":"idx_join_key","key_length":"4","used_key_parts":["join_key"],"ref":["test.o.join_key"],"loops":1,"rows":1,"cost":0.00345856,"filtered":100,"attached_condition":"t.filter_column_1 = 'VALUE_A'"}}]}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_join_unqualified_column.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_join_unqualified_column.json
new file mode 100644
index 0000000000..c54018b34f
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_join_unqualified_column.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":1.0526188,"nested_loop":[{"table":{"table_name":"x","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":10,"attached_condition":"x.flag = 1"}},{"table":{"table_name":"b","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","key_length":"4","used_key_parts":["s_id"],"ref":["probe.x.id"],"loops":10,"rows":100,"cost":1.025464,"filtered":100}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_straight_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_straight_join.json
new file mode 100644
index 0000000000..d36b956fe1
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_straight_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":10.6040248,"nested_loop":[{"table":{"table_name":"big","access_type":"ALL","possible_keys":["idx_s"],"loops":1,"rows":10000,"cost":1.6588056,"filtered":100}},{"table":{"table_name":"s","access_type":"eq_ref","possible_keys":["PRIMARY"],"key":"PRIMARY","key_length":"4","used_key_parts":["id"],"ref":["probe.big.s_id"],"loops":10000,"rows":1,"cost":8.9452192,"filtered":10,"attached_condition":"s.flag = 1"}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_two_targets.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_two_targets.json
new file mode 100644
index 0000000000..d729014ba7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mariadb_update_two_targets.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost":1.0526188,"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"loops":1,"rows":100,"cost":0.0271548,"filtered":10,"attached_condition":"s.flag = 1"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","key_length":"4","used_key_parts":["s_id"],"ref":["probe.s.id"],"loops":10,"rows":100,"cost":1.025464,"filtered":100}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/multi_target_delete.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/multi_target_delete.json
new file mode 100644
index 0000000000..b3d47dec4f
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/multi_target_delete.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"16424.46"},"nested_loop":[{"table":{"delete":true,"table_name":"t","access_type":"ALL","possible_keys":["idx_join_key"],"rows_examined_per_scan":100232,"rows_produced_per_join":10023,"filtered":"10.00","cost_info":{"read_cost":"9093.13","eval_cost":"1002.32","prefix_cost":"10095.45","data_read_per_join":"1M"},"used_columns":["id","join_key","filter_column_1","filter_column_2"],"attached_condition":"(`test`.`t`.`filter_column_1` = 'VALUE_A')"}},{"table":{"delete":true,"table_name":"o","access_type":"ref","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","ref":["test.t.join_key"],"rows_examined_per_scan":3,"rows_produced_per_join":38163,"filtered":"100.00","cost_info":{"read_cost":"2512.66","eval_cost":"3816.35","prefix_cost":"16424.46","data_read_per_join":"596K"},"used_columns":["id","join_key","target_flag"]}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/mysql57_delete_all_rows.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/mysql57_delete_all_rows.json
new file mode 100644
index 0000000000..250ed37d3c
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/mysql57_delete_all_rows.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"delete":true,"table_name":"big","access_type":"ALL","rows_examined_per_scan":10195,"filtered":"100.00","message":"Deleting all rows"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/not_exists_update.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/not_exists_update.json
new file mode 100644
index 0000000000..a74913dad7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/not_exists_update.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"54299.65"},"nested_loop":[{"table":{"update":true,"table_name":"o","access_type":"ALL","rows_examined_per_scan":399648,"rows_produced_per_join":39964,"filtered":"10.00","cost_info":{"read_cost":"36152.57","eval_cost":"3996.48","prefix_cost":"40149.05","data_read_per_join":"624K"},"used_columns":["id","join_key","target_flag"],"attached_condition":"(`test`.`o`.`target_flag` is null)"}},{"table":{"table_name":"t","access_type":"ref","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","ref":["test.o.join_key"],"rows_examined_per_scan":1,"rows_produced_per_join":39964,"filtered":"100.00","not_exists":true,"cost_info":{"read_cost":"10107.57","eval_cost":"3996.48","prefix_cost":"54299.65","data_read_per_join":"6M"},"used_columns":["join_key","filter_column_1"],"attached_condition":"(<if>(is_not_null_compl(t), (`test`.`t`.`filter_column_1` = 'VALUE_A'), true) and <if>(is_not_null_compl(t), <if>(found_match(t), false, true), true))"}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/order_limit_update.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/order_limit_update.json
new file mode 100644
index 0000000000..023b012176
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/order_limit_update.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"ordering_operation":{"using_filesort":true,"table":{"update":true,"table_name":"target_table","access_type":"range","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","ref":["const"],"rows_examined_per_scan":200,"filtered":"100.00","attached_condition":"(`test`.`target_table`.`join_key` < 50)"}}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/replace_select_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/replace_select_join.json
new file mode 100644
index 0000000000..560946e571
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/replace_select_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"406.80"},"table":{"replace":true,"table_name":"big2","access_type":"ALL"},"insert_from":{"nested_loop":[{"table":{"table_name":"s","access_type":"ALL","possible_keys":["PRIMARY"],"rows_examined_per_scan":100,"rows_produced_per_join":10,"filtered":"10.00","cost_info":{"read_cost":"9.25","eval_cost":"1.00","prefix_cost":"10.25","data_read_per_join":"80"},"used_columns":["id","flag"],"attached_condition":"(`probe`.`s`.`flag` = 1)"}},{"table":{"table_name":"big","access_type":"ref","possible_keys":["idx_s"],"key":"idx_s","used_key_parts":["s_id"],"key_length":"4","ref":["probe.s.id"],"rows_examined_per_scan":113,"rows_produced_per_join":1133,"filtered":"100.00","cost_info":{"read_cost":"283.25","eval_cost":"113.30","prefix_cost":"406.80","data_read_per_join":"17K"},"used_columns":["id","s_id","v"]}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/select_for_update_filter.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/select_for_update_filter.json
new file mode 100644
index 0000000000..400efad569
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/select_for_update_filter.json
@@ -0,0 +1,25 @@
+{
+ "query_block": {
+ "select_id": 1,
+ "cost_info": {
+ "query_cost": "101.75"
+ },
+ "table": {
+ "table_name": "t",
+ "access_type": "ALL",
+ "rows_examined_per_scan": 1000,
+ "rows_produced_per_join": 100,
+ "filtered": "10.00",
+ "cost_info": {
+ "read_cost": "91.75",
+ "eval_cost": "10.00",
+ "prefix_cost": "101.75",
+ "data_read_per_join": "10K"
+ },
+ "used_columns": [
+ "d"
+ ],
+ "attached_condition": "(`probe`.`t`.`d` = 3)"
+ }
+ }
+}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/select_only.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/select_only.json
new file mode 100644
index 0000000000..69bb7b8ae7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/select_only.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"90.26"},"table":{"table_name":"target_table","access_type":"range","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","rows_examined_per_scan":200,"rows_produced_per_join":200,"filtered":"100.00","index_condition":"(`test`.`target_table`.`join_key` < 50)","cost_info":{"read_cost":"70.26","eval_cost":"20.00","prefix_cost":"90.26","data_read_per_join":"3K"},"used_columns":["id","join_key","target_flag"]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/semijoin_update.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/semijoin_update.json
new file mode 100644
index 0000000000..273c7ad565
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/semijoin_update.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"14332.59"},"duplicates_removal":{"using_temporary_table":true,"nested_loop":[{"table":{"table_name":"t","access_type":"ALL","possible_keys":["idx_join_key"],"rows_examined_per_scan":100232,"rows_produced_per_join":3006,"filtered":"3.00","cost_info":{"read_cost":"9794.75","eval_cost":"300.70","prefix_cost":"10095.45","data_read_per_join":"516K"},"used_columns":["join_key","filter_column_1","filter_column_2"],"attached_condition":"((`test`.`t`.`filter_column_1` = 'VALUE_A') and (`test`.`t`.`filter_column_2` in ('VALUE_B','VALUE_C','VALUE_D')))"}},{"table":{"update":true,"table_name":"o","access_type":"ref","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","ref":["test.t.join_key"],"rows_examined_per_scan":3,"rows_produced_per_join":1144,"filtered":"10.00","cost_info":{"read_cost":"2862.26","eval_cost":"114.49","prefix_cost":"14332.59","data_read_per_join":"17K"},"used_columns":["id","join_key","target_flag"],"attached_condition":"(`test`.`o`.`target_flag` is null)"}}]}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/single_delete.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/single_delete.json
new file mode 100644
index 0000000000..711eb9767a
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/single_delete.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"table":{"delete":true,"table_name":"target_table","access_type":"range","possible_keys":["idx_join_key"],"key":"idx_join_key","used_key_parts":["join_key"],"key_length":"4","ref":["const"],"rows_examined_per_scan":200,"filtered":"100.00","attached_condition":"(`test`.`target_table`.`join_key` < 50)"}}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/update_derived_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_derived_join.json
new file mode 100644
index 0000000000..855666c036
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_derived_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"3601.75"},"nested_loop":[{"table":{"update":true,"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.75","eval_cost":"100.00","prefix_cost":"101.75","data_read_per_join":"101K"},"used_columns":["id","c","d","grp","v"]}},{"table":{"table_name":"g","access_type":"ref","possible_keys":["<auto_key0>"],"key":"<auto_key0>","used_key_parts":["grp"],"key_length":"4","ref":["probe.t.grp"],"rows_examined_per_scan":10,"rows_produced_per_join":10000,"filtered":"100.00","cost_info":{"read_cost":"2500.00","eval_cost":"1000.00","prefix_cost":"3601.75","data_read_per_join":"234K"},"used_columns":["grp","cnt"],"materialized_from_subquery":{"using_temporary_table":true,"dependent":false,"cacheable":true,"query_block":{"select_id":2,"cost_info":{"query_cost":"101.75"},"grouping_operation":{"using_temporary_table":true,"using_filesort":false,"table":{"table_name":"t","access_type":"ALL","rows_examined_per_scan":1000,"rows_produced_per_join":1000,"filtered":"100.00","cost_info":{"read_cost":"1.75","eval_cost":"100.00","prefix_cost":"101.75","data_read_per_join":"101K"},"used_columns":["id","grp"]}}}}}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/update_impossible_where.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_impossible_where.json
new file mode 100644
index 0000000000..fa8e537378
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_impossible_where.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"message":"Impossible WHERE"}}
diff --git a/backend/plugin/parser/oceanbase/test-data/explain-plan/update_target_first_straight_join.json b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_target_first_straight_join.json
new file mode 100644
index 0000000000..5d6aff7284
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/explain-plan/update_target_first_straight_join.json
@@ -0,0 +1 @@
+{"query_block":{"select_id":1,"cost_info":{"query_cost":"5122.75"},"nested_loop":[{"table":{"update":true,"table_name":"big","access_type":"ALL","possible_keys":["idx_s"],"rows_examined_per_scan":11330,"rows_produced_per_join":11330,"filtered":"100.00","cost_info":{"read_cost":"24.25","eval_cost":"1133.00","prefix_cost":"1157.25","data_read_per_join":"177K"},"used_columns":["id","s_id","v"]}},{"table":{"table_name":"s","access_type":"eq_ref","possible_keys":["PRIMARY"],"key":"PRIMARY","used_key_parts":["id"],"key_length":"4","ref":["probe.big.s_id"],"rows_examined_per_scan":1,"rows_produced_per_join":1133,"filtered":"10.00","cost_info":{"read_cost":"2832.50","eval_cost":"113.30","prefix_cost":"5122.75","data_read_per_join":"8K"},"used_columns":["id","flag"],"attached_condition":"(`probe`.`s`.`flag` = 1)"}}]}}
diff --git a/backend/plugin/parser/oceanbase/test-data/query-span/case_insensitive.yaml b/backend/plugin/parser/oceanbase/test-data/query-span/case_insensitive.yaml
new file mode 100644
index 0000000000..8d5b2a1a26
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/query-span/case_insensitive.yaml
@@ -0,0 +1,43 @@
+- description: Test Case Insensitive
+ statement: SELECT * FROM T;
+ defaultDatabase: db
+ ignoreCaseSensitive: true
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: T
+ column: ""
+ predicatecolumns: []
diff --git a/backend/plugin/parser/oceanbase/test-data/query-span/query_type.yaml b/backend/plugin/parser/oceanbase/test-data/query-span/query_type.yaml
new file mode 100644
index 0000000000..654350d666
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/query-span/query_type.yaml
@@ -0,0 +1,121 @@
+- description: explain analyze query
+ statement: explain analyze select * from t
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 1
+ results: []
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Treat set statement as select
+ statement: SET CHARSET DEFAULT;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 1
+ results: []
+ sourcecolumns: []
+ predicatecolumns: []
+- description: system query
+ statement: select * from mysql.user
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 3
+ results: []
+ sourcecolumns: []
+ predicatecolumns: []
+- description: show query
+ statement: show databases
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 3
+ results: []
+ sourcecolumns: []
+ predicatecolumns: []
+- description: explain query
+ statement: explain select * from t
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 2
+ results: []
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: standard query
+ statement: select * from t where a > 0
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 1
+ results: []
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: ddl
+ statement: create table t(a int);
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 4
+ results: []
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: dml
+ statement: insert into t values(1);
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db"
+ }
+ querySpan:
+ type: 5
+ results: []
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
diff --git a/backend/plugin/parser/oceanbase/test-data/query-span/standard.yaml b/backend/plugin/parser/oceanbase/test-data/query-span/standard.yaml
new file mode 100644
index 0000000000..789a4d03f2
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/query-span/standard.yaml
@@ -0,0 +1,1443 @@
+- description: Test For JSON TABLE and JSON ARRAYAGG
+ statement: |-
+ SELECT
+ product_info,
+ JSON_ARRAYAGG(
+ REPLACE(
+ JSON_UNQUTED(product_name),
+ 'G',
+ 'GN'
+ )
+ )
+ FROM products,
+ JSON_TABLE(product_info,
+ '$' COLUMNS (
+ product_id INT PATH '$.id',
+ product_name VARCHAR(50) PATH '$.name',
+ product_price DECIMAL(10, 2) PATH '$.price'
+ )
+ ) AS jt;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "products",
+ "columns": [
+ {
+ "name": "product_info"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: product_info
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: |-
+ JSON_ARRAYAGG(
+ REPLACE(
+ JSON_UNQUTED(product_name),
+ 'G',
+ 'GN'
+ )
+ )
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: ""
+ predicatecolumns: []
+- description: Test For json table
+ statement: |-
+ SELECT *
+ FROM products,
+ JSON_TABLE(product_info,
+ '$' COLUMNS (
+ product_id INT PATH '$.id',
+ product_name VARCHAR(50) PATH '$.name',
+ product_price DECIMAL(10, 2) PATH '$.price'
+ )
+ ) AS jt;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "products",
+ "columns": [
+ {
+ "name": "product_info"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: product_info
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: product_id
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: product_name
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: product_price
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: product_info
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: products
+ column: ""
+ predicatecolumns: []
+- description: Test For alias.* with join
+ statement: SELECT t1.*, t2.* FROM t t1 JOIN (select * from t) t2 ON t1.a = t2.a;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Test For Explain statements
+ statement: EXPLAIN SELECT 1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 2
+ results: []
+ sourcecolumns: []
+ predicatecolumns: []
+- description: Test for simple select const
+ statement: SELECT 1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: "1"
+ sourcecolumns: []
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns: []
+ predicatecolumns: []
+- description: Test asterisk and column
+ statement: SELECT *, a FROM t;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Happy path for a simple select statement
+ statement: SELECT * FROM t
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Referenced table fields by different format
+ statement: SELECT a, t.b, t.c, db.t.d FROM t;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Scalar subquery in select fields
+ statement: SELECT 1 AS col_1, (SELECT(2)) AS col_2, (SELECT AVG(a + b * c) FROM t) AS avg_a_b_c FROM t;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: col_1
+ sourcecolumns: []
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: col_2
+ sourcecolumns: []
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: avg_a_b_c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Multiple-Row subquery in where clause
+ statement: SELECT 1 FROM t WHERE a IN (SELECT a FROM t);
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: "1"
+ sourcecolumns: []
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Correlated subquery in the target field clause.
+ statement: SELECT city, (SELECT COUNT(*) FROM paintings p WHERE g.id = p.gallery_id) AS total_paintings FROM galleries g;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "galleries",
+ "columns": [
+ {
+ "name": "id"
+ },
+ {
+ "name": "city"
+ }
+ ]
+ },
+ {
+ "name": "paintings",
+ "columns": [
+ {
+ "name": "gallery_id"
+ },
+ {
+ "name": "artist_id"
+ },
+ {
+ "name": "title"
+ },
+ {
+ "name": "price"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: city
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: galleries
+ column: city
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: total_paintings
+ sourcecolumns: []
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: galleries
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: paintings
+ column: ""
+ predicatecolumns: []
+- description: Test for functions
+ statement: SELECT max(a), a-b AS c1, a=b AS c2, a>b, b in (a, c, d) from (SELECT * FROM t) result;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: max(a)
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c1
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c2
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: a>b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b in (a, c, d)
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Test for SELECT partial FROM JOIN clause
+ statement: SELECT t1.*, t2.c, 0 FROM t1 JOIN t2 ON 1 = 1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t1",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ }
+ ]
+ },
+ {
+ "name": "t2",
+ "columns": [
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t2
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: "0"
+ sourcecolumns: []
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: t2
+ column: ""
+ predicatecolumns: []
+- description: Test for JOIN with USING clause
+ statement: SELECT * FROM t AS t1 JOIN t AS t2 USING(a);
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ predicatecolumns: []
+- description: Simple CTE
+ statement: WITH t1 AS (SELECT * FROM t) SELECT * FROM t1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: ""
+ predicatecolumns: []
+- description: Multi-level CTE
+ statement: WITH tt2 AS (WITH tt2 AS (SELECT * FROM t) SELECT MAX(a) FROM tt2) SELECT * FROM tt2;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: MAX(a)
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: tt2
+ column: ""
+ predicatecolumns: []
+- description: Test for CTE rename fields name
+ statement: WITH t1(d, c, b, a) AS (SELECT * FROM t) SELECT * FROM t1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: d
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: b
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: a
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: true
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: ""
+ predicatecolumns: []
+- description: Test for Recursive Common Table Expression dependent closures
+ statement: WITH RECURSIVE t1(cc1, cc2, cc3, n) AS (SELECT a AS c1, b AS c2, c AS c3, 1 AS n FROM t UNION SELECT cc1*cc2, cc2 + cc1, cc3 * cc2, n+1 FROM t1 WHERE n < 10) SELECT * FROM t1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: cc1
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: cc2
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: cc3
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: "n"
+ sourcecolumns: []
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: ""
+ predicatecolumns: []
+- description: Test for Non-Recursive Common Table Expression with RECURSIVE key words
+ statement: WITH RECURSIVE t1 AS (SELECT 1 AS c1, 2 AS c2, 3 AS c3, 4 AS c4 UNION SELECT a, b, d, c FROM t) SELECT * FROM t1;
+ defaultDatabase: db
+ metadata: |-
+ {
+ "name": "db",
+ "schemas": [
+ {
+ "name": "",
+ "tables": [
+ {
+ "name": "t",
+ "columns": [
+ {
+ "name": "a"
+ },
+ {
+ "name": "b"
+ },
+ {
+ "name": "c"
+ },
+ {
+ "name": "d"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ querySpan:
+ type: 1
+ results:
+ - name: c1
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: a
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c2
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: b
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c3
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: d
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ - name: c4
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: c
+ isplainfield: false
+ sourcefieldpaths: []
+ selectasterisk: false
+ sourcecolumns:
+ - server: ""
+ database: db
+ schema: ""
+ table: t
+ column: ""
+ - server: ""
+ database: db
+ schema: ""
+ table: t1
+ column: ""
+ predicatecolumns: []
diff --git a/backend/plugin/parser/oceanbase/test-data/test_backup.yaml b/backend/plugin/parser/oceanbase/test-data/test_backup.yaml
new file mode 100644
index 0000000000..c871d2cccf
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/test_backup.yaml
@@ -0,0 +1,467 @@
+- input: |-
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 1;
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 2;
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 3;
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 4;
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 5;
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1 and test.b1 = 6;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 1
+ UNION DISTINCT
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 2
+ UNION DISTINCT
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 3
+ UNION DISTINCT
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 4
+ UNION DISTINCT
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 5
+ UNION DISTINCT
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1 and test.b1 = 6;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 18
+ column: 79
+- input: |-
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) DELETE FROM test USING test JOIN t_cte WHERE test.b1 = t_cte.b1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test JOIN t_cte WHERE test.b1 = t_cte.b1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 3
+ column: 67
+- input: |-
+ WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) UPDATE test, t_cte SET test.c1 = 1 WHERE test.b1 = t_cte.b1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` WITH t_cte AS (
+ SELECT * FROM test WHERE test.b1 > 10
+ ) SELECT `test`.* FROM test, t_cte WHERE test.b1 = t_cte.b1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 3
+ column: 63
+- input: |-
+ UPDATE test SET test.c1 = 1 WHERE test.b1 = 1;
+ UPDATE test SET test.c1 = 2 WHERE test.b1 = 2;
+ UPDATE test SET test.c1 = 3 WHERE test.b1 = 3;
+ UPDATE test SET test.c1 = 4 WHERE test.b1 = 4;
+ UPDATE test SET test.c1 = 5 WHERE test.b1 = 5;
+ UPDATE test SET test.c1 = 6 WHERE test.b1 = 6;
+ UPDATE test SET test.c1 = 7 WHERE test.b1 = 7;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `test`.* FROM test WHERE test.b1 = 1
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 2
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 3
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 4
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 5
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 6
+ UNION DISTINCT
+ SELECT `test`.* FROM test WHERE test.b1 = 7;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 7
+ column: 47
+- input: UPDATE t_generated SET a = 1 WHERE a = 2;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t_generated_db` LIKE `db`.`t_generated`;
+ INSERT INTO `backupDB`.`_rollback_t_generated_db` (`a`,`b`) SELECT `t_generated`.`a`,`t_generated`.`b` FROM t_generated WHERE a = 2;
+ sourceschema: ""
+ sourcetablename: t_generated
+ targettablename: _rollback_t_generated_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 42
+- input: |-
+ UPDATE db1.t1 SET c1 = 1 WHERE c1 = 2;
+ UPDATE db2.t2 SET c1 = 1 WHERE c1 = 2;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t1_db1` LIKE `db1`.`t1`;
+ INSERT INTO `backupDB`.`_rollback_t1_db1` SELECT `t1`.* FROM db1.t1 WHERE c1 = 2;
+ sourceschema: ""
+ sourcetablename: t1
+ targettablename: _rollback_t1_db1
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 39
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t2_db2` LIKE `db2`.`t2`;
+ INSERT INTO `backupDB`.`_rollback_t2_db2` SELECT `t2`.* FROM db2.t2 WHERE c1 = 2;
+ sourceschema: ""
+ sourcetablename: t2
+ targettablename: _rollback_t2_db2
+ startposition:
+ line: 1
+ column: 39
+ endposition:
+ line: 2
+ column: 39
+- input: DELETE test FROM test, test2 as t2 where test.id = t2.id;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `test`.* FROM test, test2 as t2 where test.id = t2.id;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 58
+- input: DELETE t1, t2 FROM test as t1, test2 as t2 WHERE t1.id = t2.id;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test2_db` LIKE `db`.`test2`;
+ INSERT INTO `backupDB`.`_rollback_test2_db` SELECT `t2`.* FROM test as t1, test2 as t2 WHERE t1.id = t2.id;
+ sourceschema: ""
+ sourcetablename: test2
+ targettablename: _rollback_test2_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 64
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test as t1, test2 as t2 WHERE t1.id = t2.id;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 64
+- input: DELETE FROM t1, t2 USING test as t1, test2 as t2 WHERE t1.id = t2.id;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test2_db` LIKE `db`.`test2`;
+ INSERT INTO `backupDB`.`_rollback_test2_db` SELECT `t2`.* FROM test as t1, test2 as t2 WHERE t1.id = t2.id;
+ sourceschema: ""
+ sourcetablename: test2
+ targettablename: _rollback_test2_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 70
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test as t1, test2 as t2 WHERE t1.id = t2.id;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 70
+- input: DELETE FROM test as t1 WHERE t1.c1 = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test as t1 WHERE t1.c1 = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 40
+- input: DELETE FROM test WHERE c1 = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `test`.* FROM test WHERE c1 = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 31
+- input: UPDATE test x SET x.c1 = 1 WHERE x.c1 = 1
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `x`.* FROM test x WHERE x.c1 = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 42
+- input: UPDATE test SET c1 = 1 WHERE c1=2;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `test`.* FROM test WHERE c1=2;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 35
+- input: UPDATE test t1, test2 t2 SET t1.c1 = 1 WHERE t1.c1 = t2.c1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1, test2 t2 WHERE t1.c1 = t2.c1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 60
+- input: UPDATE test t1, test2 t2 SET t1.c1 = 1, t2.c2 = 2 WHERE t1.c1 = t2.c1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test2_db` LIKE `db`.`test2`;
+ INSERT INTO `backupDB`.`_rollback_test2_db` SELECT `t2`.* FROM test t1, test2 t2 WHERE t1.c1 = t2.c1;
+ sourceschema: ""
+ sourcetablename: test2
+ targettablename: _rollback_test2_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 71
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1, test2 t2 WHERE t1.c1 = t2.c1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 71
+- input: UPDATE test t1 INNER JOIN test2 t2 ON t1.a = t2.a SET c = 1 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test2_db` LIKE `db`.`test2`;
+ INSERT INTO `backupDB`.`_rollback_test2_db` SELECT `t2`.* FROM test t1 INNER JOIN test2 t2 ON t1.a = t2.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: test2
+ targettablename: _rollback_test2_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 76
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1 INNER JOIN test2 t2 ON t1.a = t2.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 76
+- input: UPDATE test t1 INNER JOIN test2 t2 ON t1.a = t2.a SET t1.c = 1 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1 INNER JOIN test2 t2 ON t1.a = t2.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 79
+- input: UPDATE test t1 INNER JOIN test2 t2 ON t1.a = t2.a SET t1.c = 1, t2.c = 2 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test2_db` LIKE `db`.`test2`;
+ INSERT INTO `backupDB`.`_rollback_test2_db` SELECT `t2`.* FROM test t1 INNER JOIN test2 t2 ON t1.a = t2.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: test2
+ targettablename: _rollback_test2_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 89
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1 INNER JOIN test2 t2 ON t1.a = t2.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 89
+- input: UPDATE t1 INNER JOIN t3 ON t1.a = t3.a SET c = 1 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t1_db` LIKE `db`.`t1`;
+ INSERT INTO `backupDB`.`_rollback_t1_db` SELECT `t1`.* FROM t1 INNER JOIN t3 ON t1.a = t3.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: t1
+ targettablename: _rollback_t1_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 65
+- input: UPDATE t1 INNER JOIN t3 ON t1.a = t3.a SET d = 1 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t3_db` LIKE `db`.`t3`;
+ INSERT INTO `backupDB`.`_rollback_t3_db` SELECT `t3`.* FROM t1 INNER JOIN t3 ON t1.a = t3.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: t3
+ targettablename: _rollback_t3_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 65
+- input: UPDATE t1 INNER JOIN t3 ON t1.a = t3.a SET c = 1, t3.d = 2 WHERE t1.a = 1;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t1_db` LIKE `db`.`t1`;
+ INSERT INTO `backupDB`.`_rollback_t1_db` SELECT `t1`.* FROM t1 INNER JOIN t3 ON t1.a = t3.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: t1
+ targettablename: _rollback_t1_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 75
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_t3_db` LIKE `db`.`t3`;
+ INSERT INTO `backupDB`.`_rollback_t3_db` SELECT `t3`.* FROM t1 INNER JOIN t3 ON t1.a = t3.a WHERE t1.a = 1;
+ sourceschema: ""
+ sourcetablename: t3
+ targettablename: _rollback_t3_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 1
+ column: 75
+- input: |-
+ UPDATE test t1 SET t1.c1 = 2 WHERE t1.c1 = 1 ;
+ UPDATE test t2 SET t2.c1 = 3 WHERE t2.c1 = 5 ;
+ result:
+ - statement: |-
+ CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;
+ INSERT INTO `backupDB`.`_rollback_test_db` SELECT `t1`.* FROM test t1 WHERE t1.c1 = 1
+ UNION DISTINCT
+ SELECT `t2`.* FROM test t2 WHERE t2.c1 = 5;
+ sourceschema: ""
+ sourcetablename: test
+ targettablename: _rollback_test_db
+ startposition:
+ line: 1
+ column: 1
+ endposition:
+ line: 2
+ column: 47
diff --git a/backend/plugin/parser/oceanbase/test-data/test_completion.yaml b/backend/plugin/parser/oceanbase/test-data/test_completion.yaml
new file mode 100644
index 0000000000..bff932abb5
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/test_completion.yaml
@@ -0,0 +1,5313 @@
+- input: |-
+ select count(1) from t1 where id 'asdfsadf'; SELECT * FROM |
+ select * from QRTZ_J0B_DETAILS qjd where J0B_NAME like '%gray';
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO t1(|);
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO t2(c1, |);
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x(x1, x2) AS (SELECT * FROM t2) SELECT x.| FROM x;
+ want:
+ - text: x1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x(x1, x2) AS (SELECT * FROM t2) SELECT | FROM x
+ want:
+ - text: x1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as eid, c2 as xid FROM t2 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: eid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: xid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as eid FROM t1 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: eid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM basdkfjasldf;SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT c1 FROM t1) cc1(cc1c1)
+ want:
+ - text: cc1c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: cc1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT c1 FROM t1) cc1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: cc1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT
+ FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT
+
+ FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM t1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM t1 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM t1 GROUP BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT FROM t1 JOIN |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE t1 SET |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DELETE FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP TABLE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 JOIN |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1, |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * from t1 cc1 JOIN t2 on cc1.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT MAX(cc1.|) FROM t2 cc1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t2 x
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT DISTINCT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t2 LIMIT 10
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1, | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT
+ |
+ FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT *
+ FROM
+ |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM /* comment */ |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT * FROM t1 -- comment
+ WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t2 FOR UPDATE
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT t1.| FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT cc1.| FROM t2 cc1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT cc1.| FROM t1 cc1 JOIN t2 ON NOT cc1.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT db.t2.| FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT a.| FROM t1 a JOIN t1 b ON a.c1 = b.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT b.| FROM t1 a JOIN t1 b ON a.c1 = b.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT COUNT(|) FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 JOIN t2 ON t1.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 cc1 JOIN t2 ON cc1.c1 = t2.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 LEFT JOIN t2 ON t1.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 RIGHT JOIN t2 ON t1.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 CROSS JOIN t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 NATURAL JOIN t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 a JOIN t2 b ON a.c1 = b.c1 JOIN t2 c ON b.c1 = c.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: a
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: b
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c.| FROM t1 a JOIN t2 b ON a.c1 = b.c1 JOIN t2 c ON b.c1 = c.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 RIGHT JOIN t2 ON t1.c1 = t2.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 CROSS JOIN t2 WHERE t1.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 JOIN t2 ON t1.c1 = t2.c1 LEFT JOIN t2 t3 ON t2.c1 = t3.c1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t3
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT a.| FROM t1 a NATURAL JOIN t2 b
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 LEFT JOIN |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t1 JOIN t2 ON t1.c1 = t2.c1 LEFT JOIN t2 t3 ON t2.c1 = t3.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t3
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 JOIN t2 USING (|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT x.| FROM (SELECT * FROM t2) x
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT * FROM (SELECT c1 FROM t1) inner_q) outer_q
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: outer_q
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT c1 FROM t1) sub1 JOIN t2 ON sub1.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: sub1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT c1 FROM (SELECT c1 FROM (SELECT c1 FROM t1) a) b) c
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT b.| FROM (SELECT * FROM (SELECT c1 FROM t1) a) b
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: (SELECT c1 FROM t1) UNION (SELECT | FROM t2)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE c1 IN (SELECT | FROM t2)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE EXISTS (SELECT | FROM t2)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE c1 = (SELECT MAX(|) FROM t2)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 x WHERE x.c1 IN (SELECT c1 FROM t2 WHERE |)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE EXISTS (SELECT 1 FROM t2 WHERE t2.c1 = t1.|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT (SELECT | FROM t1) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH a AS (SELECT c1 FROM t1), b AS (SELECT c1, c2 FROM t2) SELECT | FROM a JOIN b ON a.c1 = b.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: a
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: b
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH a AS (SELECT c1 FROM t1), b AS (SELECT c1, c2 FROM t2) SELECT b.| FROM a JOIN b ON a.c1 = b.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT c1 FROM t1) SELECT | FROM (SELECT * FROM x) sub1
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: sub1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: With a AS (SELECT c1 FROM t1), b AS (SELECT * FROM a) SELECT | FROM b
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: a
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: b
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: With a AS (SELECT c1 FROM t1), b AS (SELECT a.| FROM a) SELECT * FROM b
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT c1 FROM t1) SELECT | FROM x, t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT c1 FROM t1) SELECT x.| FROM x JOIN t2 ON x.c1 = t2.c1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x(a, b) AS (SELECT c1, c2 FROM t2) SELECT | FROM x JOIN t1 ON x.a = t1.c1
+ want:
+ - text: a
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: b
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT * FROM t2) INSERT INTO t1 SELECT | FROM x
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT c1, c2 FROM t2) UPDATE t1 SET c1 = (SELECT | FROM x)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT * FROM t2) DELETE FROM t1 WHERE c1 IN (SELECT | FROM x)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH RECURSIVE x AS (SELECT c1 FROM t1 UNION ALL SELECT c1 FROM x) SELECT | FROM x
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: x
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: WITH x AS (SELECT c1 FROM t1 UNION SELECT c1 FROM t2) SELECT x.| FROM x
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 = 1 AND |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE (c1 = 1 AND |)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 IS NOT NULL AND |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 IS NULL OR |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE NOT |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 > |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 + | > 0
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 IN (1, 2) AND |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 BETWEEN | AND c2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 BETWEEN c2 AND |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE c1 LIKE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 WHERE CASE WHEN c1 > 0 THEN | END = 1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 a JOIN t2 b ON a.c1 = b.c1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: a
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: b
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 a JOIN t2 b ON a.c1 = b.c1 WHERE a.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT
+ FROM t1
+ WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as eid FROM t1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as eid FROM t1 GROUP BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: eid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as eid, c2 as xid FROM t2 HAVING |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: eid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: xid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 UNION SELECT c1 FROM t2 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 UNION ALL SELECT c1 FROM t2 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 LIMIT |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 ORDER BY c1 LIMIT |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO t1 SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO t1 VALUES (|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT 1; INSERT INTO |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE | SET c1 = 1
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE t1 SET c1 = |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE t1 SET c1 = 1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DELETE FROM db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DELETE FROM t1 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT 1; UPDATE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT 1; DELETE FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DELETE FROM t1 WHERE c1 > 0 AND |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 ADD COLUMN c2 int REFERENCES |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 DROP COLUMN |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 RENAME COLUMN | TO new_name
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 MODIFY COLUMN |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 ADD CONSTRAINT fk FOREIGN KEY (|) REFERENCES t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 ADD CONSTRAINT fk FOREIGN KEY (c1) REFERENCES t2(|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP TABLE db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP TABLE IF EXISTS |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP VIEW |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP INDEX |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+- input: TRUNCATE TABLE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE TABLE t3 (id int, FOREIGN KEY (id) REFERENCES |)
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE TABLE t3 (id int REFERENCES t1(|))
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE INDEX idx ON |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE INDEX idx ON t1 (|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE INDEX idx ON t2 (c1, |)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE VIEW v2 AS SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE VIEW v2 AS SELECT * FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE TABLE t3 AS SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 UNION SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 UNION ALL SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 INTERSECT SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 EXCEPT SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 UNION SELECT c1 FROM t1 UNION SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 EXCEPT ALL SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 FROM t1 INTERSECT ALL SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM t2 UNION SELECT * FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM (SELECT c1 FROM t1 UNION SELECT c1 FROM t2) x WHERE x.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM (SELECT c1, c2 FROM t2 UNION SELECT c1, c2 FROM t2) sub
+ want:
+ - text: c1
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: sub
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INVALID SQL; SELECT * FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1; SELECT * FROM t2 WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT; SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE; SELECT | FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: CREATE TABLE x (id int); SELECT | FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT 1; UPDATE |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT 1; DELETE FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM db.t|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT t1.c|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: INSERT INTO t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: UPDATE t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DELETE FROM t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 JOIN t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE t1.c|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP TABLE t|
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM `t1`
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT `t1`.| FROM t1
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: SELECT * FROM `db`.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM `db`.`t1` WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: "SELECT\t|\tFROM t1"
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: 'SELECT * FROM t1 WHERE | '
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: |-
+ SELECT
+ *
+ FROM
+ t1
+ WHERE |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: /* leading comment */ SELECT * FROM |
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t1 WHERE c1 = /* inline */ |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT INTO `t1`(|)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1, SUM(c2) OVER (PARTITION BY |) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1, SUM(c2) OVER (ORDER BY |) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1, ROW_NUMBER() OVER (PARTITION BY | ORDER BY c1) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT COALESCE(|, 0) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT COALESCE(c1, |) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT NULLIF(|, 0) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT CAST(| AS int) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT IF(|, 1, 0) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT IFNULL(|, 0) FROM t2
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as 'eid' FROM t1 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: eid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT c1 as "xid" FROM t1 ORDER BY |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: xid
+ type: COLUMN
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT * FROM t2 AS Foo WHERE foo.|
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: c2
+ type: COLUMN
+ definition: t2 | , NOT NULL
+ comment: ""
+ priority: 0
+- input: WITH Foo AS (SELECT c1 FROM t1) SELECT foo.| FROM Foo
+ want:
+- input: ALTER TABLE t1 DROP COLUMN |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE t1 RENAME COLUMN | TO new_name
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: ALTER TABLE db.t1 DROP COLUMN |
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT IGNORE t1 (|) VALUES (1)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: INSERT IGNORE INTO t1 (|) VALUES (1)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: REPLACE INTO t1 (|) VALUES (1)
+ want:
+ - text: c1
+ type: COLUMN
+ definition: t1 | , NOT NULL
+ comment: ""
+ priority: 0
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: DROP VIEW db.|
+ want:
+ - text: t1
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: v1
+ type: VIEW
+ definition: ""
+ comment: ""
+ priority: 0
+- input: SELECT | FROM other_db.t2
+ want:
+ - text: db
+ type: DATABASE
+ definition: ""
+ comment: ""
+ priority: 0
+ - text: t2
+ type: TABLE
+ definition: ""
+ comment: ""
+ priority: 0
diff --git a/backend/plugin/parser/oceanbase/test-data/test_restore.yaml b/backend/plugin/parser/oceanbase/test-data/test_restore.yaml
new file mode 100644
index 0000000000..bf7612a2c0
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/test_restore.yaml
@@ -0,0 +1,141 @@
+- input: |-
+ UPDATE t_generated1111 SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET b = 1 WHERE a = 1;
+ UPDATE t_generated SET b = 2 WHERE a = 2;
+ UPDATE t_generated SET b = 3 WHERE a = 3;
+ UPDATE t_generated1111 SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET b = 4 WHERE a = 4;
+ UPDATE t_generated SET b = 5 WHERE a = 5;
+ UPDATE t_generated1111 SET a = 5 WHERE b = 5;
+ UPDATE t_generated SET b = 6 WHERE a = 6;
+ UPDATE t_generated SET b = 6 WHERE a = 6;
+ UPDATE t_generated111 SET a = 7 WHERE b = 7;
+ UPDATE t_generated SET b = 7 WHERE a = 7;
+ backupdatabase: bbarchive
+ backuptable: prefix_t_generated
+ originaldatabase: db
+ originaltable: t_generated
+ result: |-
+ /*
+ Original SQL:
+
+ UPDATE t_generated SET b = 1 WHERE a = 1;
+ UPDATE t_generated SET b = 2 WHERE a = 2;
+ UPDATE t_generated SET b = 3 WHERE a = 3;
+ UPDATE t_generated SET b = 4 WHERE a = 4;
+ UPDATE t_generated SET b = 5 WHERE a = 5;
+ UPDATE t_generated SET b = 6 WHERE a = 6;
+ UPDATE t_generated SET b = 6 WHERE a = 6;
+ UPDATE t_generated SET b = 7 WHERE a = 7;
+ */
+ INSERT INTO `db`.`t_generated` (`a`, `b`) SELECT `a`, `b` FROM `bbarchive`.`prefix_t_generated` ON DUPLICATE KEY UPDATE `b` = VALUES(`b`);
+- input: |-
+ UPDATE t_generated1111 SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET a = 2 WHERE b = 2;
+ UPDATE t_generated SET a = 3 WHERE b = 3;
+ UPDATE t_generated1111 SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET a = 5 WHERE b = 5;
+ UPDATE t_generated1111 SET a = 5 WHERE b = 5;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated111 SET a = 7 WHERE b = 7;
+ UPDATE t_generated SET a = 7 WHERE b = 7;
+ backupdatabase: bbarchive
+ backuptable: prefix_t_generated
+ originaldatabase: db
+ originaltable: t_generated
+ result: |-
+ /*
+ Original SQL:
+
+ UPDATE t_generated SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET a = 2 WHERE b = 2;
+ UPDATE t_generated SET a = 3 WHERE b = 3;
+ UPDATE t_generated SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET a = 5 WHERE b = 5;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated SET a = 7 WHERE b = 7;
+ */
+ INSERT INTO `db`.`t_generated` (`a`, `b`) SELECT `a`, `b` FROM `bbarchive`.`prefix_t_generated` ON DUPLICATE KEY UPDATE `a` = VALUES(`a`);
+- input: |-
+ UPDATE t_generated SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET a = 2 WHERE b = 2;
+ UPDATE t_generated SET a = 3 WHERE b = 3;
+ UPDATE t_generated SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET a = 5 WHERE b = 5;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated SET a = 7 WHERE b = 7;
+ backupdatabase: bbarchive
+ backuptable: prefix_t_generated
+ originaldatabase: db
+ originaltable: t_generated
+ result: |-
+ /*
+ Original SQL:
+ UPDATE t_generated SET a = 1 WHERE b = 1;
+ UPDATE t_generated SET a = 2 WHERE b = 2;
+ UPDATE t_generated SET a = 3 WHERE b = 3;
+ UPDATE t_generated SET a = 4 WHERE b = 4;
+ UPDATE t_generated SET a = 5 WHERE b = 5;
+ UPDATE t_generated SET a = 6 WHERE b = 6;
+ UPDATE t_generated SET a = 7 WHERE b = 7;
+ */
+ INSERT INTO `db`.`t_generated` (`a`, `b`) SELECT `a`, `b` FROM `bbarchive`.`prefix_t_generated` ON DUPLICATE KEY UPDATE `a` = VALUES(`a`);
+- input: DELETE FROM t_generated where a = 1;
+ backupdatabase: bbarchive
+ backuptable: prefix_1_t_generated
+ originaldatabase: db
+ originaltable: t_generated
+ result: |-
+ /*
+ Original SQL:
+ DELETE FROM t_generated where a = 1;
+ */
+ INSERT INTO `db`.`t_generated` (`a`, `b`) SELECT `a`, `b` FROM `bbarchive`.`prefix_1_t_generated`;
+- input: UPDATE t_generated SET a = 1 WHERE a = 2;
+ backupdatabase: bbarchive
+ backuptable: prefix_1_t_generated
+ originaldatabase: db
+ originaltable: t_generated
+ result: |-
+ /*
+ Original SQL:
+ UPDATE t_generated SET a = 1 WHERE a = 2;
+ */
+ INSERT INTO `db`.`t_generated` (`a`, `b`) SELECT `a`, `b` FROM `bbarchive`.`prefix_1_t_generated` ON DUPLICATE KEY UPDATE `a` = VALUES(`a`);
+- input: DELETE test FROM test, test2 as t2 where test.id = t2.id;
+ backupdatabase: bbarchive
+ backuptable: prefix_1_test
+ originaldatabase: db
+ originaltable: test
+ result: |-
+ /*
+ Original SQL:
+ DELETE test FROM test, test2 as t2 where test.id = t2.id;
+ */
+ INSERT INTO `db`.`test` (`a`, `b`, `c`) SELECT `a`, `b`, `c` FROM `bbarchive`.`prefix_1_test`;
+- input: UPDATE test x SET x.c = 1 WHERE x.c = 1;
+ backupdatabase: bbarchive
+ backuptable: prefix_1_test
+ originaldatabase: db
+ originaltable: test
+ result: |-
+ /*
+ Original SQL:
+ UPDATE test x SET x.c = 1 WHERE x.c = 1;
+ */
+ INSERT INTO `db`.`test` (`a`, `b`, `c`) SELECT `a`, `b`, `c` FROM `bbarchive`.`prefix_1_test` ON DUPLICATE KEY UPDATE `c` = VALUES(`c`);
+- input: UPDATE test SET a = 1 WHERE c = 1;
+ backupdatabase: bbarchive
+ backuptable: prefix_1_test
+ originaldatabase: db
+ originaltable: test
+ result: |-
+ /*
+ Original SQL:
+ UPDATE test SET a = 1 WHERE c = 1;
+ */
+ INSERT INTO `db`.`test` (`a`, `b`, `c`) SELECT `a`, `b`, `c` FROM `bbarchive`.`prefix_1_test` ON DUPLICATE KEY UPDATE `a` = VALUES(`a`);
diff --git a/backend/plugin/parser/oceanbase/test-data/test_split.yaml b/backend/plugin/parser/oceanbase/test-data/test_split.yaml
new file mode 100644
index 0000000000..776071e63b
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/test_split.yaml
@@ -0,0 +1,423 @@
+- description: DELIMITER with stored procedure
+ input: "\t\t\tDELIMITER ;;\n\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\tBEGIN\n\t\t\t\tDECLARE x INT;\n\t\t\t\tSET x = 0;\n\t\t\t\tlabel1: WHILE x < p1 DO\n\t\t\t\t\tSET x = x + 1;\n\t\t\t\tEND WHILE label1;\n\t\t\tEND;;\n\t\t\tDELIMITER ;\n\t\t\tCALL dorepeat(1000);\n\t\t\tSELECT x;\n\t\t\t"
+ result:
+ - text: "\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\tBEGIN\n\t\t\t\tDECLARE x INT;\n\t\t\t\tSET x = 0;\n\t\t\t\tlabel1: WHILE x < p1 DO\n\t\t\t\t\tSET x = x + 1;\n\t\t\t\tEND WHILE label1;\n\t\t\tEND;"
+ baseline: 1
+ start:
+ line: 2
+ column: 1
+ end:
+ line: 9
+ column: 8
+ range:
+ start: 16
+ end: 173
+ empty: false
+ - text: "\t\t\tCALL dorepeat(1000);"
+ baseline: 10
+ start:
+ line: 11
+ column: 1
+ end:
+ line: 11
+ column: 24
+ range:
+ start: 190
+ end: 213
+ empty: false
+ - text: "\n\t\t\tSELECT x;"
+ baseline: 10
+ start:
+ line: 11
+ column: 24
+ end:
+ line: 12
+ column: 13
+ range:
+ start: 213
+ end: 226
+ empty: false
+- description: escaped double quote in string
+ input: select * from t;select "\"" where true;
+ result:
+ - text: select * from t;
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 17
+ range:
+ start: 0
+ end: 16
+ empty: false
+ - text: select "\"" where true;
+ baseline: 0
+ start:
+ line: 1
+ column: 17
+ end:
+ line: 1
+ column: 40
+ range:
+ start: 16
+ end: 39
+ empty: false
+- description: comments only - empty segments filtered
+ input: "-- klsjdfjasldf\n\t\t\t-- klsjdflkjaskldfj\n"
+ result: []
+- description: statement followed by trailing block comment - trailing empty filtered
+ input: "select * from t;\n\t\t\t/* sdfasdf */"
+ result:
+ - text: select * from t;
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 17
+ range:
+ start: 0
+ end: 16
+ empty: false
+- description: statement then empty comment statement then statement - middle empty filtered
+ input: "select * from t;\n\t\t\t/* sdfasdf */;\n\t\t\tselect * from t;"
+ result:
+ - text: select * from t;
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 17
+ range:
+ start: 0
+ end: 16
+ empty: false
+ - text: "\n\t\t\tselect * from t;"
+ baseline: 1
+ start:
+ line: 2
+ column: 18
+ end:
+ line: 3
+ column: 20
+ range:
+ start: 34
+ end: 54
+ empty: false
+- description: 'position semantic: leading newlines'
+ input: "\n\nSELECT 1;"
+ result:
+ - text: "\n\nSELECT 1;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 3
+ column: 10
+ range:
+ start: 0
+ end: 11
+ empty: false
+- description: 'position semantic: leading spaces and newlines'
+ input: "\n \n SELECT 1;"
+ result:
+ - text: "\n \n SELECT 1;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 3
+ column: 12
+ range:
+ start: 0
+ end: 15
+ empty: false
+- description: 'position semantic: multi-statement with leading whitespace'
+ input: "SELECT 1;\n\n SELECT 2;"
+ result:
+ - text: SELECT 1;
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 10
+ range:
+ start: 0
+ end: 9
+ empty: false
+ - text: "\n\n SELECT 2;"
+ baseline: 0
+ start:
+ line: 1
+ column: 10
+ end:
+ line: 3
+ column: 12
+ range:
+ start: 9
+ end: 22
+ empty: false
+- description: function with BEGIN END block
+ input: "CREATE DEFINER=`root`@`%` FUNCTION `CalcIncome`( starting_value INT ) RETURNS int\nBEGIN\n\n\t\t DECLARE income INT;\n\n\t\t SET income = 0;\n\n\t\t label1: WHILE income <= 3000 DO\n\t\t\t SET income = income + starting_value;\n\t\t END WHILE label1;\n\n\t\t RETURN income;\n\n\t\tEND ;"
+ result:
+ - text: "CREATE DEFINER=`root`@`%` FUNCTION `CalcIncome`( starting_value INT ) RETURNS int\nBEGIN\n\n\t\t DECLARE income INT;\n\n\t\t SET income = 0;\n\n\t\t label1: WHILE income <= 3000 DO\n\t\t\t SET income = income + starting_value;\n\t\t END WHILE label1;\n\n\t\t RETURN income;\n\n\t\tEND ;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 14
+ column: 8
+ range:
+ start: 0
+ end: 268
+ empty: false
+- description: multiple statements with leading whitespace and no trailing semicolon
+ input: ' CREATE TABLE t(a int); CREATE TABLE t1(a int)'
+ result:
+ - text: ' CREATE TABLE t(a int);'
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 27
+ range:
+ start: 0
+ end: 26
+ empty: false
+ - text: ' CREATE TABLE t1(a int)'
+ baseline: 0
+ start:
+ line: 1
+ column: 27
+ end:
+ line: 1
+ column: 50
+ range:
+ start: 26
+ end: 49
+ empty: false
+- description: backtick identifiers with escaped strings
+ input: "CREATE TABLE `tech_Book`(id int, name varchar(255));\nINSERT INTO `tech_Book` VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');"
+ result:
+ - text: CREATE TABLE `tech_Book`(id int, name varchar(255));
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 53
+ range:
+ start: 0
+ end: 52
+ empty: false
+ - text: "\nINSERT INTO `tech_Book` VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');"
+ baseline: 0
+ start:
+ line: 1
+ column: 53
+ end:
+ line: 2
+ column: 79
+ range:
+ start: 52
+ end: 131
+ empty: false
+- description: block comment, line comment, and hash comment
+ input: "\t\t\t\t\t\t/* this is the comment. */\n\t\t\t\t\t\tCREATE /* inline comment */TABLE tech_Book(id int, name varchar(255));\n\t\t\t\t\t\t-- this is the comment.\n\t\t\t\t\t\tINSERT INTO tech_Book VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');\n\t\t\t\t\t\t# this is the comment.\n\t\t\t\t\t\tINSERT INTO tech_Book VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');"
+ result:
+ - text: "\t\t\t\t\t\t/* this is the comment. */\n\t\t\t\t\t\tCREATE /* inline comment */TABLE tech_Book(id int, name varchar(255));"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 2
+ column: 77
+ range:
+ start: 0
+ end: 109
+ empty: false
+ - text: "\n\t\t\t\t\t\t-- this is the comment.\n\t\t\t\t\t\tINSERT INTO tech_Book VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');"
+ baseline: 1
+ start:
+ line: 2
+ column: 77
+ end:
+ line: 4
+ column: 83
+ range:
+ start: 109
+ end: 222
+ empty: false
+ - text: "\n\t\t\t\t\t\t# this is the comment.\n\t\t\t\t\t\tINSERT INTO tech_Book VALUES (0, 'abce_ksdf'), (1, 'lks''kjsafa\\'jdfl;\"ka');"
+ baseline: 3
+ start:
+ line: 4
+ column: 83
+ end:
+ line: 6
+ column: 83
+ range:
+ start: 222
+ end: 334
+ empty: false
+- description: procedure with REPEAT and hash comment
+ input: "# test for defining stored programs\n\t\t\t\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\t\t\t\tBEGIN\n\t\t\t\t\t\t\tSET @x = 0;\n\t\t\t\t\t\t\tREPEAT SET @x = @x + 1; UNTIL @x > p1 END REPEAT;\n\t\t\t\t\t\tEND\n\t\t\t\t\t\t;\n\t\t\t\t\t\tCALL dorepeat(1000);\n\t\t\t\t\t\tSELECT @x;\n\t\t\t\t\t\t"
+ result:
+ - text: "# test for defining stored programs\n\t\t\t\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\t\t\t\tBEGIN\n\t\t\t\t\t\t\tSET @x = 0;\n\t\t\t\t\t\t\tREPEAT SET @x = @x + 1; UNTIL @x > p1 END REPEAT;\n\t\t\t\t\t\tEND\n\t\t\t\t\t\t;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 7
+ column: 8
+ range:
+ start: 0
+ end: 181
+ empty: false
+ - text: "\n\t\t\t\t\t\tCALL dorepeat(1000);"
+ baseline: 6
+ start:
+ line: 7
+ column: 8
+ end:
+ line: 8
+ column: 27
+ range:
+ start: 181
+ end: 208
+ empty: false
+ - text: "\n\t\t\t\t\t\tSELECT @x;"
+ baseline: 7
+ start:
+ line: 8
+ column: 27
+ end:
+ line: 9
+ column: 17
+ range:
+ start: 208
+ end: 225
+ empty: false
+- description: procedure with block comment inside
+ input: "# test for defining stored programs\n\t\t\t\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\t\t\t\t/* This is a comment */\n\t\t\t\t\t\tBEGIN\n\t\t\t\t\t\t\tSET @x = 0;\n\t\t\t\t\t\t\tREPEAT SET @x = @x + 1; UNTIL @x > p1 END REPEAT;\n\t\t\t\t\t\tEND\n\t\t\t\t\t\t;\n\t\t\t\t\t\tCALL dorepeat(1000);\n\t\t\t\t\t\tSELECT @x;\n\t\t\t\t\t\t"
+ result:
+ - text: "# test for defining stored programs\n\t\t\t\t\t\tCREATE PROCEDURE dorepeat(p1 INT)\n\t\t\t\t\t\t/* This is a comment */\n\t\t\t\t\t\tBEGIN\n\t\t\t\t\t\t\tSET @x = 0;\n\t\t\t\t\t\t\tREPEAT SET @x = @x + 1; UNTIL @x > p1 END REPEAT;\n\t\t\t\t\t\tEND\n\t\t\t\t\t\t;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 8
+ column: 8
+ range:
+ start: 0
+ end: 211
+ empty: false
+ - text: "\n\t\t\t\t\t\tCALL dorepeat(1000);"
+ baseline: 7
+ start:
+ line: 8
+ column: 8
+ end:
+ line: 9
+ column: 27
+ range:
+ start: 211
+ end: 238
+ empty: false
+ - text: "\n\t\t\t\t\t\tSELECT @x;"
+ baseline: 8
+ start:
+ line: 9
+ column: 27
+ end:
+ line: 10
+ column: 17
+ range:
+ start: 238
+ end: 255
+ empty: false
+- description: trailing whitespace after last semicolon - empty filtered
+ input: "SELECT 1;\n\t\t\t"
+ result:
+ - text: "SELECT 1;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 10
+ range:
+ start: 0
+ end: 9
+ empty: false
+- description: CRLF line endings
+ input: "CREATE TABLE t\r\n(a int);\r\nCREATE TABLE t1(b int);"
+ result:
+ - text: "CREATE TABLE t\r\n(a int);"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 2
+ column: 9
+ range:
+ start: 0
+ end: 24
+ empty: false
+ - text: "\r\nCREATE TABLE t1(b int);"
+ baseline: 1
+ start:
+ line: 2
+ column: 9
+ end:
+ line: 3
+ column: 24
+ range:
+ start: 24
+ end: 49
+ empty: false
+- description: unicode in table names
+ input: "SELECT * FROM \u8868\u540D; INSERT INTO \u8868 VALUES (1);"
+ result:
+ - text: "SELECT * FROM \u8868\u540D;"
+ baseline: 0
+ start:
+ line: 1
+ column: 1
+ end:
+ line: 1
+ column: 18
+ range:
+ start: 0
+ end: 21
+ empty: false
+ - text: " INSERT INTO \u8868 VALUES (1);"
+ baseline: 0
+ start:
+ line: 1
+ column: 18
+ end:
+ line: 1
+ column: 44
+ range:
+ start: 21
+ end: 49
+ empty: false
diff --git a/backend/plugin/parser/oceanbase/test-data/test_statement_type.yaml b/backend/plugin/parser/oceanbase/test-data/test_statement_type.yaml
new file mode 100644
index 0000000000..d62514efa7
--- /dev/null
+++ b/backend/plugin/parser/oceanbase/test-data/test_statement_type.yaml
@@ -0,0 +1,70 @@
+- statement: |-
+ UPDATE items,
+ (SELECT id FROM items
+ WHERE id IN
+ (SELECT id FROM items
+ WHERE retail / wholesale >= 1.3 AND quantity < 100))
+ AS discounted
+ SET items.retail = items.retail * 0.9
+ WHERE items.id = discounted.id;
+ want:
+ - UPDATE
+- statement: |-
+ INSERT INTO tbl_temp2 (fld_id)
+ SELECT tbl_temp1.fld_order_id
+ FROM tbl_temp1 WHERE tbl_temp1.fld_order_id > 100;
+ want:
+ - INSERT
+- statement: |-
+ CREATE FUNCTION hello (s CHAR(20))
+ RETURNS CHAR(50) DETERMINISTIC
+ RETURN CONCAT('Hello, ',s,'!');
+ want:
+ - CREATE_FUNCTION
+- statement: |-
+ CREATE PROCEDURE citycount (IN country CHAR(3), OUT cities INT)
+ BEGIN
+ SELECT COUNT(*) INTO cities FROM world.city
+ WHERE CountryCode = country;
+ END;
+ want:
+ - CREATE_PROCEDURE
+- statement: CREATE TABLE t1 (a INT);
+ want:
+ - CREATE_TABLE
+- statement: CREATE TABLE t2 LIKE t1;
+ want:
+ - CREATE_TABLE
+- statement: CREATE TABLE t2 SELECT * FROM t1;
+ want:
+ - CREATE_TABLE
+- statement: DROP TABLE t2;
+ want:
+ - DROP_TABLE
+- statement: CREATE VIEW v1 AS SELECT * FROM t1;
+ want:
+ - CREATE_VIEW
+- statement: DROP VIEW v1;
+ want:
+ - DROP_VIEW
+- statement: |-
+ CREATE EVENT myevent
+ ON SCHEDULE AT CURRENT_TIMESTAMP + INTERVAL 1 HOUR
+ DO
+ UPDATE myschema.mytable SET mycol = mycol + 1;
+ want:
+ - CREATE_EVENT
+- statement: DROP EVENT myevent;
+ want:
+ - DROP_EVENT
+- statement: |-
+ CREATE PROCEDURE citycount (IN country CHAR(3), OUT cities INT)
+ BEGIN
+ SELECT COUNT(*) INTO cities FROM world.city
+ WHERE CountryCode = country;
+ END;
+ want:
+ - CREATE_PROCEDURE
+- statement: DROP PROCEDURE citycount;
+ want:
+ - DROP_PROCEDURE
diff --git a/backend/plugin/schema/mysql/walk_through.go b/backend/plugin/schema/mysql/walk_through.go
index 20a2ba7586..445f1c0ad4 100644
--- a/backend/plugin/schema/mysql/walk_through.go
+++ b/backend/plugin/schema/mysql/walk_through.go
@@ -240,11 +240,34 @@ func precheckMySQLRawWalkThrough(d *model.DatabaseMetadata, rawSQL string, asts
return mySQLWalkThroughAdvice{}
}
+// walkThroughOmniNode returns the MySQL AST node for a statement this walk-through is
+// asked to inspect. OceanBase registers this walk-through but parses to
+// omni/oceanbase/ast, which mysqlparser.GetOmniNode rejects, so an OceanBase statement
+// is re-parsed from its own text here. That keeps the AST-driven steps — the precheck
+// and the cross-database RENAME targets — working as they did before OceanBase had its
+// own parser, and it is why a schema/oceanbase fork (pending omni/oceanbase/catalog)
+// should replace this. A statement only OceanBase's grammar accepts does not re-parse,
+// and its auxiliary check is skipped rather than reported.
+func walkThroughOmniNode(a base.AST) (ast.Node, bool) {
+ if node, ok := mysqlparser.GetOmniNode(a); ok {
+ return node, true
+ }
+ source, ok := a.(interface{ ASTSource() string })
+ if !ok {
+ return nil, false
+ }
+ list, err := mysqlparser.ParseMySQL(source.ASTSource())
+ if err != nil || list == nil || len(list.Items) != 1 {
+ return nil, false
+ }
+ return list.Items[0], true
+}
+
func mySQLOmniASTSkipsCreateTableAsAdvice(d *model.DatabaseMetadata, asts []base.AST, index int) bool {
if index >= len(asts) {
return false
}
- node, ok := mysqlparser.GetOmniNode(asts[index])
+ node, ok := walkThroughOmniNode(asts[index])
if !ok {
return false
}
@@ -344,13 +367,13 @@ func isMySQLIdentifierChar(ch byte) bool {
func precheckMySQLOmniWalkThrough(d *model.DatabaseMetadata, asts []base.AST) mySQLWalkThroughAdvice {
for i, unifiedAST := range asts {
- node, ok := mysqlparser.GetOmniNode(unifiedAST)
+ node, ok := walkThroughOmniNode(unifiedAST)
if !ok {
continue
}
text := ""
- if omniAST, ok := unifiedAST.(*mysqlparser.OmniAST); ok {
- text = strings.TrimSpace(omniAST.Text)
+ if source, ok := unifiedAST.(interface{ ASTSource() string }); ok {
+ text = strings.TrimSpace(source.ASTSource())
}
if advice := precheckMySQLOmniNode(d, node, text); advice != nil {
advice.StartPosition = mySQLStatementStartPosition(unifiedAST.ASTStartPosition())
@@ -452,7 +475,7 @@ func mysqlRenameTargetDatabases(d *model.DatabaseMetadata, asts []base.AST) []st
targets = append(targets, targetTable.Schema)
}
for _, unifiedAST := range asts {
- node, ok := mysqlparser.GetOmniNode(unifiedAST)
+ node, ok := walkThroughOmniNode(unifiedAST)
if !ok {
continue
}
diff --git a/backend/plugin/schema/mysql/walk_through_test.go b/backend/plugin/schema/mysql/walk_through_test.go
index 3ea733e8fe..59ba17bb91 100644
--- a/backend/plugin/schema/mysql/walk_through_test.go
+++ b/backend/plugin/schema/mysql/walk_through_test.go
@@ -20,6 +20,7 @@ import (
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
mysqlparser "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
"github.com/bytebase/bytebase/backend/plugin/schema"
"github.com/bytebase/bytebase/backend/store/model"
)
@@ -137,6 +138,22 @@ func TestWalkThroughSkipsMariaDBOnlyStatements(t *testing.T) {
require.Empty(t, state.GetProto().GetSchemas())
}
+// TestWalkThroughCrossDatabaseRenameOnOceanBase pins that this shared walk-through still
+// reads an OceanBase statement. OceanBase parses to omni/oceanbase/ast, which
+// mysqlparser.GetOmniNode rejects, so without walkThroughOmniNode's re-parse
+// mysqlRenameTargetDatabases would collect no target and the simulation would fail a
+// cross-database RENAME that the server accepts.
+func TestWalkThroughCrossDatabaseRenameOnOceanBase(t *testing.T) {
+ state := model.NewDatabaseMetadata(&metadatapb.DatabaseSchemaMetadata{Name: "test"}, nil, nil, storepb.Engine_OCEANBASE, true)
+ statement := "CREATE TABLE `test`.`t1` (a INT);\nRENAME TABLE `test`.`t1` TO `other`.`t1`;"
+ sm := sheet.NewManager()
+ stmts, advices := sm.GetStatementsForChecks(storepb.Engine_OCEANBASE, statement)
+ require.Empty(t, advices)
+
+ advice := WalkThroughWithContext(context.Background(), schema.WalkThroughContext{RawSQL: statement}, state, base.ExtractASTs(stmts))
+ require.Nil(t, advice, "a cross-database RENAME the server accepts must not fail the simulation")
+}
+
// TestWalkThroughSRIDInvisible verifies the omni catalog -> metadatapb.ColumnMetadata
// conversion (tableToProto) carries the spatial SRID (presence + value, including the
// valid explicit SRID 0) and the INVISIBLE flag. Without this the WalkThroughWithContext
diff --git a/backend/runner/plancheck/statement_report_executor.go b/backend/runner/plancheck/statement_report_executor.go
index 06c11721ac..a897db1264 100644
--- a/backend/runner/plancheck/statement_report_executor.go
+++ b/backend/runner/plancheck/statement_report_executor.go
@@ -17,6 +17,7 @@ import (
cockroachdbdriver "github.com/bytebase/bytebase/backend/plugin/db/cockroachdb"
mssqldriver "github.com/bytebase/bytebase/backend/plugin/db/mssql"
mysqldriver "github.com/bytebase/bytebase/backend/plugin/db/mysql"
+ oceanbasedriver "github.com/bytebase/bytebase/backend/plugin/db/oceanbase"
oracledriver "github.com/bytebase/bytebase/backend/plugin/db/oracle"
pgdriver "github.com/bytebase/bytebase/backend/plugin/db/pg"
redshiftdriver "github.com/bytebase/bytebase/backend/plugin/db/redshift"
@@ -196,13 +197,20 @@ func GetSQLSummaryReport(ctx context.Context, stores *store.Store, sheetManager
explainCalculator = cd.CountAffectedRows
// Empty so the extractor resolves names with the database's synced search_path, as for PostgreSQL.
defaultSchema = ""
- case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE:
+ case storepb.Engine_MYSQL, storepb.Engine_MARIADB:
md, ok := driver.(*mysqldriver.Driver)
if !ok {
return nil, "", errors.Errorf("invalid mysql driver type")
}
explainCalculator = md.CountAffectedRows
defaultSchema = ""
+ case storepb.Engine_OCEANBASE:
+ od, ok := driver.(*oceanbasedriver.Driver)
+ if !ok {
+ return nil, "", errors.Errorf("invalid oceanbase driver type")
+ }
+ explainCalculator = od.CountAffectedRows
+ defaultSchema = ""
case storepb.Engine_TIDB:
md, ok := driver.(*tidbdriver.Driver)
if !ok {
diff --git a/backend/server/ultimate.go b/backend/server/ultimate.go
index 17261e8e7d..7d612d5aad 100644
--- a/backend/server/ultimate.go
+++ b/backend/server/ultimate.go
@@ -14,6 +14,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/db/mongodb"
_ "github.com/bytebase/bytebase/backend/plugin/db/mssql"
_ "github.com/bytebase/bytebase/backend/plugin/db/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/db/oceanbase"
_ "github.com/bytebase/bytebase/backend/plugin/db/oracle"
_ "github.com/bytebase/bytebase/backend/plugin/db/pg"
_ "github.com/bytebase/bytebase/backend/plugin/db/redis"
@@ -33,6 +34,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/parser/mariadb"
_ "github.com/bytebase/bytebase/backend/plugin/parser/mongodb"
_ "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/oceanbase"
_ "github.com/bytebase/bytebase/backend/plugin/parser/partiql"
_ "github.com/bytebase/bytebase/backend/plugin/parser/pg"
_ "github.com/bytebase/bytebase/backend/plugin/parser/plsql"