Add document of dumpling, the new export tool #3151

YuJuncen · 2020-05-19T09:19:01Z

What is changed, added or deleted? (Required)

增加了一篇关于 Dumpling 的 how-to 文档。
~~为 MyDumper 增加了 Deprecated 信息。~~

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

YuJuncen · 2020-05-19T09:22:10Z

@3pointer PTAL~

另外还有几个问题需要确认一下：

现在写上 MyDumper 不建议使用合适吗？（Dumpling 还未正式发布）
我们需要强调 Dumpling 还在测试阶段吗？

WangXiangUSTC · 2020-05-19T10:17:50Z

backup-and-restore-using-mydumper-lightning.md

 aliases: ['/docs-cn/dev/how-to/maintain/backup-and-restore/mydumper-lightning/','/docs-cn/dev/how-to/maintain/backup-and-restore/']
 ---

 # 使用 Mydumper/TiDB Lightning 进行备份与恢复


这个文档标题直接改成 使用 dumpling/TiDB Lightning 进行备份与恢复 怎么样？
下面就不用再特殊说明使用 dumpling 替换 mydumper 了
@3pointer 感觉咋样？

如果 dumpling 定位是已经可以代替 mydumper 进行 tidb 的备份，建议 dumpling/TiDB Lightning 进行备份与恢复，然后 mydumper 独立一个文档，用 Deprecated 标识出来。

另外感觉缺一个说明，比如，什么时候选择 dumpling+lightning ，什么时候选择 BR备份，什么时候用 CDC 增量备份，什么时候用 BR 增量备份

在 tools 的 use guide 里有这个说明

放在 tools 的 guide 里不太合适，用户从备份这里进来，会错过，应该在备份这里加一个总述

export-using-dumpling.md

kissmydb · 2020-05-19T14:55:19Z

export-using-dumpling.md

+
+这个命令中，`-H`，`-P`，`-u` 是经典的“地址，端口，用户”三元组。如果需要密码验证，可以用 `-p $YOUR_SECRET_PASSWORD` 传给 Dumpling。
+
+默认情况下，除了系统数据库中的表之外，Dumpling 会导出整个数据库的表。你可以使用 `--where` 来选定要导出的记录。假如导出数据的格式是 CSV（使用 `--filetype csv` 即可导出 CSV 文件），还可以使用 `--sql` 导出指定 SQL 选择出来的记录。


不支持指定表的话，--where column=xxx 是如何指定条件呢？可以增加 --where 和 --sql 的例子

kissmydb · 2020-05-19T14:59:34Z

export-using-dumpling.md

+
+默认情况下，导出的文件会存储到 `./export-<current local time>` 目录下。你可以使用 `-o` 来选择存储导出文件的目录。`-F` 选项能够指定单个文件的最大大小（和 MyDumper 不同，这里的单位是字节），与之相似的是 `-r` 选项，它指定单个文件的最大记录数（或者说，数据库中的行数）。利用这些参数可以让 Dumpling 的并行度更高。
+
+除此之外，你可以使用 `--snapshot` 标志来指定欲导出快照的时间戳。与之相关的是 `--consistency`，这个标志控制导出数据“一致性保证”的方式。对于 TiDB 来说，默认情况下我们会通过获取某个时间戳的快照来保证一致性，因此我们才可以使用 `--snapshot` 参数指定要备份的时间戳。


这句感觉不太清晰，要先指定--consistency，才能指定--snapshot吗？否则导出的是不一致性的？建议重新组织一下语言

这两处已经修改～现在的怎么样？

mydumper-overview.md

…o sw-dumpling

export-using-dumpling.md

mydumper-overview.md

backup-and-restore-using-mydumper-lightning.md

export-data-using-dumpling.md

TOC.md

Signed-off-by: sre-bot <sre-bot@pingcap.com>

yikeke · 2020-06-05T08:52:26Z

export-or-backup-using-dumpling.md

+
+上述命令中，`-H`、`-P`、`-u` 分别是地址，端口，用户。如果需要密码验证，可以用 `-p $YOUR_SECRET_PASSWORD` 传给 Dumpling。
+
+默认情况下，除了系统数据库中的表之外，Dumpling 会导出整个数据库的表。你可以使用 `--where <SQL where expression>` 来选定要导出的记录。假如导出数据的格式是 CSV（使用 `--filetype csv` 即可导出 CSV 文件），还可以使用 `--sql <SQL>` 导出指定 SQL 选择出来的记录，例如，导出 `test.sbtest1` 中所有 `id < 100` 的记录：


s/系统数据库中的表/系统表？是一个意思吗 @YuJuncen

yikeke · 2020-06-05T09:05:50Z

/run-cherry-picker

yikeke · 2020-06-05T09:15:24Z

/run-cherry-picker

yikeke · 2020-06-05T10:05:33Z

/run-cherry-picker

sre-bot · 2020-06-05T10:06:40Z

cherry pick to release-3.1 failed

yikeke · 2020-06-05T10:07:10Z

/run-cherry-picker

sre-bot · 2020-06-05T10:07:48Z

cherry pick to release-3.1 failed

yikeke · 2020-06-05T10:16:33Z

/run-cherry-picker

sre-bot · 2020-06-05T10:17:32Z

cherry pick to release-3.1 failed

* cherry pick #3497 to release-3.1 Signed-off-by: sre-bot <sre-bot@pingcap.com> * Update TOC.md * manually cp from #3151 * relocate * *: remove content about CDC Co-authored-by: Xuecheng Zhang <csuzhangxc@gmail.com> Co-authored-by: yikeke <yikeke@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>

yikeke · 2020-06-05T10:44:02Z

3.1 cp: #3512
3.0 cp: #3519
2.1 cp: #3526

dumpling: add a how-to of dumpling.

764f465

YuJuncen changed the base branch from master to docs-special-week May 19, 2020 09:19

sre-bot added the special-week PR from Document Special Week. label May 19, 2020

Merge branch 'docs-special-week' into sw-dumpling

df46891

TomShawn requested review from 3pointer, kissmydb and yikeke May 19, 2020 09:27

TomShawn added the translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. label May 19, 2020

yikeke requested review from WangXiangUSTC and lilin90 May 19, 2020 10:09

WangXiangUSTC reviewed May 19, 2020

View reviewed changes

kissmydb reviewed May 19, 2020

View reviewed changes

export-using-dumpling.md Outdated Show resolved Hide resolved

kissmydb reviewed May 19, 2020

View reviewed changes

export-using-dumpling.md Outdated Show resolved Hide resolved

kissmydb reviewed May 19, 2020

View reviewed changes

mydumper-overview.md Outdated Show resolved Hide resolved

Hillium and others added 4 commits May 20, 2020 10:36

dumpling: change document by code review.

feb154c

Merge branch 'sw-dumpling' of https://github.com/YuJuncen/docs-cn int…

7b767a5

…o sw-dumpling

Update mydumper-overview.md

d784de9

Merge branch 'docs-special-week' into sw-dumpling

44b09f7

lilin90 removed the request for review from yikeke May 20, 2020 03:51

WangXiangUSTC reviewed May 20, 2020

View reviewed changes

export-using-dumpling.md Outdated Show resolved Hide resolved

lilin90 added 2 commits May 20, 2020 14:55

Merge branch 'docs-special-week' into sw-dumpling

f3821cc

*: udpate file name and wording

446d081

lilin90 reviewed May 20, 2020

View reviewed changes

mydumper-overview.md Outdated Show resolved Hide resolved

backup-and-restore-using-mydumper-lightning.md Outdated Show resolved Hide resolved

export-data-using-dumpling.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

lilin90 added the status/require-change Needs the author to address comments. label May 20, 2020

sre-bot added the status/PTAL This PR is ready for reviewing. label May 21, 2020

sre-bot requested review from kissmydb and miaoqingli May 21, 2020 03:44

sre-bot pushed a commit to sre-bot/docs-cn that referenced this pull request Jun 5, 2020

cherry pick pingcap#3151 to release-3.1

7f91b6a

Signed-off-by: sre-bot <sre-bot@pingcap.com>

yikeke reviewed Jun 5, 2020

View reviewed changes

yikeke mentioned this pull request Jun 5, 2020

Update export-or-backup-using-dumpling.md #3517

Closed

5 tasks

csuzhangxc mentioned this pull request Jun 5, 2020

reference refine the ecosystem tools user guide #3519

Merged

5 tasks

yikeke mentioned this pull request Jun 5, 2020

dumpling: add export-or-backup-using-dumpling.md pingcap/docs#2705

Merged

5 tasks

sre-bot mentioned this pull request Jun 5, 2020

reference refine the ecosystem tools user guide (#3519) #3526

Merged

5 tasks

yikeke pushed a commit to sre-bot/docs-cn that referenced this pull request Jun 5, 2020

manually cp from pingcap#3151

aa9d346

yikeke removed the needs-cherry-pick-3.1 label Jun 5, 2020

TomShawn mentioned this pull request Jul 22, 2020

sql-mode: update compatibility #4027

Merged

5 tasks

This was referenced Jul 28, 2020

sql-mode: update compatibility (#4027) #4078

Merged

sql-mode: update compatibility (#4027) #4079

Merged

sql-mode: update compatibility (#4027) #4080

Merged


		这个命令中，`-H`，`-P`，`-u` 是经典的“地址，端口，用户”三元组。如果需要密码验证，可以用 `-p $YOUR_SECRET_PASSWORD` 传给 Dumpling。

		默认情况下，除了系统数据库中的表之外，Dumpling 会导出整个数据库的表。你可以使用 `--where` 来选定要导出的记录。假如导出数据的格式是 CSV（使用 `--filetype csv` 即可导出 CSV 文件），还可以使用 `--sql` 导出指定 SQL 选择出来的记录。


		默认情况下，导出的文件会存储到 `./export-<current local time>` 目录下。你可以使用 `-o` 来选择存储导出文件的目录。`-F` 选项能够指定单个文件的最大大小（和 MyDumper 不同，这里的单位是字节），与之相似的是 `-r` 选项，它指定单个文件的最大记录数（或者说，数据库中的行数）。利用这些参数可以让 Dumpling 的并行度更高。

		除此之外，你可以使用 `--snapshot` 标志来指定欲导出快照的时间戳。与之相关的是 `--consistency`，这个标志控制导出数据“一致性保证”的方式。对于 TiDB 来说，默认情况下我们会通过获取某个时间戳的快照来保证一致性，因此我们才可以使用 `--snapshot` 参数指定要备份的时间戳。


		上述命令中，`-H`、`-P`、`-u` 分别是地址，端口，用户。如果需要密码验证，可以用 `-p $YOUR_SECRET_PASSWORD` 传给 Dumpling。

		默认情况下，除了系统数据库中的表之外，Dumpling 会导出整个数据库的表。你可以使用 `--where <SQL where expression>` 来选定要导出的记录。假如导出数据的格式是 CSV（使用 `--filetype csv` 即可导出 CSV 文件），还可以使用 `--sql <SQL>` 导出指定 SQL 选择出来的记录，例如，导出 `test.sbtest1` 中所有 `id < 100` 的记录：

Add document of dumpling, the new export tool #3151

Add document of dumpling, the new export tool #3151

Uh oh!

Conversation

YuJuncen commented May 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

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

Uh oh!

YuJuncen commented May 19, 2020

Uh oh!

WangXiangUSTC May 19, 2020

Choose a reason for hiding this comment

Uh oh!

kissmydb May 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WangXiangUSTC May 20, 2020

Choose a reason for hiding this comment

Uh oh!

kissmydb May 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kissmydb May 19, 2020

Choose a reason for hiding this comment

Uh oh!

kissmydb May 19, 2020

Choose a reason for hiding this comment

Uh oh!

YuJuncen May 20, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yikeke Jun 5, 2020

Choose a reason for hiding this comment

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

sre-bot commented Jun 5, 2020

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

sre-bot commented Jun 5, 2020

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

sre-bot commented Jun 5, 2020

Uh oh!

yikeke commented Jun 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

YuJuncen commented May 19, 2020 •

edited

Loading

kissmydb May 19, 2020 •

edited

Loading