From 32e888aabfcb996aff8ec55224d76e21e721fde8 Mon Sep 17 00:00:00 2001
From: Ti Chi Robot <ti-community-prow-bot@tidb.io>
Date: Mon, 25 Dec 2023 16:06:26 +0800
Subject: [PATCH] add ticdc sql mode config (#15246) (#15863)

---
 ticdc/ticdc-changefeed-config.md |  4 ++++
 ticdc/ticdc-ddl.md               | 23 +++++++++++++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/ticdc/ticdc-changefeed-config.md b/ticdc/ticdc-changefeed-config.md
index 2522957f0ff0b..e01aca93c51ea 100644
--- a/ticdc/ticdc-changefeed-config.md
+++ b/ticdc/ticdc-changefeed-config.md
@@ -67,6 +67,10 @@ enable-old-value = true
 # Note: This configuration item only takes effect if the downstream is TiDB.
 # sync-point-retention = "1h"
 
+# Starting from v6.5.6 and v7.1.3, this configuration item specifies the SQL mode used when parsing DDL statements. Multiple modes are separated by commas.
+# The default value is the same as the default SQL mode of TiDB.
+# sql-mode = "ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"
+
 [mounter]
 # The number of threads with which the mounter decodes KV data. The default value is 16.
 # worker-num = 16
diff --git a/ticdc/ticdc-ddl.md b/ticdc/ticdc-ddl.md
index 822c1a89d186e..c6a620774dcdb 100644
--- a/ticdc/ticdc-ddl.md
+++ b/ticdc/ticdc-ddl.md
@@ -90,3 +90,26 @@ TiCDC processes this type of DDL as follows:
 | `RENAME TABLE test.t1 TO test.ignore1, test.t3 TO test.ignore2` | Replicate | The old database name, the old table names, and the new database name match the filter rule. |
 | `RENAME TABLE test.t1 TO ignore.t1, test.t2 TO test.t22;` | Report an error | The new database name `ignore` does not match the filter rule. |
 | `RENAME TABLE test.t1 TO test.t4, test.t3 TO test.t1, test.t4 TO test.t3;` | Report an error | The `RENAME TABLE` DDL swaps the names of `test.t1` and `test.t3` in one DDL statement, which TiCDC cannot handle correctly. In this case, refer to the error message for handling. |
+
+### SQL mode
+
+By default, TiCDC uses the default SQL mode of TiDB to parse DDL statements. If your upstream TiDB cluster uses a non-default SQL mode, you must specify the SQL mode in the TiCDC configuration file. Otherwise, TiCDC might fail to parse DDL statements correctly. For more information about TiDB SQL mode, see [SQL Mode](/sql-mode.md).
+
+For example, if the upstream TiDB cluster uses the `ANSI_QUOTES` mode, you must specify the SQL mode in the changefeed configuration file as follows:
+
+```toml
+# In the value, "ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION" is the default SQL mode of TiDB.
+# "ANSI_QUOTES" is the SQL mode added to your upstream TiDB cluster.
+
+sql-mode = "ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION,ANSI_QUOTES"
+```
+
+If the SQL mode is not configured, TiCDC might fail to parse some DDL statements correctly. For example:
+
+```sql
+CREATE TABLE "t1" ("a" int PRIMARY KEY);
+```
+
+Because in the default SQL mode of TiDB, double quotation marks are treated as strings rather than identifiers, TiCDC fails to parse the DDL statement correctly.
+
+Therefore, when creating a replication task, it is recommended that you specify the SQL mode used by the upstream TiDB cluster in the configuration file.