update dumpling argument list by lichunzhu · Pull Request #3974 · pingcap/docs-cn

lichunzhu · 2020-07-15T10:13:15Z

What is changed, added or deleted? (Required)

Update dumpling arguments list.

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

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

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

TomShawn · 2020-07-16T02:25:30Z

@lichunzhu Please involve a technical review.

lichunzhu · 2020-07-16T02:49:23Z

@kennytm @WangXiangUSTC PTAL

lichunzhu · 2020-07-16T02:50:12Z

@lichunzhu Please involve a technical review.

It sames that I don't have the right to request review from some one.

kennytm

Rest LGTM

kennytm · 2020-07-16T02:51:32Z

 | -B 或 --database | 导出指定数据库 |
 | -T 或 --tables-list | 导出指定数据表 |
-| -f 或 --filter | 导出能匹配模式的表，语法可参考 [table-filter](https://github.com/pingcap/tidb-tools/blob/master/pkg/table-filter/README.md)（只有英文版） | "\*.\*" 不过滤任何库表 |
+| -f 或 --filter | 导出能匹配模式的表，语法可参考 [table-filter](https://docs.pingcap.com/zh/tidb/stable/table-filter) | "\*.\*" 导出所有库表 |


kennytm · 2020-07-16T02:56:17Z

+| --csv-delimiter | csv 文件中字符类型变量的定界符 | '"' |
+| --csv-separator | csv 文件中各值的分隔符 | ',' |
+| --csv-null-value | csv 文件空值的表示 | "\\N" |
+| --escape-backslash | 使用反斜线 ("\") 来注释导出文件中的特殊字符，为 false 时使用单引号 ("'") 注释 | true |


kennytm · 2020-07-16T02:59:39Z

+| --csv-separator | csv 文件中各值的分隔符 | ',' |
+| --csv-null-value | csv 文件空值的表示 | "\\N" |
+| --escape-backslash | 使用反斜线 ("\") 来注释导出文件中的特殊字符，为 false 时使用单引号 ("'") 注释 | true |
+| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 '{{.DB}}','{{.Table}}','{{.Index}}' 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |


please use ` to escape the special syntax

kennytm · 2020-07-16T03:05:00Z

+| --csv-null-value | csv 文件空值的表示 | "\\N" |
+| --escape-backslash | 使用反斜线 ("\") 来注释导出文件中的特殊字符，为 false 时使用单引号 ("'") 注释 | true |
+| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 '{{.DB}}','{{.Table}}','{{.Index}}' 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |
+| --status-addr | dumpling 的服务地址，包含了运行时的 pprof 信息 | ":8281" |


TomShawn · 2020-07-16T03:58:38Z

+| --escape-backslash | 使用反斜杠 (`\`) 来转义导出文件中的特殊字符 | true |
+| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`,`{{.Table}}`,`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |
+| --status-addr | Dumpling 的服务地址，包含了 Prometheus 拉取 metrics 信息及 pprof 调试的地址 | ":8281" |
+| --tidb-mem-quota-query | 单条 dumpling 导出 sql 的内存限制，单位为 B，默认为 32GB | 34359738368 |


TomShawn · 2020-07-16T04:00:01Z

+| --csv-separator | csv 文件中各值的分隔符 | ',' |
+| --csv-null-value | csv 文件空值的表示 | "\\N" |
+| --escape-backslash | 使用反斜杠 (`\`) 来转义导出文件中的特殊字符 | true |
+| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`,`{{.Table}}`,`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |


Suggested change

| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`,`{{.Table}}`,`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |

| --output-filename-template | [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`、`{{.Table}}`、`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名、表名、分块 ID | '{{.DB}}.{{.Table}}.{{.Index}}' |

TomShawn · 2020-07-16T04:04:21Z


 | 主要参数 | 用途 | 默认值 |
 | --------| --- | --- |
+| -V 或 --version | 输出 dumpling 版本并直接退出 |


TomShawn

LGTM
@kennytm @WangXiangUSTC PTAL again

kennytm

LGTM

ti-srebot · 2020-07-17T10:40:37Z

@kennytm,Thanks for your review. However, LGTM is restricted to Reviewers or higher roles.See the corresponding SIG page for more information. Related SIGs: docs(slack).

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

ti-srebot · 2020-07-17T11:09:22Z

cherry pick to release-4.0 in PR #3997

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Chunzhu Li <lichunzhu@stu.xjtu.edu.cn>

update dumpling argument list

78c15de

TomShawn added needs-cherry-pick-4.0 size/small Changes of a small size. translation/doing This PR’s assignee is translating this PR. labels Jul 16, 2020

TomShawn self-requested a review July 16, 2020 02:25

TomShawn self-assigned this Jul 16, 2020

kennytm reviewed Jul 16, 2020

View reviewed changes

address comments

d661087

TomShawn reviewed Jul 16, 2020

View reviewed changes

lichunzhu added 2 commits July 16, 2020 12:09

address comments

a2629cc

address comment

0b92636

TomShawn approved these changes Jul 16, 2020

View reviewed changes

ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 16, 2020

kennytm reviewed Jul 17, 2020

View reviewed changes

Merge branch 'master' into refineDumplingDoc

0cec877

TomShawn merged commit eef4e7d into pingcap:master Jul 17, 2020

lichunzhu deleted the refineDumplingDoc branch July 17, 2020 11:08

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jul 17, 2020

cherry pick pingcap#3974 to release-4.0

f3cba8b

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

ti-srebot mentioned this pull request Jul 17, 2020

update dumpling argument list (#3974) #3997

Merged

5 tasks

TomShawn pushed a commit that referenced this pull request Jul 17, 2020

cherry pick #3974 to release-4.0 (#3997)

d0ded9d

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Chunzhu Li <lichunzhu@stu.xjtu.edu.cn>

yikeke assigned yikeke and unassigned TomShawn Jul 29, 2020

yikeke removed the translation/doing This PR’s assignee is translating this PR. label Jul 29, 2020

yikeke added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jul 29, 2020

yikeke mentioned this pull request Jul 29, 2020

add dumpling into tidb tools pingcap/docs#3453

Merged

9 tasks

ti-srebot mentioned this pull request Jul 31, 2020

add dumpling into tidb tools (#3453) pingcap/docs#3498

Merged

9 tasks

	\| -f 或 --filter \| 导出能匹配模式的表，语法可参考 [table-filter](https://docs.pingcap.com/zh/tidb/stable/table-filter) \| "\.\" 导出所有库表 \|
	\| -f 或 --filter \| 导出能匹配模式的表，语法可参考 [table-filter](/table-filter.md) \| `.` 导出所有库表 \|

	\| --escape-backslash \| 使用反斜线 ("\") 来注释导出文件中的特殊字符，为 false 时使用单引号 ("'") 注释 \| true \|
	\| --escape-backslash \| 使用反斜杠 (`\`) 来转义导出文件中的特殊字符 \| true \|

	\| --status-addr \| dumpling 的服务地址，包含了运行时的 pprof 信息 \| ":8281" \|
	\| --status-addr \| Dumpling 的服务地址，包含了 Prometheus 拉取 metrics 信息及 pprof 调试的地址 \| ":8281" \|

	\| --tidb-mem-quota-query \| 单条 dumpling 导出 sql 的内存限制，单位为 B，默认为 32GB \| 34359738368 \|
	\| --tidb-mem-quota-query \| 单条 dumpling 命令导出 SQL 语句的内存限制，单位为 byte，默认为 32 GB \| 34359738368 \|

	\| --output-filename-template \| [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`,`{{.Table}}`,`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名，表名，分块 ID \| '{{.DB}}.{{.Table}}.{{.Index}}' \|
	\| --output-filename-template \| [golang template](https://golang.org/pkg/text/template/#hdr-Arguments) 格式表示的数据文件名格式 <br/> 支持 `{{.DB}}`、`{{.Table}}`、`{{.Index}}` 三个参数 <br/> 分别表示数据文件的库名、表名、分块 ID \| '{{.DB}}.{{.Table}}.{{.Index}}' \|

	\| -V 或 --version \| 输出 dumpling 版本并直接退出 \|
	\| -V 或 --version \| 输出 Dumpling 版本并直接退出 \|

Conversation

lichunzhu commented Jul 15, 2020

What is changed, added or deleted? (Required)

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

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

Uh oh!

TomShawn commented Jul 16, 2020

Uh oh!

lichunzhu commented Jul 16, 2020

Uh oh!

lichunzhu commented Jul 16, 2020

Uh oh!

kennytm left a comment

Choose a reason for hiding this comment

Uh oh!

kennytm Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

kennytm Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

kennytm Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

kennytm Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

TomShawn Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

TomShawn Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

TomShawn Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

TomShawn left a comment

Choose a reason for hiding this comment

Uh oh!

kennytm left a comment

Choose a reason for hiding this comment

Uh oh!

ti-srebot commented Jul 17, 2020

Uh oh!

ti-srebot commented Jul 17, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants