Skip to content

add dumpling into tidb tools#3800

Merged
ti-srebot merged 28 commits into
pingcap:masterfrom
lichunzhu:refineDumplingDoc
Jul 6, 2020
Merged

add dumpling into tidb tools#3800
ti-srebot merged 28 commits into
pingcap:masterfrom
lichunzhu:refineDumplingDoc

Conversation

@lichunzhu
Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

add dumpling into tidb toolset.

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

  • master (the latest development version)
  • 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)?

  • This PR is translated from:
  • Other reference link(s):

@lichunzhu lichunzhu added status/DNM status/PTAL This PR is ready for reviewing. labels Jun 28, 2020
@lichunzhu lichunzhu requested review from 3pointer, kennytm and yikeke June 28, 2020 06:31
Comment thread download-ecosystem-tools.md Outdated
@TomShawn TomShawn added size/large Changes of a large size. needs-cherry-pick-4.0 translation/doing This PR’s assignee is translating this PR. labels Jun 28, 2020
@ti-srebot
Copy link
Copy Markdown
Contributor

@kennytm, @3pointer, @yikeke, PTAL.

Comment thread backup-and-restore-using-dumpling-lightning.md Outdated
Comment thread backup-and-restore-using-dumpling-lightning.md Outdated
Comment thread backup-and-restore-using-dumpling-lightning.md Outdated
Comment thread backup-and-restore-using-dumpling-lightning.md Outdated
@kennytm
Copy link
Copy Markdown
Contributor

kennytm commented Jul 2, 2020

LGTM

@yikeke yikeke requested a review from kissmydb July 2, 2020 06:59
Comment thread dumpling-overview.md Outdated
# Dumpling 使用文档

本文档介绍如何使用数据导出工具 [Dumpling](https://github.com/pingcap/dumpling)。该工具可以把存储在 TiDB 中的数据导出为 SQL 或者 CSV 格式,可以用于完成逻辑上的全量备份或者导出
本文档将详细介绍如何使用 Mydumper/TiDB Lightning 对 TiDB 进行全量备份与恢复
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

这篇文档和 backup-and-restore-using-dumpling-lightning.md 都是讲「如何使用 Mydumper/TiDB Lightning 对 TiDB 进行全量备份与恢复」?两篇文档的区别或者侧重点是啥?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

有笔误,我改下

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已修改

Comment thread dumpling-overview.md Outdated
# Dumpling 使用文档

本文档介绍如何使用数据导出工具 [Dumpling](https://github.com/pingcap/dumpling)。该工具可以把存储在 TiDB 中的数据导出为 SQL 或者 CSV 格式,可以用于完成逻辑上的全量备份或者导出
本文档将详细介绍如何使用 Mydumper/TiDB Lightning 对 TiDB 进行全量备份与恢复
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

这句话不对吧,不是 mydumper 和 lightning 了

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

已修改

Comment thread dumpling-overview.md Outdated

`dumpling` 是使用 go 开发的数据备份工具,项目地址可以参考 [`dumpling`](https://github.com/pingcap/dumpling)。

Dumpling 的更多具体用法可以使用 --help 指令查看,或者查看[中文使用手册](https://github.com/pingcap/dumpling/blob/master/docs/cn/user-guide.md)。
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

建议把 git 中手册内容,整合到官网这篇中,其实也就是参数介绍,不要分散在 2 处了。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

另外所有参数没有写默认值,比较重要的如:consistency

Comment thread dumpling-overview.md
Comment thread backup-and-restore-using-dumpling-lightning.md
Comment thread dumpling-overview.md Outdated
Copy link
Copy Markdown
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM. PTAL again @3pointer

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 6, 2020
@ti-srebot
Copy link
Copy Markdown
Contributor

@yikeke,Thanks for your review.

Copy link
Copy Markdown
Contributor

@ti-srebot ti-srebot left a comment

Choose a reason for hiding this comment

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

LGTM

@yikeke yikeke added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Jul 6, 2020
Copy link
Copy Markdown
Contributor

@3pointer 3pointer 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-srebot
Copy link
Copy Markdown
Contributor

@3pointer, Thanks for your review, however we are sorry that your vote won't be count. You are not a reviewer or committer or co-leader or leader for the related sigs:docs(slack).

@lichunzhu
Copy link
Copy Markdown
Contributor Author

@yikeke It sames that this PR can't pass CI check because of the dashboard document. But it looks fine to me when I check that anchor.

@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Jul 6, 2020

@yikeke It sames that this PR can't pass CI check because of the dashboard document. But it looks fine to me when I check that anchor.

I fixed them in 71460e5.

@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Jul 6, 2020

/merge

@ti-srebot ti-srebot added the status/can-merge Indicates a PR has been approved by a committer. label Jul 6, 2020
@ti-srebot
Copy link
Copy Markdown
Contributor

/run-all-tests

@ti-srebot ti-srebot merged commit 6a61173 into pingcap:master Jul 6, 2020
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jul 6, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot
Copy link
Copy Markdown
Contributor

cherry pick to release-4.0 in PR #3892

@lichunzhu lichunzhu deleted the refineDumplingDoc branch July 6, 2020 07:25
ti-srebot added a commit that referenced this pull request Jul 6, 2020
* cherry pick #3800 to release-4.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* Update backup-and-restore-using-dumpling-lightning.md

Co-authored-by: Chunzhu Li <lichunzhu@stu.xjtu.edu.cn>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
@YiniXu9506 YiniXu9506 mentioned this pull request Jul 7, 2020
5 tasks
@ti-srebot ti-srebot mentioned this pull request Jul 7, 2020
5 tasks
yikeke pushed a commit to yikeke/docs that referenced this pull request Jul 28, 2020
@yikeke yikeke added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jul 29, 2020
yikeke added a commit to pingcap/docs that referenced this pull request Jul 31, 2020
* align the structure of pingcap/docs-cn#3800

* revert

* Update dumpling-overview.md

* Update dumpling-overview.md

* update backup-and-restore-using-dumpling-lightning.md

* ADD summary

* fix an anchor

* Update dumpling-overview.md

Co-authored-by: Chunzhu Li <lichunzhu@pingcap.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Chunzhu Li <lichunzhu@pingcap.com>

* Update dumpling-overview.md

Co-authored-by: Chunzhu Li <lichunzhu@pingcap.com>

* Apply suggestions from code review

Co-authored-by: Chunzhu Li <lichunzhu@pingcap.com>

* Apply suggestions from code review

* Update dumpling-overview.md

* parameter -> option

* Update note format and add inline code format

* fix 2 dead links from upstream

Co-authored-by: Chunzhu Li <lichunzhu@pingcap.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/large Changes of a large size. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants