Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge DM dev docs to TiDB dev docs #7317

Merged
merged 20 commits into from
Dec 23, 2021
Merged

Merge DM dev docs to TiDB dev docs #7317

merged 20 commits into from
Dec 23, 2021

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Dec 21, 2021 •
edited
Loading

What is changed, added or deleted? (Required)

To help users access TiDB Data Migration (DM) documentation more quickly and conveniently, this PR merges TiDB DM dev docs into TiDB dev docs.

The major changes are as follows:

  1. Copy the DM dev documentation in https://github.com/pingcap/docs-dm/pull/869/files to the TiDB dev documentation, and add the DM dev TOC to TiDB dev TOC.
  2. In DM dev documentation, update the external links of TiDB documentation to internal links.
  3. Update the external links of DM documentation to internal links.
  4. Add dm-releases-notes.md.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Dec 21, 2021 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • lilin90

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 21, 2021
@qiancai qiancai added the translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. label Dec 21, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Dec 21, 2021
@TomShawn TomShawn added the type/refactor The issue belongs to a refactor work. label Dec 22, 2021
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
TOC.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
TOC.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
TOC.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
TOC.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated

### Schema and table routing

The [schema and table routing](https://docs.pingcap.com/tidb-data-migration/stable/key-features#table-routing) feature means that DM can migrate a certain table of the source database to the specified table in the downstream. For example, you can migrate the table structure and data from the table `test`.`sbtest1` in the source database to the table `test`.`sbtest2` in TiDB. This is also a core feature for merging and migrating sharded databases and tables.
The [schema and table routing]\dm\dm-key-features.md#table-routing) feature means that DM can migrate a certain table of the source database to the specified table in the downstream. For example, you can migrate the table structure and data from the table `test`.`sbtest1` in the source database to the table `test`.`sbtest2` in TiDB. This is also a core feature for merging and migrating sharded databases and tables.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated

## Advanced features

### Shard merge and migration

DM supports merging and migrating the original sharded instances and tables from the source databases into TiDB, but with some restrictions. For details, see [Sharding DDL usage restrictions in the pessimistic mode](https://docs.pingcap.com/tidb-data-migration/stable/feature-shard-merge-pessimistic#restrictions) and [Sharding DDL usage restrictions in the optimistic mode](https://docs.pingcap.com/tidb-data-migration/stable/feature-shard-merge-optimistic#restrictions).
DM supports merging and migrating the original sharded instances and tables from the source databases into TiDB, but with some restrictions. For details, see [Sharding DDL usage restrictions in the pessimistic mode]\dm\feature-shard-merge-pessimistic.md#restrictions) and [Sharding DDL usage restrictions in the optimistic mode]\dm\feature-shard-merge-optimistic.md#restrictions).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated

### Optimization for third-party online-schema-change tools in the migration process

In the MySQL ecosystem, tools such as `gh-ost` and `pt-osc` are widely used. DM provides support for these tools to avoid migrating unnecessary intermediate data. For details, see [Online DDL Tools](https://docs.pingcap.com/tidb-data-migration/stable/key-features#online-ddl-tools)
In the MySQL ecosystem, tools such as gh-ost and pt-osc are widely used. DM provides support for these tools to avoid migrating unnecessary intermediate data. For details, see [Online DDL Tools]\dm\dm-key-features.md#online-ddl-tools)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated

### Filter certain row changes using SQL expressions

In the phase of incremental replication, DM supports the configuration of SQL expressions to filter out certain row changes, which lets you replicate the data with a greater granularity. For more information, refer to [Filter Certain Row Changes Using SQL Expressions](https://docs.pingcap.com/tidb-data-migration/stable/feature-expression-filter).
In the phase of incremental replication, DM supports the configuration of SQL expressions to filter out certain row changes, which lets you replicate the data with a greater granularity. For more information, refer to [Filter Certain Row Changes Using SQL Expressions]\dm\feature-expression-filter.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated Show resolved Hide resolved
TomShawn
TomShawn reviewed Dec 22, 2021
View reviewed changes
dm/dm-overview.md Outdated

- DM reports an error when it encounters an incompatible DDL statement. To solve this error, you need to manually handle it using dmctl, either skipping this DDL statement or replacing it with a specified DDL statement(s). For details, see [Skip or replace abnormal SQL statements](https://docs.pingcap.com/tidb-data-migration/stable/faq#how-to-handle-incompatible-ddl-statements).
- DM reports an error when it encounters an incompatible DDL statement. To solve this error, you need to manually handle it using dmctl, either skipping this DDL statement or replacing it with a specified DDL statement(s). For details, see [Skip or replace abnormal SQL statements]\dm\dm-faq.md#how-to-handle-incompatible-ddl-statements).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

lilin90
lilin90 approved these changes Dec 23, 2021
View reviewed changes
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Dec 23, 2021
@qiancai
Copy link
Collaborator Author

qiancai commented Dec 23, 2021

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 0fa43e1

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Dec 23, 2021
@ti-chi-bot ti-chi-bot merged commit 3540fbb into pingcap:master Dec 23, 2021
@sunzhaoyang
Copy link
Contributor

LGTM

This was referenced Dec 23, 2021
Closed
Closed
Merged
@Rustin170506 Rustin170506 mentioned this pull request Dec 30, 2021
Merged
4 tasks
@glorv glorv mentioned this pull request Jan 17, 2022
Merged
8 tasks
@shichun-0415 shichun-0415 mentioned this pull request Jan 24, 2022
Merged
8 tasks
@qiancai qiancai mentioned this pull request Feb 14, 2022
Merged
7 tasks
@Austaras Austaras mentioned this pull request Feb 23, 2022
Merged
7 tasks
@buchuitoudegou buchuitoudegou mentioned this pull request Mar 24, 2022
Closed
4 tasks
@luzizhuo luzizhuo mentioned this pull request Apr 25, 2022
Closed
8 tasks
This was referenced May 23, 2022
Closed
Merged
@ti-chi-bot ti-chi-bot mentioned this pull request May 23, 2022
Merged
8 tasks
@shichun-0415 shichun-0415 mentioned this pull request Jun 14, 2022
Merged
8 tasks
This was referenced Jun 20, 2022
Merged
Merged
Merged
This was referenced Jun 20, 2022
Merged
Merged
@Oreoxmt Oreoxmt mentioned this pull request Sep 28, 2022
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomShawn TomShawn TomShawn approved these changes

@lilin90 lilin90 lilin90 approved these changes

@sunzhaoyang sunzhaoyang Awaiting requested review from sunzhaoyang

Assignees
No one assigned
Labels
size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/refactor The issue belongs to a refactor work.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@qiancai @ti-chi-bot @sunzhaoyang @lilin90 @TomShawn