Change Request

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

Sometimes it's needed to create a downstream table that different with upstream table, for exmaple, there's conflicting PK in upstream sharding tables so downstream one should add another column to build a compsite index.

2. Describe your suggestion or addition.

as title

3. Provide some reference materials (documents, websites, etc) if you could.

File: /release-5.3/en/feature-online-ddl.md

I'd like to know if my understanding is correct.
Does "some DDLs still need to be copied." mean "some DDLs still need (tables) to be copied. "?

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Error Report

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. What is the URL/path of the document related to this issue?
   "Verify internal link anchors" step costs 13 min https://github.com/pingcap/docs-dm/runs/6874955326?check_suite_focus=true

2. How would you like to improve it?
   Update node version.

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

File: /release-5.3/zh/dm-tune-configuration.md

原文：
worker-count
worker-count 为 DM Sync 阶段并发迁移 DML 的线程数量设置，默认值为 16，如果对迁移速度有较高的要求，可以适当调高(改)参数的值。

修改后：
worker-count

worker-count 为 DM Sync 阶段并发迁移 DML 的线程数量设置，默认值为 16，如果对迁移速度有较高的要求，可以适当调高(该)参数的值。

File: /en/get-started.md

Currently, it's this.
Notice

• target-database: children need to be indented
• do-dbs: ["testdm"] needs to be indented

---
name: testdm
task-mode: all
target-database:
host: "127.0.0.1"
port: 4000
user: "root"
password: "" # If the password is not null, it is recommended to use password encrypted with dmctl.
mysql-instances:
  - source-id: "mysql-replica-01"
    block-allow-list:  "ba-rule1"
block-allow-list:
ba-rule1:
    do-dbs: ["testdm"]

Should be

---
name: testdm
task-mode: all
target-database:
    host: "127.0.0.1"
    port: 4000
    user: "root"
    password: "" # If the password is not null, it is recommended to use password encrypted with dmctl.
mysql-instances:
  - source-id: "mysql-replica-01"
    block-allow-list:  "ba-rule1"
block-allow-list:
    ba-rule1:
        do-dbs: ["testdm"]

https://docs.pingcap.com/tidb-data-migration/v2.0

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

File: /zh/command-line-flags.md
--initial-cluster

在未指定 join 参数时需要指定该参数。一个 3 节点集群的配置示例为 "dm-master-1=http://172.16.15.11:8291,dm-master-2-=http://172.16.15.12:8291,dm-master-3=http://172.16.15.13:8291"
dm-master-2-=http://172.16.15.12:8291 多了-
dm-master-2=http://172.16.15.12:8291

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

File: /zh/key-features.md

rule1只是合表
rule2用于合库
省略rule2的话 不会进行合库操作。

File: /zh/quick-start-with-dm.md

File: /zh/deploy-a-dm-cluster-using-tiup.md

Change Request

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

Since December 23, 2021, the TiDB DM documentation in the master branch has been merged to TiDB documentation.

2. Describe your suggestion or addition.

Move the broken link checker to release-5.3 branch.

3. Provide some reference materials (documents, websites, etc) if you could.

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Release date: 6.11, 2021

• PR merge: ref the milestone
• See if update TiDB and parser
• See if update dumpling
• Update the version for DM-Ansible (keep DM-Ansible support for a short time)
• Sync terror codes with master branch (checked errors_release.txt)
• Release notes
  • update release note according to latest PRs
  • PR in this repo
  • PR in docs-dm
• Update docs (needs to update)
• Git commit hash:
• Testing report
• Check version upgrade tests passed
• Close the milestone

File: /zh/source-configuration-file.md

 security:                       # 上游数据库 TLS 相关配置                             
    ssl-ca: "/path/to/ca.pem"
    ssl-cert: "/path/to/cert.pem"
    ssl-key: "/path/to/key.pem"

文档没有说明这些/path/to是在哪个component上的的path. 是dm master的path， 还是dm worker的path, 还是别的instance的path?

File: /zh/manually-handling-sharding-ddl-locks.md

unlock-ddl-lock test-shard_db.shard_table
应该写
unlock-ddl-lock test-`shard_db`.`shard_table`
不然shell命令行执行报错， 一脸懵

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Error Report

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. What is the URL/path of the document related to this issue?
   Missing gtid tutorial in add-tables-to-existing-task

2. How would you like to improve it?
   add tutorial later

Change Request

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

now: https://docs.pingcap.com/zh/tidb-data-migration/stable/dmctl-introduction

Welcome to dmctl
Release Version: v2.0.3
Git Commit Hash: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Git Branch: release-2.0
UTC Build Time: yyyy-mm-dd hh:mm:ss
Go Version: go version go1.13 linux/amd64

» help
DM control

Usage:
  dmctl [command]

Available Commands:
  check-task      Checks the configuration file of the task.
  config          Commands to import/export config.
  get-config      Gets the configuration.
  handle-error    `skip`/`replace`/`revert` the current error event or a specific binlog position (binlog-pos) event.
  help            Help about any command
  list-member     Lists member information.
  offline-member  Offlines member which has been closed.
  operate-leader  `evict`/`cancel-evict` the leader.
  operate-schema  `get`/`set`/`remove` the schema for an upstream table.
  operate-source  `create`/`update`/`stop`/`show` upstream MySQL/MariaDB source.
  pause-relay     Pauses DM-worker's relay unit.
  pause-task      Pauses a specified running task.
  purge-relay     Purges relay log files of the DM-worker according to the specified filename.
  query-status    Queries task status.
  resume-relay    Resumes DM-worker's relay unit.
  resume-task     Resumes a specified paused task.
  show-ddl-locks  Shows un-resolved DDL locks.
  start-task      Starts a task as defined in the configuration file.
  stop-task       Stops a specified task.
  unlock-ddl-lock Unlocks DDL lock forcefully.

Flags:
  -h, --help             help for dmctl
  -s, --source strings   MySQL Source ID.

Use "dmctl [command] --help" for more information about a command.

dmctl in v5.3.0

DM control

Usage:
  dmctl [flags]
  dmctl [command]

Available Commands:
  binlog          manage upstream binlog operations
  binlog-schema   manage or show source-table schema schemas
  check-task      Checks the configuration file of the task
  config          manage config operations
  decrypt         Decrypts cipher text to plain text
  encrypt         Encrypts plain text to cipher text
  help            Gets help about any command
  list-member     Lists member information
  offline-member  Offlines member which has been closed
  operate-leader  `evict`/`cancel-evict` the leader
  operate-source  `create`/`update`/`stop`/`show` upstream MySQL/MariaDB source
  pause-relay     Pauses DM-worker's relay unit
  pause-task      Pauses a specified running task or all (sub)tasks bound to a source
  purge-relay     Purges relay log files of the DM-worker according to the specified filename
  query-status    Queries task status
  resume-relay    Resumes DM-worker's relay unit
  resume-task     Resumes a specified paused task or all (sub)tasks bound to a source
  shard-ddl-lock  maintain or show shard-ddl locks information
  start-relay     Starts workers pulling relay log for a source
  start-task      Starts a task as defined in the configuration file
  stop-relay      Stops workers pulling relay log for a source
  stop-task       Stops a specified task or all (sub)tasks bound to a source
  transfer-source Transfers a upstream MySQL/MariaDB source to a free worker

Flags:
      --config string        Path to config file.
  -h, --help                 help for dmctl
      --master-addr string   Master API server address, this parameter is required when interacting with the dm-master
      --rpc-timeout string   RPC timeout, default is 10m. (default "10m")
  -s, --source strings       MySQL Source ID.
      --ssl-ca string        Path of file that contains list of trusted SSL CAs for connection.
      --ssl-cert string      Path of file that contains X509 certificate in PEM format for connection.
      --ssl-key string       Path of file that contains X509 key in PEM format for connection.
  -V, --version              Prints version and exit.

Use "dmctl [command] --help" for more information about a command.

2. Describe your suggestion or addition.

update to new version

3. Provide some reference materials (documents, websites, etc) if you could.

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Change Request

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

   Lacks markdownlint check

2. Describe your suggestion or addition.

   Add markdownlint rules to the CI check of this repo as that in pingcap/docs-cn

3. Provide some reference materials (documents, websites, etc) if you could.

   pingcap/docs-cn

Change Request

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

   Lacks the broken link CI check

2. Describe your suggestion or addition.

   Add the broken link CI check to this repo as that in pingcap/docs-cn. Thanks a lot!

   Please note that the link path rule is not the same as that in pingcap/docs-cn. See TOC.md.

3. Provide some reference materials (documents, websites, etc) if you could.

   pingcap/docs-cn

File: /zh/handle-alerts.md

DM_dump_process_exists_with_error
DM_load_process_exists_with_error
DM_sync_process_exists_with_error

这三个错误名字，exists应该更正为exits，prometheus的dm_worker.rules.yml中名字也需要改

Change Request

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

pingcap/dm#1778 will be adding more metrics to dm, so we need to add documentation to explain why this metric was added and how it can be used to measure the performance of dm.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Summary

Errors per input

Errors in zh/shard-merge-best-practices.md

• https://www.ucloud.cn/site/product/uddb.html: Failed: HTTP status client error (404 Not Found) for url (https://www.ucloud.cn/site/product/uddb.html)

Full Github Actions output

Error Report

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. What is the URL/path of the document related to this issue?
   https://docs.pingcap.com/zh/tidb-data-migration/stable/dm-worker-intro#dm-worker-%E6%89%80%E9%9C%80%E6%9D%83%E9%99%90

2. How would you like to improve it?
   RELOAD,REPLICATION SLAVE, REPLICATION CLIENT ON . TO 'your_user'@'your_wildcard_of_host'
   GRANT SELECT ON db1.* TO 'your_user'@'your_wildcard_of_host';
   用户按照文档给了权限
   GRANT RELOAD, REPLICATION SLAVE, REPLICATION CLIENT ON . TO 'anecwjs'@'%'
   GRANT ALL PRIVILEGES ON calcdb08.* TO 'anecwjs'@'%'
   GRANT ALL PRIVILEGES ON calcdb_jfmk.* TO 'anecwjs'@'%'
   GRANT ALL PRIVILEGES ON calcdb_zfpt.* TO 'anecwjs'@'%'
   但是在启动任务的 dump 阶段报错了，没有 information_schema 的权限

"subTaskStatus": [
                {
                    "name": "full_calcdb_exc3tabs",
                    "stage": "Paused",
                    "unit": "Dump",
                    "result": {
                        "isCanceled": false,
                        "errors": [
                            {
                                "ErrCode": 32001,
                                "ErrClass": "dump-unit",
                                "ErrScope": "internal",
                                "ErrLevel": "high",
                                "Message": "mydumper/dumpling runs with error, with output (may empty): ",
                                "RawCause": "sql: SHOW CREATE DATABASE `information_schema`: sql: SHOW CREATE DATABASE `information_schema`: Error 1044: Access denied for user 'anecwjs'@'172.17.3.117' to database 'information_schema'",
                                "Workaround": ""
                            }
                        ],
                        "detail": null
                    },
                    "unresolvedDDLLockID": "",
                    "dump": {
                    }
                }
            ]

Change Request

This repository is ONLY used to solve issues related to TiDB Data Migration (DM) documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.
   We need to make it clear how is-shardning and shard-mode configuration items should be used in DM task configuration file:

• is-shardning configuration item is not listed in current DM task configuration file
• for shard-mode, it is stated that The "pessimistic" mode is used by default., this may cause some confusion that user doesn't need to configure it.
  refer to:
  https://docs.pingcap.com/zh/tidb-data-migration/stable/task-configuration-file-full
  https://docs.pingcap.com/zh/tidb-data-migration/stable/task-configuration-guide

2. Describe your suggestion or addition.
   Make it clear how these two config should be used.

3. Provide some reference materials (documents, websites, etc) if you could.