feat(structure-comapre): implement database object structure comparis…

…on (#1364) * implement OdcDBStructureComparator * delete SchemaBrowserExtensionPoint * response to review * add AbstractDBObjectStructureComparator * response to review
oceanbase · Jan 10, 2024 · 840d9d2 · 840d9d2
1 parent 5c99b93
commit 840d9d2
Show file tree

Hide file tree

Showing 34 changed files with 1,922 additions and 24 deletions.
diff --git a/libs/db-browser/pom.xml b/libs/db-browser/pom.xml
@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.oceanbase</groupId>
     <artifactId>db-browser</artifactId>
-    <version>1.0.4</version>
+    <version>1.0.5</version>
     <name>db-browser</name>
     <url>https://github.com/oceanbase/odc/tree/main/libs/db-browser</url>
 

diff --git a/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/DBTableEditor.java b/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/DBTableEditor.java
@@ -182,7 +182,7 @@ public String generateUpdateObjectDDLWithoutRenaming(@NotNull DBTable oldTable,
         return sqlBuilder.toString();
     }
 
-    protected abstract void generateUpdateTableOptionDDL(DBTable oldTable, DBTable newTable, SqlBuilder sqlBuilder);
+    public abstract void generateUpdateTableOptionDDL(DBTable oldTable, DBTable newTable, SqlBuilder sqlBuilder);
 
     protected abstract SqlBuilder sqlBuilder();
 
@@ -199,7 +199,7 @@ protected String getFullyQualifiedTableName(@NotNull DBTable table) {
      * 排除唯一性约束</br>
      * 创建一个唯一索引，OB 会自动创建一个同名唯一约束；因此在生成 DDL 时，如果已有唯一索引，则需要忽略掉同名唯一约束，不然生成的 DDL 会无法执行</br>
      */
-    protected List<DBTableConstraint> excludeUniqueConstraint(List<DBTableIndex> indexes,
+    public List<DBTableConstraint> excludeUniqueConstraint(List<DBTableIndex> indexes,
             List<DBTableConstraint> constraints) {
         if (CollectionUtils.isEmpty(indexes) || CollectionUtils.isEmpty(constraints)) {
             return constraints;
@@ -219,7 +219,7 @@ protected List<DBTableConstraint> excludeUniqueConstraint(List<DBTableIndex> ind
      * 排除主键约束对应的唯一索引</br>
      * 创建主键约束的时候，OB 会自动创建一个同名唯一索引；因此在生成 DDL 时，如果已有主键约束，则需要忽略掉同名唯一索引，不然生成的 DDL 会无法执行</br>
      */
-    protected List<DBTableIndex> excludePrimaryKeyIndex(List<DBTableIndex> indexes,
+    public List<DBTableIndex> excludePrimaryKeyIndex(List<DBTableIndex> indexes,
             List<DBTableConstraint> constraints) {
         if (CollectionUtils.isEmpty(indexes) || CollectionUtils.isEmpty(constraints)) {
             return indexes;

diff --git a/...db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/DBTablePartitionEditor.java b/...db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/DBTablePartitionEditor.java
@@ -246,10 +246,10 @@ protected abstract String generateAddPartitionDefinitionDDL(@NotNull DBTablePart
     protected String getFullyQualifiedTableName(@NotNull DBTablePartition partition) {
         SqlBuilder sqlBuilder = sqlBuilder();
         if (StringUtils.isNotEmpty(partition.getSchemaName())) {
-            sqlBuilder.identifier(partition.getSchemaName()).append(".");
+            sqlBuilder.identifier(partition.getSchemaName());
         }
         if (StringUtils.isNotEmpty(partition.getTableName())) {
-            sqlBuilder.identifier(partition.getTableName());
+            sqlBuilder.append(".").identifier(partition.getTableName());
         }
         return sqlBuilder.toString();
     }

diff --git a/...db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/mysql/MySQLTableEditor.java b/...db-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/mysql/MySQLTableEditor.java
@@ -85,7 +85,7 @@ protected void appendTableOptions(DBTable table, SqlBuilder sqlBuilder) {
     protected void appendMoreTableOptions(DBTable table, SqlBuilder sqlBuilder) {}
 
     @Override
-    protected void generateUpdateTableOptionDDL(@NonNull DBTable oldTable, @NonNull DBTable newTable,
+    public void generateUpdateTableOptionDDL(@NonNull DBTable oldTable, @NonNull DBTable newTable,
             @NonNull SqlBuilder sqlBuilder) {
         if (Objects.isNull(oldTable.getTableOptions()) || Objects.isNull(newTable.getTableOptions())) {
             return;
@@ -97,6 +97,22 @@ protected void generateUpdateTableOptionDDL(@NonNull DBTable oldTable, @NonNull
                     .value(newTable.getTableOptions().getComment())
                     .append(";\n");
         }
+        if (!StringUtils.equals(oldTable.getTableOptions().getCharsetName(),
+                newTable.getTableOptions().getCharsetName())) {
+            sqlBuilder.append("ALTER TABLE ")
+                    .append(getFullyQualifiedTableName(newTable))
+                    .append(" CHARACTER SET = ")
+                    .append(newTable.getTableOptions().getCharsetName())
+                    .append(";\n");
+        }
+        if (!StringUtils.equals(oldTable.getTableOptions().getCollationName(),
+                newTable.getTableOptions().getCollationName())) {
+            sqlBuilder.append("ALTER TABLE ")
+                    .append(getFullyQualifiedTableName(newTable))
+                    .append(" COLLATE = ")
+                    .append(newTable.getTableOptions().getCollationName())
+                    .append(";\n");
+        }
     }
 
     @Override

diff --git a/...-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/oracle/OracleTableEditor.java b/...-browser/src/main/java/com/oceanbase/tools/dbbrowser/editor/oracle/OracleTableEditor.java
@@ -73,7 +73,7 @@ protected void appendTableOptions(DBTable table, SqlBuilder sqlBuilder) {
     }
 
     @Override
-    protected void generateUpdateTableOptionDDL(DBTable oldTable, DBTable newTable, SqlBuilder sqlBuilder) {
+    public void generateUpdateTableOptionDDL(DBTable oldTable, DBTable newTable, SqlBuilder sqlBuilder) {
         if (!StringUtils.equals(oldTable.getTableOptions().getComment(), newTable.getTableOptions().getComment())) {
             appendTableComment(newTable, sqlBuilder);
         }

diff --git a/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableColumn.java b/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableColumn.java
@@ -35,7 +35,7 @@
  * columnName.
  */
 @Data
-@EqualsAndHashCode(exclude = {"name", "warning", "schemaName", "tableName", "ordinalPosition"})
+@EqualsAndHashCode(exclude = {"name", "warning", "schemaName", "tableName", "ordinalPosition", "keyType"})
 public class DBTableColumn implements DBObject, DBObjectWarningDescriptor {
     /**
      * 所属 schemaName

diff --git a/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableConstraint.java b/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableConstraint.java
@@ -26,7 +26,7 @@
 
 @Data
 @EqualsAndHashCode(
-        exclude = {"name", "warning", "schemaName", "tableName", "createTime", "updateTime", "ordinalPosition",
+        exclude = {"name", "warning", "schemaName", "owner", "tableName", "createTime", "updateTime", "ordinalPosition",
                 "enabled"})
 public class DBTableConstraint implements DBObject, DBObjectWarningDescriptor {
     /**

diff --git a/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableIndex.java b/libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBTableIndex.java
@@ -26,7 +26,8 @@
 
 @Data
 @EqualsAndHashCode(
-        exclude = {"name", "warning", "schemaName", "tableName", "createTime", "updateTime", "ordinalPosition"})
+        exclude = {"name", "warning", "owner", "schemaName", "tableName", "createTime", "updateTime",
+                "ordinalPosition"})
 public class DBTableIndex implements DBObject, DBObjectWarningDescriptor {
     /**
      * 所属 schemaName

diff --git a/...java/com/oceanbase/tools/dbbrowser/schema/mysql/MySQLNoGreaterThan5740SchemaAccessor.java b/...java/com/oceanbase/tools/dbbrowser/schema/mysql/MySQLNoGreaterThan5740SchemaAccessor.java
@@ -849,6 +849,9 @@ public DBTablePartition getPartition(String schemaName, String tableName) {
         DBTablePartition partition = new DBTablePartition();
         DBTablePartition subPartition = new DBTablePartition();
         partition.setSubpartition(subPartition);
+        partition.setSchemaName(schemaName);
+        partition.setTableName(tableName);
+        subPartition.setSchemaName(schemaName);
 
         DBTablePartitionOption partitionOption = new DBTablePartitionOption();
         partitionOption.setType(DBTablePartitionType.NOT_PARTITIONED);

diff --git a/...ava/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLBetween2277And3XSchemaAccessor.java b/...ava/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLBetween2277And3XSchemaAccessor.java
@@ -137,6 +137,9 @@ public DBTablePartition getPartition(String schemaName, String tableName) {
         DBTablePartitionOption partitionOption = new DBTablePartitionOption();
         partitionOption.setType(DBTablePartitionType.NOT_PARTITIONED);
         partition.setPartitionOption(partitionOption);
+        partition.setSchemaName(schemaName);
+        partition.setTableName(tableName);
+        subPartition.setSchemaName(schemaName);
 
         DBTablePartitionOption subPartitionOption = new DBTablePartitionOption();
         subPartitionOption.setType(DBTablePartitionType.NOT_PARTITIONED);

diff --git a/...va/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLNoGreaterThan1479SchemaAccessor.java b/...va/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLNoGreaterThan1479SchemaAccessor.java
@@ -97,6 +97,9 @@ public DBTablePartition getPartition(String schemaName, String tableName) {
         }
         DBTablePartition subPartition = new DBTablePartition();
         partition.setSubpartition(subPartition);
+        partition.setSchemaName(schemaName);
+        partition.setTableName(tableName);
+        subPartition.setSchemaName(schemaName);
 
         DBTablePartitionOption partitionOption = new DBTablePartitionOption();
         partitionOption.setType(DBTablePartitionType.NOT_PARTITIONED);

diff --git a/libs/db-browser/src/test/java/com/oceanbase/tools/dbbrowser/editor/MySQLTableEditorTest.java b/libs/db-browser/src/test/java/com/oceanbase/tools/dbbrowser/editor/MySQLTableEditorTest.java
@@ -63,7 +63,9 @@ public void generateUpdateObjectDDL() {
         String ddl =
                 tableEditor.generateUpdateObjectDDL(DBObjectUtilsTest.getOldTable(), DBObjectUtilsTest.getNewTable());
         Assert.assertEquals(
-                "ALTER TABLE `old_table` RENAME TO `whatever_table`;\n",
+                "ALTER TABLE `old_table` RENAME TO `whatever_table`;\n"
+                        + "ALTER TABLE `whatever_schema`.`whatever_table` CHARACTER SET = utf8mb4;\n"
+                        + "ALTER TABLE `whatever_schema`.`whatever_table` COLLATE = utf8mb4_bin;\n",
                 ddl);
     }
 

diff --git a/pom.xml b/pom.xml
@@ -93,7 +93,7 @@
         <alipay.sdk.version>4.20.19.ALL</alipay.sdk.version>
         <bucket4j-core.version>4.10.0</bucket4j-core.version>
         <springfox-swagger-ui.version>2.10.0</springfox-swagger-ui.version>
-        <db-browser.version>1.0.4</db-browser.version>
+        <db-browser.version>1.0.5</db-browser.version>
         <ob-sql-parser.version>1.2.0</ob-sql-parser.version>
         <pf4j.version>3.10.0</pf4j.version>
         <bcpkix-jdk15on.version>1.64</bcpkix-jdk15on.version>
@@ -273,6 +273,11 @@
                 <artifactId>schema-plugin-api</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.oceanbase</groupId>
+                <artifactId>schema-plugin-ob-mysql</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>com.oceanbase</groupId>
                 <artifactId>task-plugin-api</artifactId>