[Fix][Connector-v2][SQLServer] Handle database names with special characters in SQL queries and add related tests (#10327)

Author: zhangshenghang

seatunnel-connectors-v2/connector-cdc/connector-cdc-sqlserver/src/main/java/org/apache/seatunnel/connectors/seatunnel/cdc/sqlserver/utils/SqlServerUtils.java

@@ -441,7 +441,7 @@ private static String buildSelectWithRowLimits(
             sql.append(" TOP( ").append(limit).append(") ");
         }
         sql.append(projection).append(" FROM ");
-        sql.append(quoteSchemaAndTable(tableId));
+        sql.append(quote(tableId));
         if (condition.isPresent()) {
             sql.append(" WHERE ").append(condition.get());
         }
@@ -467,7 +467,16 @@ public static String quote(String dbOrTableName) {
     }
 
     public static String quote(TableId tableId) {
-        return "[" + tableId.schema() + "].[" + tableId.table() + "]";
+        StringBuilder quoted = new StringBuilder();
+        if (tableId.catalog() != null && !tableId.catalog().isEmpty()) {
+            quoted.append("[").append(tableId.catalog()).append("].");
+        }
+        quoted.append("[")
+                .append(tableId.schema())
+                .append("].[")
+                .append(tableId.table())
+                .append("]");
+        return quoted.toString();
     }
 
     private static void addPrimaryKeyColumnsToCondition(
@@ -495,7 +504,7 @@ private static String buildSelectWithBoundaryRowLimits(
         sql.append(" TOP( ").append(limit).append(") ");
         sql.append(projection);
         sql.append(" FROM ");
-        sql.append(quoteSchemaAndTable(tableId));
+        sql.append(quote(tableId));
         if (condition.isPresent()) {
             sql.append(" WHERE ").append(condition.get());
         }

seatunnel-connectors-v2/connector-cdc/connector-cdc-sqlserver/src/main/java/org/apache/seatunnel/connectors/seatunnel/cdc/sqlserver/utils/TableDiscoveryUtils.java

@@ -63,9 +63,9 @@ public static List<TableId> listTables(JdbcConnection jdbc, RelationalTableFilte
         for (String dbName : databaseNames) {
             try {
                 jdbc.query(
-                        "SELECT * FROM "
+                        "SELECT * FROM ["
                                 + dbName
-                                + ".INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE';",
+                                + "].INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE';",
                         rs -> {
                             while (rs.next()) {
                                 TableId tableId =

seatunnel-connectors-v2/connector-cdc/connector-cdc-sqlserver/src/test/java/org/apache/seatunnel/connectors/seatunnel/cdc/sqlserver/utils/SqlServerUtilsTest.java

@@ -37,7 +37,7 @@ public void testSplitScanQuery() {
                         false,
                         false);
         Assertions.assertEquals(
-                "SELECT * FROM [schema1].[table1] WHERE [id] >= ? AND NOT ([id] = ?) AND [id] <= ?",
+                "SELECT * FROM [db1].[schema1].[table1] WHERE [id] >= ? AND NOT ([id] = ?) AND [id] <= ?",
                 splitScanSQL);
 
         splitScanSQL =
@@ -47,7 +47,7 @@ public void testSplitScanQuery() {
                                 new String[] {"id"}, new SeaTunnelDataType[] {BasicType.LONG_TYPE}),
                         true,
                         true);
-        Assertions.assertEquals("SELECT * FROM [schema1].[table1]", splitScanSQL);
+        Assertions.assertEquals("SELECT * FROM [db1].[schema1].[table1]", splitScanSQL);
 
         splitScanSQL =
                 SqlServerUtils.buildSplitScanQuery(
@@ -57,7 +57,7 @@ public void testSplitScanQuery() {
                         true,
                         false);
         Assertions.assertEquals(
-                "SELECT * FROM [schema1].[table1] WHERE [id] <= ? AND NOT ([id] = ?)",
+                "SELECT * FROM [db1].[schema1].[table1] WHERE [id] <= ? AND NOT ([id] = ?)",
                 splitScanSQL);
 
         splitScanSQL =
@@ -67,6 +67,7 @@ public void testSplitScanQuery() {
                                 new String[] {"id"}, new SeaTunnelDataType[] {BasicType.LONG_TYPE}),
                         false,
                         true);
-        Assertions.assertEquals("SELECT * FROM [schema1].[table1] WHERE [id] >= ?", splitScanSQL);
+        Assertions.assertEquals(
+                "SELECT * FROM [db1].[schema1].[table1] WHERE [id] >= ?", splitScanSQL);
     }
 }

seatunnel-connectors-v2/connector-jdbc/src/main/java/org/apache/seatunnel/connectors/seatunnel/jdbc/catalog/sqlserver/SqlServerCatalog.java

@@ -90,9 +90,9 @@ protected String getListDatabaseSql() {
 
     @Override
     protected String getListTableSql(String databaseName) {
-        return "SELECT TABLE_SCHEMA, TABLE_NAME FROM "
+        return "SELECT TABLE_SCHEMA, TABLE_NAME FROM ["
                 + databaseName
-                + ".INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE'";
+                + "].INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE'";
     }
 
     @Override
@@ -144,12 +144,12 @@ protected String getDropTableSql(TablePath tablePath) {
 
     @Override
     protected String getCreateDatabaseSql(String databaseName) {
-        return String.format("CREATE DATABASE %s", databaseName);
+        return String.format("CREATE DATABASE [%s]", databaseName);
     }
 
     @Override
     protected String getDropDatabaseSql(String databaseName) {
-        return String.format("DROP DATABASE %s;", databaseName);
+        return String.format("DROP DATABASE [%s];", databaseName);
     }
 
     @Override

seatunnel-connectors-v2/connector-jdbc/src/test/java/org/apache/seatunnel/connectors/seatunnel/jdbc/catalog/PreviewActionTest.java

@@ -348,12 +348,12 @@ public void testSqlServerPreviewAction() {
         assertPreviewResult(
                 catalog,
                 Catalog.ActionType.CREATE_DATABASE,
-                "CREATE DATABASE testddatabase",
+                "CREATE DATABASE [testddatabase]",
                 Optional.empty());
         assertPreviewResult(
                 catalog,
                 Catalog.ActionType.DROP_DATABASE,
-                "DROP DATABASE testddatabase;",
+                "DROP DATABASE [testddatabase];",
                 Optional.empty());
         assertPreviewResult(
                 catalog,

seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-sqlserver-e2e/src/test/java/org/apache/seatunnel/e2e/connector/cdc/sqlserver/SqlServerCDCIT.java

@@ -432,10 +432,13 @@ private void initializeSqlServerTable(String sqlFile) {
         Assertions.assertNotNull(ddlTestFile, "Cannot locate " + ddlFile);
         try (Connection connection = getJdbcConnection();
                 Statement statement = connection.createStatement()) {
-            dropTestDatabase(connection, sqlFile);
+            List<String> ddlLines = Files.readAllLines(Paths.get(ddlTestFile.toURI()));
+            String ddlContent = String.join("\n", ddlLines);
+            String actualDatabaseName = extractDatabaseName(ddlContent);
+            dropTestDatabase(connection, actualDatabaseName);
             final List<String> statements =
                     Arrays.stream(
-                                    Files.readAllLines(Paths.get(ddlTestFile.toURI())).stream()
+                                    ddlLines.stream()
                                             .map(String::trim)
                                             .filter(x -> !x.startsWith("--") && !x.isEmpty())
                                             .map(
@@ -455,6 +458,17 @@ private void initializeSqlServerTable(String sqlFile) {
         }
     }
 
+    private String extractDatabaseName(String ddlContent) {
+        Pattern createDbPattern =
+                Pattern.compile(
+                        "CREATE\\s+DATABASE\\s+\\[?([^\\s\\];]+)\\]?", Pattern.CASE_INSENSITIVE);
+        Matcher matcher = createDbPattern.matcher(ddlContent);
+        if (matcher.find()) {
+            return matcher.group(1);
+        }
+        return null;
+    }
+
     private void updateSourceTable(String table) {
         executeSql(
                 "INSERT INTO "
@@ -587,4 +601,42 @@ protected static void disableDbCdc(Connection connection, String name) throws SQ
         Objects.requireNonNull(name);
         connection.createStatement().execute(DISABLE_DB_CDC.replace(STATEMENTS_PLACEHOLDER, name));
     }
+
+    @TestTemplate
+    public void testDatabaseNameWithSpecialCharacters(TestContainer container) {
+        initializeSqlServerTable("test_db_name");
+
+        CompletableFuture<Void> executeJobFuture =
+                CompletableFuture.supplyAsync(
+                        () -> {
+                            try {
+                                container.executeJob("/sqlservercdc_special_db_name.conf");
+                            } catch (Exception e) {
+                                throw new RuntimeException(e);
+                            }
+                            return null;
+                        });
+
+        String sourceTable = "[test-db-name].dbo.simple_table";
+        String sinkTable = "[test-db-name].dbo.simple_table_sink";
+        String selectSql = "select id, name, value from %s order by id asc";
+
+        await().atMost(60000, TimeUnit.MILLISECONDS)
+                .untilAsserted(
+                        () -> {
+                            Assertions.assertIterableEquals(
+                                    querySql(selectSql, sourceTable),
+                                    querySql(selectSql, sinkTable));
+                        });
+
+        executeSql("INSERT INTO [test-db-name].dbo.simple_table VALUES (4, 'test4', 400)");
+
+        await().atMost(60000, TimeUnit.MILLISECONDS)
+                .untilAsserted(
+                        () -> {
+                            Assertions.assertIterableEquals(
+                                    querySql(selectSql, sourceTable),
+                                    querySql(selectSql, sinkTable));
+                        });
+    }
 }

seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-sqlserver-e2e/src/test/resources/ddl/test_db_name.sql

@@ -0,0 +1,43 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements.  See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License.  You may obtain a copy of the License at
+--
+--    http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+-- ----------------------------------------------------------------------------------------------------------------
+-- DATABASE:  test-db-name (database name with hyphen to test special character handling)
+-- ----------------------------------------------------------------------------------------------------------------
+CREATE DATABASE [test-db-name];
+
+USE [test-db-name];
+EXEC sys.sp_cdc_enable_db;
+
+CREATE TABLE simple_table (
+    id int NOT NULL,
+    name varchar(100),
+    value int,
+    PRIMARY KEY (id)
+);
+
+INSERT INTO simple_table VALUES (1, 'test1', 100);
+INSERT INTO simple_table VALUES (2, 'test2', 200);
+INSERT INTO simple_table VALUES (3, 'test3', 300);
+
+EXEC sys.sp_cdc_enable_table @source_schema = 'dbo', @source_name = 'simple_table', @role_name = NULL, @supports_net_changes = 0;
+
+CREATE TABLE simple_table_sink (
+    id int NOT NULL,
+    name varchar(100),
+    value int,
+    PRIMARY KEY (id)
+);

seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-sqlserver-e2e/src/test/resources/sqlservercdc_special_db_name.conf

@@ -0,0 +1,55 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+env {
+  # You can set engine configuration here
+  parallelism = 1
+  job.mode = "STREAMING"
+  checkpoint.interval = 5000
+}
+
+source {
+  # This is a example source plugin **only for test and demonstrate the feature source plugin**
+  SqlServer-CDC {
+    plugin_output = "customers"
+    username = "sa"
+    password = "Password!"
+    database-names = ["test-db-name"]
+    table-names = ["test-db-name.dbo.simple_table"]
+    url = "jdbc:sqlserver://sqlserver-host:1433;databaseName=test-db-name"
+
+    exactly_once = false
+  }
+}
+
+transform {
+}
+
+sink {
+  Jdbc {
+    plugin_input = "customers"
+    driver = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
+    url = "jdbc:sqlserver://sqlserver-host:1433;encrypt=false"
+    user = "sa"
+    password = "Password!"
+    generate_sink_sql = true
+    database = "test-db-name"
+    table = "dbo.simple_table_sink"
+    batch_size = 1
+    primary_keys = ["id"]
+  }
+}