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.

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

dm: update headings #11987

Merged
merged 5 commits into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
update dm headings
  • Loading branch information
ran-huang committed Nov 14, 2022
commit da8e4e7dfe03a03e2372152eb1c16a36ab3f414b
6 changes: 3 additions & 3 deletions dm/dm-command-line-flags.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: DM 命令行参数
title: TiDB Data Migration 命令行参数
summary: 介绍 DM 各组件的主要命令行参数。
aliases: ['/docs-cn/tidb-data-migration/dev/command-line-flags/']
---

# DM 命令行参数
# TiDB Data Migration 命令行参数

本文档介绍 DM 中各组件的主要命令行参数。
本文档介绍 TiDB Data Migration (DM) 中各组件的主要命令行参数。

## DM-master

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-create-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 创建数据迁移任务
title: 创建 DM 数据迁移任务
Copy link
Contributor

Choose a reason for hiding this comment

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

感觉要么 创建 TiDB Data Migration 数据迁移任务,要么创建数据迁移任务

ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 TiDB Data Migration 如何创建数据迁移任务。
aliases: ['/docs-cn/tidb-data-migration/dev/create-task/']
---

# 创建数据迁移任务
# 创建 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

`start-task` 命令用于创建数据迁移任务。当数据迁移任务启动时,DM 将[自动对相应权限和配置进行前置检查](/dm/dm-precheck.md)。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-error-handling.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 故障及处理方法
title: TiDB Data Migration 故障及处理方法
summary: 了解 DM 的错误系统及常见故障的处理方法。
aliases: ['/docs-cn/tidb-data-migration/dev/error-handling/','/docs-cn/tidb-data-migration/dev/troubleshoot-dm/','/docs-cn/tidb-data-migration/dev/error-system/']
---

# 故障及处理方法
# TiDB Data Migration 故障及处理方法

本文档介绍 DM 的错误系统及常见故障的处理方法。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-export-import-config.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 导出和导入集群的数据源和任务配置
title: DM 导出和导入集群的数据源和任务配置
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 TiDB Data Migration 导出和导入集群的数据源和任务配置。
---

# 导出和导入集群的数据源和任务配置
# DM 导出和导入集群的数据源和任务配置
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

`config` 命令用于导出和导入集群的数据源和任务配置。

Expand Down
6 changes: 3 additions & 3 deletions dm/dm-generate-self-signed-certificates.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 生成自签名证书
title: TiDB Data Migration 生成自签名证书
summary: 了解如何生成自签名证书。
---

# 生成自签名证书
# TiDB Data Migration 生成自签名证书

本文档提供使用 `openssl` 生成自签名证书的一个示例,用户也可以根据自己的需求生成符合要求的证书和密钥。
本文档提供使用 `openssl` 为 DM 生成自签名证书的一个示例,用户也可以根据自己的需求生成符合要求的证书和密钥。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

假设实例集群拓扑如下:

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-handle-alerts.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 处理告警
title: TiDB Data Migration 处理告警
summary: 了解 DM 中各主要告警信息的处理方法。
aliases: ['/docs-cn/tidb-data-migration/dev/handle-alerts/']
---

# 处理告警
# TiDB Data Migration 处理告警

本文档介绍 DM 中各主要告警信息的处理方法。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-handle-performance-issues.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 性能问题及处理方法
title: TiDB Data Migration 性能问题及处理方法
summary: 了解 DM 可能存在的常见性能问题及其处理方法。
aliases: ['/docs-cn/tidb-data-migration/dev/handle-performance-issues/']
---

# 性能问题及处理方法
# TiDB Data Migration 性能问题及处理方法

本文档介绍 DM 中可能存在的、常见的性能问题及其处理方法。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-hardware-and-software-requirements.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: DM 集群软硬件环境需求
title: TiDB Data Migration 集群软硬件环境需求
summary: 了解部署 DM 集群的软件和硬件要求。
aliases: ['/docs-cn/tidb-data-migration/dev/hardware-and-software-requirements/']
---

# DM 集群软硬件环境需求
# TiDB Data Migration 集群软硬件环境需求

DM 支持主流的 Linux 操作系统,具体版本要求见下表:
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
6 changes: 3 additions & 3 deletions dm/dm-key-features.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 主要特性
title: TiDB Data Migration 主要特性
summary: 了解 DM 的各主要功能特性或相关的配置选项。
aliases: ['/docs-cn/tidb-data-migration/dev/key-features/','/docs-cn/tidb-data-migration/dev/feature-overview/']
---

# 主要特性
# TiDB Data Migration 主要特性

本文档介绍 DM 提供的数据迁移功能以及相关的配置选项与使用示例。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down Expand Up @@ -544,7 +544,7 @@ filters:

<SimpleTab>
<div label="v2.0.5 及之后的版本">

在 v2.0.5 及之后的版本,请在 `task` 配置文件中使用 `online-ddl` 配置项。

如上游 MySQL/MariaDB (同时)使用 gh-ost 或 pt-osc 工具,则在 task 的配置文件中设置:
Expand Down
4 changes: 2 additions & 2 deletions dm/dm-manage-schema.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 管理迁移表的表结构
title: 管理 DM 迁移表的表结构
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解如何管理待迁移表在 DM 内部的表结构。
---

# 管理迁移表的表结构
# 管理 DM 迁移表的表结构
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

本文介绍如何使用 [dmctl](/dm/dmctl-introduction.md) 组件来管理通过 DM 迁移的表在 DM 内部的表结构。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-manage-source.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 管理上游数据源
title: 管理 DM 上游数据源
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解如何管理上游 MySQL 实例。
aliases: ['/docs-cn/tidb-data-migration/dev/manage-source/']
---

# 管理上游数据源配置
# 管理 DM 上游数据源
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

本文介绍了如何使用 [dmctl](/dm/dmctl-introduction.md) 组件来管理数据源配置,包括如何加密数据库密码,数据源操作,查看数据源配置,改变数据源与 DM-worker 的绑定关系。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
6 changes: 3 additions & 3 deletions dm/dm-open-api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 使用 OpenAPI 运维集群
summary: 了解如何使用 OpenAPI 接口来管理集群状态和数据同步
title: 使用 OpenAPI 运维 DM 集群
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解如何使用 OpenAPI 接口来管理 DM 集群状态和数据同步
---

# 使用 OpenAPI 运维集群
# 使用 OpenAPI 运维 DM 集群
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

DM 提供 OpenAPI 功能,您可以通过 OpenAPI 方便地对 DM 集群进行查询和运维操作。OpenAPI 的功能范围和 [dmctl 工具](/dm/dmctl-introduction.md)相当。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
2 changes: 1 addition & 1 deletion dm/dm-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ summary: 了解 TiDB Data Migration
aliases: ['/docs-cn/tidb-data-migration/dev/overview/','/docs-cn/tools/dm/overview/','/zh/tidb/dev/quick-create-migration-task','/zh/tidb/dev/scenarios']
---

# 产品简介
# Data Migration 简介
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

<!--
![star](https://img.shields.io/github/stars/pingcap/tiflow?style=for-the-badge&logo=github) ![license](https://img.shields.io/github/license/pingcap/tiflow?style=for-the-badge) ![forks](https://img.shields.io/github/forks/pingcap/tiflow?style=for-the-badge)
Expand Down
4 changes: 2 additions & 2 deletions dm/dm-pause-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 暂停数据迁移任务
title: 暂停 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 TiDB Data Migration 如何暂停数据迁移任务。
aliases: ['/docs-cn/tidb-data-migration/dev/pause-task/']
---

# 暂停数据迁移任务
# 暂停 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

`pause-task` 命令用于暂停数据迁移任务。

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-precheck.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: DM 执行任务时的前置检查
title: DM 任务前置检查
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 DM 执行数据迁移任务时将进行的前置检查。
aliases: ['/docs-cn/tidb-data-migration/dev/precheck/']
---

# 任务前置检查
# DM 任务前置检查
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

本文介绍了 DM 的任务前置检查功能。此功能用于提前检测出上游 MySQL 实例配置中可能存在的一些错误。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-query-status.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: TiDB Data Migration 查询状态
title: TiDB Data Migration 查询任务状态
summary: 深入了解 TiDB Data Migration 如何查询数据迁移任务状态
aliases: ['/docs-cn/tidb-data-migration/dev/query-status/','/docs-cn/tidb-data-migration/dev/query-error/','/tidb-data-migration/dev/query-error/']
---

# TiDB Data Migration 查询状态
# TiDB Data Migration 查询任务状态

本文介绍 TiDB Data Migration (DM) `query-status` 命令的查询结果、任务状态与子任务状态。

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-resume-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 恢复数据迁移任务
title: 恢复 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 TiDB Data Migration 如何恢复数据迁移任务。
aliases: ['/docs-cn/tidb-data-migration/dev/resume-task/']
---

# 恢复数据迁移任务
# 恢复 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

`resume-task` 命令用于恢复处于 `Paused` 状态的数据迁移任务,通常用于在人为处理完造成迁移任务暂停的故障后手动恢复迁移任务。

Expand Down
6 changes: 3 additions & 3 deletions dm/dm-source-configuration-file.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 上游数据库配置文件介绍
title: TiDB Data Migration 上游数据库配置文件介绍
aliases: ['/docs-cn/tidb-data-migration/dev/source-configuration-file/']
---

# 上游数据库配置文件介绍
# TiDB Data Migration 上游数据库配置文件介绍

本文介绍上游数据库的配置文件,包括配置文件示例与配置项说明。
本文介绍 DM 上游数据库的配置文件,包括配置文件示例与配置项说明。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

## 配置文件示例

Expand Down
4 changes: 2 additions & 2 deletions dm/dm-stop-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 停止数据迁移任务
title: 停止 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解 TiDB Data Migration 如何停止数据迁移任务。
aliases: ['/docs-cn/tidb-data-migration/dev/stop-task/']
---

# 停止数据迁移任务
# 停止 DM 数据迁移任务
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

`stop-task` 命令用于停止数据迁移任务。有关 `stop-task` 与 `pause-task` 的区别,请参考[暂停数据迁移任务](/dm/dm-pause-task.md)中的相关说明。

Expand Down
2 changes: 1 addition & 1 deletion dm/dm-task-configuration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: DM 数据迁移任务配置向导
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
---

# 数据迁移任务配置向导
# DM 数据迁移任务配置向导
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

本文档介绍如何配置 Data Migration (DM) 的数据迁移任务。
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
4 changes: 2 additions & 2 deletions dm/dmctl-introduction.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 使用 dmctl 运维集群
title: 使用 dmctl 运维 DM 集群
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
summary: 了解如何使用 dmctl 运维 DM 集群。
aliases: ['/docs-cn/tidb-data-migration/dev/dmctl-introduction/','/docs-cn/tidb-data-migration/dev/manage-replication-tasks/']
---

# 使用 dmctl 运维集群
# 使用 dmctl 运维 DM 集群
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

> **注意:**
>
Expand Down
4 changes: 2 additions & 2 deletions dm/handle-failed-ddl-statements.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 处理出错的 DDL 语句
title: 使用 DM 处理出错的 DDL 语句
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: 使用 DM 处理出错的 DDL 语句
title: 使用 TiDB Data Migration 处理出错的 DDL 语句

summary: 了解在使用 TiDB Data Migration 迁移数据时,如何处理出错的 DDL 语句。
aliases: ['/docs-cn/tidb-data-migration/dev/skip-or-replace-abnormal-sql-statements/']
---

# 处理出错的 DDL 语句
# 使用 DM 处理出错的 DDL 语句
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# 使用 DM 处理出错的 DDL 语句
# 使用 TiDB Data Migration 处理出错的 DDL 语句


本文介绍了如何使用 DM 来处理出错的 DDL 语句。
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
本文介绍了如何使用 DM 来处理出错的 DDL 语句。
本文介绍了如何使用 TiDB Data Migration (DM) 来处理出错的 DDL 语句。


Expand Down
8 changes: 4 additions & 4 deletions dm/quick-start-create-source.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 创建数据源
title: 创建 DM 数据源
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: 创建 DM 数据源
title: 创建 TiDB Data Migration 数据源

summary: 了解如何为 DM 创建数据源。
---

# 创建数据源
# 创建 DM 数据源
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# 创建 DM 数据源
# 创建 TiDB Data Migration 数据源


> **注意:**
>
Expand Down Expand Up @@ -35,7 +35,7 @@ summary: 了解如何为 DM 创建数据源。

```yaml
source-id: "mysql-01" # 数据源 ID,在数据迁移任务配置和 dmctl 命令行中引用该 source-id 可以关联到对应的数据源

from:
host: "127.0.0.1"
port: 3306
Expand Down Expand Up @@ -89,7 +89,7 @@ tiup dmctl --master-addr <master-addr> operate-source create ./source-mysql-01.y
```bash
tiup dmctl --master-addr <master-addr> config source mysql-01
```

```
{
"result": true,
Expand Down
4 changes: 2 additions & 2 deletions dm/quick-start-create-task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 创建数据迁移任务
title: 创建 DM 数据迁移任务
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: 创建 DM 数据迁移任务
title: 创建 TiDB Data Migration 数据迁移任务

summary: 了解在部署 DM 集群后,如何快速创建数据迁移任务。
aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-create-task/']
---

# 创建数据迁移任务
# 创建 DM 数据迁移任务
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# 创建 DM 数据迁移任务
# 创建 TiDB Data Migration 数据迁移任务


本文档介绍在 DM 集群部署成功后,如何快速创建简单的数据迁移任务。
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
本文档介绍在 DM 集群部署成功后,如何快速创建简单的数据迁移任务。
本文档介绍在 TiDB Data Migration (DM) 集群部署成功后,如何快速创建简单的数据迁移任务。


Expand Down
2 changes: 1 addition & 1 deletion dm/quick-start-with-dm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: TiDB Data Migration 快速上手试用
title: TiDB Data Migration 快速上手指南
summary: 了解如何快速上手部署试用 TiDB Data Migration 工具。
aliases: ['/docs-cn/tidb-data-migration/dev/quick-start-with-dm/','/docs-cn/tidb-data-migration/dev/get-started/']
---
Expand Down
4 changes: 2 additions & 2 deletions dm/table-selector.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Table Selector
title: DM Table Selector
summary: 介绍 DM 的 Table Selector
aliases: ['/docs-cn/tidb-data-migration/dev/table-selector/']
---

# Table Selector
# DM Table Selector

Table Selector 提供了一种基于[通配符](https://zh.wikipedia.org/wiki/%E9%80%9A%E9%85%8D%E7%AC%A6) 来匹配指定 `schema/table` 的功能。

Expand Down