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

tools: add more argument description of Syncer #1030

Merged
merged 4 commits into from
Apr 15, 2019
Merged

tools: add more argument description of Syncer #1030

merged 4 commits into from
Apr 15, 2019

Conversation

yikeke
Copy link
Contributor

@yikeke yikeke commented Apr 9, 2019

amyangfei
amyangfei reviewed Apr 10, 2019
View reviewed changes
Copy link
Contributor

@amyangfei amyangfei left a comment

Choose a reason for hiding this comment

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

LGTM

@lilin90 lilin90 requested a review from CaitinChen April 10, 2019 10:00
CaitinChen
CaitinChen reviewed Apr 11, 2019
View reviewed changes
tools/syncer.md Outdated
@@ -66,7 +66,7 @@ Usage of syncer:
-log-rotate string
to specify the log file rotating cycle, hour/day (default "day")
-max-retry int
to specify maximum retry times during network interruption (default 100)
to specify maximum retry times when an error occurs due to network interruption or other reasons (default 100)
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
to specify maximum retry times when an error occurs due to network interruption or other reasons (default 100)
to specify maximum retry times of the SQL request when an error occurs due to network interruption or other reasons (default 100)

tools/syncer.md Outdated
# skip-ddls = ["ALTER USER", "CREATE USER"]

# After Syncer uses `route-rules` to map the upstream schema and table into `target-schema` and `target-table`,
# Syncer matches the mapped `target-schema` and `target-table` with do / ignore rules,
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
# Syncer matches the mapped `target-schema` and `target-table` with do / ignore rules,
# Syncer matches the mapped `target-schema` and `target-table` with do/ignore rules,

Copy link
Contributor

Choose a reason for hiding this comment

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

There is no space before and after "/".

morgo
morgo reviewed Apr 12, 2019
View reviewed changes
tools/syncer.md Outdated
@@ -66,7 +66,7 @@ Usage of syncer:
-log-rotate string
to specify the log file rotating cycle, hour/day (default "day")
-max-retry int
to specify maximum retry times during network interruption (default 100)
to specify maximum retry times of the SQL request when an error occurs due to network interruption or other reasons (default 100)
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
to specify maximum retry times of the SQL request when an error occurs due to network interruption or other reasons (default 100)
specifies the maximum times an SQL statement should be retried. One common cause of statement retries is network interruption (default 100)

I think it's better not to say "or other reasons" and not specify. Here we can say it is a common cause, but imply it is not the only one. I assume it might be transaction conflicts with retry disabled that is another, but that is complex to explain here.

morgo
morgo reviewed Apr 12, 2019
View reviewed changes
tools/syncer.md Outdated
@@ -100,19 +102,25 @@ status-addr = ":8271"
# If you set its value to true, Syncer stops and exits when it encounters the DDL operation.
stop-on-ddl = false

# max-retry is used for retry during network interruption.
# The maximum retry times of the SQL request when an error occurs due to network interruption or other reasons.
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
# The maximum retry times of the SQL request when an error occurs due to network interruption or other reasons.
# The maximum number of times an SQL statement should be retried. One common cause of statement retries is network interruption.

Same as above.

@yikeke
Copy link
Contributor Author

yikeke commented Apr 14, 2019

Feedback addressed. PTAL again. @CaitinChen @morgo

CaitinChen
CaitinChen approved these changes Apr 15, 2019
View reviewed changes
Copy link
Contributor

@CaitinChen CaitinChen left a comment

Choose a reason for hiding this comment

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

LGTM

@CaitinChen
Copy link
Contributor

@morgo PTAL again. Thanks.

@morgo morgo merged commit c18a5a7 into pingcap:master Apr 15, 2019
morgo added a commit that referenced this pull request Apr 17, 2019
@morgo
Fix tabs (#1057)
719ca06 
* Convert English Docs to DITA ToC (#996)

The content remains the same. Only the TOC changes in this PR

* Fix a broken link (#1047)

* tools: add more argument description of Syncer (#1030)

* tools: add more argument description of syncer
Via: pingcap/docs-cn#1215

* sql: add working mechanism of system variables (#1035)

Via: pingcap/docs-cn#1225 PTAL

* overview, intro: move content around (#1045)

* Update TOC.md
* Update and rename overview.md to key-features.md
* Update and rename QUICKSTART.md to overview.md

* TOC: fix breakage from #1045 (#1050)

The features linked to overview.md

* Sql/transaction: changes on variables (#1036)

* tools, v2.1: fix a typo (#1052)

* add blank line and fix incorrect link (#1051)

* toc, config flags: fix inconsistencies in headings (#1054)

* fix inconsistencies in file names and heading

* use  2nd level heading for all flags

* fix typo in meta

* revert file name change until later

* revert file name

* escape * character

* sql: update EXPLAIN related document (#1039)

* fix the format error

* Revert "fix the format error"

This reverts commit 2855bbd.

* sysbench-v4: fix a format error

* sql: add and modify some contents

* Revert "sysbench-v4: fix a format error"

This reverts commit 2d9016c.

* sql: update sql\EXPLAIN related documents

* Update mysql-compatibility.md

* correct one format error

* Add homebrew and dbdeployer guides (#1056)

* Add homebrew and dbdeployer guides

* fix case

* Update install-from-homebrew.md

* Fix tabs
morgo added a commit that referenced this pull request Apr 20, 2019
@morgo
Preview get started (#1068)
34dfbb4 
* Convert English Docs to DITA ToC (#996)

The content remains the same. Only the TOC changes in this PR

* Changed URL structure of how-to/get-started.

Fixed s/sample/example/ bug introduced in DITA

* fixed categories

* Fixed bugs

* Fix a broken link (#1047)

* tools: add more argument description of Syncer (#1030)

* tools: add more argument description of syncer
Via: pingcap/docs-cn#1215

* sql: add working mechanism of system variables (#1035)

Via: pingcap/docs-cn#1225 PTAL

* Fix broken link

* fix broken link

* fix broken links

* fix broken links

* overview, intro: move content around (#1045)

* Update TOC.md
* Update and rename overview.md to key-features.md
* Update and rename QUICKSTART.md to overview.md

* TOC: fix breakage from #1045 (#1050)

The features linked to overview.md

* Sql/transaction: changes on variables (#1036)

* tools, v2.1: fix a typo (#1052)

* add blank line and fix incorrect link (#1051)

* toc, config flags: fix inconsistencies in headings (#1054)

* fix inconsistencies in file names and heading

* use  2nd level heading for all flags

* fix typo in meta

* revert file name change until later

* revert file name

* escape * character

* sql: update EXPLAIN related document (#1039)

* fix the format error

* Revert "fix the format error"

This reverts commit 2855bbd.

* sysbench-v4: fix a format error

* sql: add and modify some contents

* Revert "sysbench-v4: fix a format error"

This reverts commit 2d9016c.

* sql: update sql\EXPLAIN related documents

* Update mysql-compatibility.md

* correct one format error

* Add homebrew and dbdeployer guides (#1056)

* Add homebrew and dbdeployer guides

* fix case

* Update install-from-homebrew.md

* fix tabs (#1058)

Unfortunately I can't preview this, because the
preview website has not updated in >2 hours.

* benchmark: update wording (#1055)

* benchmark: update wording

* Remove "the"

* Minor typo fix (#1061)

* gsod: add TiDB project ideas (#1066)

* gsod: add TiDB project ideas

* gsod: update the file name and format

* Small change to bash scripting for downloading bikeshare data files (#1063)

Use curl instead of wget (more commonly available)

* Fix formatting

* Attempt to fix broken link
morgo added a commit that referenced this pull request Apr 29, 2019
@morgo @CaitinChen
Update secure monitor (#1094)
8ab3bbe 
* Convert English Docs to DITA ToC (#996)

The content remains the same. Only the TOC changes in this PR

* Fix a broken link (#1047)

* tools: add more argument description of Syncer (#1030)

* tools: add more argument description of syncer
Via: pingcap/docs-cn#1215

* sql: add working mechanism of system variables (#1035)

Via: pingcap/docs-cn#1225 PTAL

* overview, intro: move content around (#1045)

* Update TOC.md
* Update and rename overview.md to key-features.md
* Update and rename QUICKSTART.md to overview.md

* Initial move of monitor/secure

* TOC: fix breakage from #1045 (#1050)

The features linked to overview.md

* Sql/transaction: changes on variables (#1036)

* tools, v2.1: fix a typo (#1052)

* add blank line and fix incorrect link (#1051)

* toc, config flags: fix inconsistencies in headings (#1054)

* fix inconsistencies in file names and heading

* use  2nd level heading for all flags

* fix typo in meta

* revert file name change until later

* revert file name

* escape * character

* sql: update EXPLAIN related document (#1039)

* fix the format error

* Revert "fix the format error"

This reverts commit 2855bbd.

* sysbench-v4: fix a format error

* sql: add and modify some contents

* Revert "sysbench-v4: fix a format error"

This reverts commit 2d9016c.

* sql: update sql\EXPLAIN related documents

* Update mysql-compatibility.md

* correct one format error

* Add homebrew and dbdeployer guides (#1056)

* Add homebrew and dbdeployer guides

* fix case

* Update install-from-homebrew.md

* fix tabs (#1058)

Unfortunately I can't preview this, because the
preview website has not updated in >2 hours.

* benchmark: update wording (#1055)

* benchmark: update wording

* Remove "the"

* Minor typo fix (#1061)

* gsod: add TiDB project ideas (#1066)

* gsod: add TiDB project ideas

* gsod: update the file name and format

* Small change to bash scripting for downloading bikeshare data files (#1063)

Use curl instead of wget (more commonly available)

* Change URL structure of how-to/get-started (#1046)

Changed URL structure of how-to/get-started.
Fixed s/sample/example/ bug introduced in DITA
fixed categories

* Attempt to fix relative link. (#1069)

There seems to be a problem with the website in that the filename in the current directory is not relative.

I am not sure if this will fix it, but I have to try, since including the full path (/dev/how-to/..) makes version split more difficult, since only one version will be /dev/.

* tools, media: update binlog's config file (#1053)

* tools, media: update binlog's config file

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* Update tidb-binlog-cluster.md

 Add ”txn-batch = 20".

* Update tidb-binlog-cluster.md

Address a commit.

* Update tidb-binlog-cluster.md

Address a commit.

* v2.1/tools: update TiDB-Binlog

* Revert "v2.1/tools: update TiDB-Binlog"

This reverts commit 60e49a5.

* Update tools/tidb-binlog-cluster.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* v2.1/tools: update TiDB-Binlog (#1059)

* v2.1/tools: update TiDB-Binlog

* Update tidb-binlog-cluster.md

Address a commit.

* op-guide: update TiDB-Ansible version information (#1064)

* Fix broken link using absolute reference (#1077)

* Cleaned up and added TiDB Server info (#1076)

* Cleaned up and added TiDB Server info

* More doc cleanup

* Fixed table of node mappings

* Clarified command line parameters

* Fixed letter casing and indenting

* Clarified need to download binlogctl

* update condition (#1072)

* benchmark, v2.1/benchmark: remove an invalid link (#1080)

* *: update the Note format (#1079)

* *: update the Note format

* Update note format

* Update the Note format

* ROADMAP: add supporting invisible index (#1070)

* ROADMAP: add supporting invisible index

1. Add supporting invisible index
2. Fix a spelling mistake in line 45

* ROADMAP: add supporting invisible index

* Update ROADMAP.md

Co-Authored-By: IzabelWang <37297881+IzabelWang@users.noreply.github.com>

* sql, TOC: update doc title (#1071)

* Update URLs for deploy (#1048)

* Moved how-to/deply files to new URLs
* Update URLs to use absolute links.

* Update the rest of how-to files

* fix missing toc updates

* Fix missing file rename

* sql: update the USE command explanation in util document (#1075)

* docs-cn #1112 Update the USE command explanation in util document

* Update sql/util.md

Co-Authored-By: ericsyh <ericshenyuhao@outlook.com>

* Update v1.0/sql/util.md

Co-Authored-By: ericsyh <ericshenyuhao@outlook.com>

* Update v2.0/sql/util.md

Co-Authored-By: ericsyh <ericshenyuhao@outlook.com>

* Update v2.1/sql/util.md

Co-Authored-By: ericsyh <ericshenyuhao@outlook.com>

* update the loader pprof-addr default port (#1065)

* releases: correct the TiDB-Ansible version (#1084)

* *: update the Warning format (#1082)

* TOC: fix a broken link and update capitalization (#1090)

* *: explain select for update statement (#1093)

* *: explain select for update statement

Via: pingcap/docs-cn#1284

* *: update wording

* *: update description

* *: update format and wording

* tools: update syncer batch size (#1092)

* trouble-shooting: update the issue report link (#1091)

* trouble-shooting: update the issue report link

* Update trouble-shooting.md

Co-Authored-By: CaitinChen <34535727+CaitinChen@users.noreply.github.com>

* Update trouble-shooting.md

Co-Authored-By: CaitinChen <34535727+CaitinChen@users.noreply.github.com>

* Update trouble-shooting.md

Co-Authored-By: CaitinChen <34535727+CaitinChen@users.noreply.github.com>
@yikeke yikeke deleted the add-more-syncer-argument-description branch June 27, 2019 05:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@morgo morgo morgo left review comments

@amyangfei amyangfei amyangfei left review comments

@CaitinChen CaitinChen CaitinChen approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yikeke @CaitinChen @morgo @amyangfei