diff --git a/dm/dm-precheck.md b/dm/dm-precheck.md index 48b41f16a6e09..83a92a36561a1 100644 --- a/dm/dm-precheck.md +++ b/dm/dm-precheck.md @@ -69,7 +69,11 @@ For the full data migration mode (`task-mode: full`), in addition to the [common - SELECT permission on INFORMATION_SCHEMA and dump tables - RELOAD permission if `consistency=flush` - - LOCK TABLES permission on the dump tables if `consistency=flush/lock` + - LOCK TABLES permission on the dump tables if `consistency=lock` + + > **Note:** + > + > When `consistency=auto` (the default), DM first attempts `FLUSH TABLES WITH READ LOCK` and falls back to `LOCK TABLES` if FTWRL is unavailable. This fallback commonly occurs on managed MySQL services (such as Amazon RDS, Aurora, ApsaraDB RDS for MySQL, Azure Database for MySQL, or Google Cloud SQL) where FTWRL is not permitted. In this case, the `LOCK TABLES` privilege is required at runtime, but the precheck does not currently validate it. See [DM-worker privileges](/dm/dm-worker-intro.md#upstream-database-user-privileges) for the full privilege list. * (Mandatory) Consistency of upstream MySQL multi-instance sharding tables diff --git a/dm/dm-worker-intro.md b/dm/dm-worker-intro.md index a30add5b6761d..97167142fe391 100644 --- a/dm/dm-worker-intro.md +++ b/dm/dm-worker-intro.md @@ -52,6 +52,10 @@ The upstream database (MySQL/MariaDB) user must have the following privileges: | `REPLICATION SLAVE` | Global | | `REPLICATION CLIENT` | Global | +> **Note:** +> +> If migrating from a managed MySQL service (such as Amazon RDS, Aurora, ApsaraDB RDS for MySQL, Azure Database for MySQL, or Google Cloud SQL) where `FLUSH TABLES WITH READ LOCK` is not permitted, the user also needs the `LOCK TABLES` privilege. DM's default `consistency=auto` mode falls back to `LOCK TABLES` for data consistency when FTWRL is unavailable. + If you need to migrate the data from `db1` to TiDB, execute the following `GRANT` statement: ```sql @@ -59,6 +63,12 @@ GRANT RELOAD,REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'your_user'@'your_w GRANT SELECT ON db1.* TO 'your_user'@'your_wildcard_of_host'; ``` +For managed MySQL services where FTWRL is not permitted, also grant `LOCK TABLES`: + +```sql +GRANT LOCK TABLES ON db1.* TO 'your_user'@'your_wildcard_of_host'; +``` + If you also need to migrate the data from other databases into TiDB, make sure the same privileges are granted to the user of the respective databases. ### Downstream database user privileges diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index 13e1a4d85914b..bfcd552069aec 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -91,6 +91,8 @@ You can use Docker to quickly deploy a test MySQL 8.0 instance. GRANT PROCESS, BACKUP_ADMIN, RELOAD, REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'tidb-dm'@'%'; ``` + > **Note:** If your MySQL source is a managed service (such as Amazon RDS, Aurora, ApsaraDB RDS for MySQL, Azure Database for MySQL, or Google Cloud SQL), also grant `LOCK TABLES`. See [DM-worker privileges](/dm/dm-worker-intro.md#upstream-database-user-privileges) for details. + 4. Create sample data: ```sql @@ -148,6 +150,8 @@ On macOS, you can quickly install and start MySQL 8.0 locally using [Homebrew](h GRANT PROCESS, BACKUP_ADMIN, RELOAD, REPLICATION SLAVE, REPLICATION CLIENT, SELECT ON *.* TO 'tidb-dm'@'%'; ``` + > **Note:** If your MySQL source is a managed service (such as Amazon RDS, Aurora, ApsaraDB RDS for MySQL, Azure Database for MySQL, or Google Cloud SQL), also grant `LOCK TABLES`. See [DM-worker privileges](/dm/dm-worker-intro.md#upstream-database-user-privileges) for details. + 6. Create sample data: ```sql