pingcap
TiCDC Craft binary protocol document
First-time contributors' checklist
- [x] I've signed Contributor License Agreement that's required for repo owners to accept my contribution.
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
- [x] master (the latest development version)
- [x] v5.2 (TiDB 5.2 versions)
What is the related PR or file link(s)?
- This PR is translated in: https://github.com/pingcap/docs-cn/pull/7547
- Other reference link(s):
Do your changes match any of the following descriptions?
- [ ] Delete files
- [ ] Change aliases
- [ ] Need modification after applied to another branch
- [ ] Might cause conflicts after applied to another branch
/translation doing /cc @amyangfei @leoppro /status PTAL @amyangfei @leoppro PTAL and help determine all the applicable versions. Thanks!
[REVIEW NOTIFICATION]
This pull request has been approved by:
- amyangfei
- hfxsd
To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.
The full list of commands accepted by this bot can be found here.
Reviewer can indicate their review by submitting an approval review. Reviewer can cancel approval by submitting a request changes review.
I'm making some final changes, please do not merge it at this time. Thanks
@sunxiaoguang @amyangfei Could you please specify the applicable versions? Thanks!
@sunxiaoguang @amyangfei Could you please specify the applicable versions? Thanks!
@amyangfei is going to have a final review and merge this PR in TiCDC soon, however I doubt we can make it in release 5.1.
@sunxiaoguang @amyangfei Could you please specify the applicable versions? Thanks!
@amyangfei is going to have a final review and merge this PR in TiCDC soon, however I doubt we can make it in release 5.1.
It's finally merged.
@sunxiaoguang @amyangfei Could you please specify the applicable versions? Thanks!
looks like this feature is going to be released in 5.1.1
We would like to translate this document into Chinese with community effort.
@amyangfei Is this PR technically approved? @hfxsd Please also take a look. Thanks!
https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_com_query.html uses hexdumps in examples. that might be useful here as well
https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_com_query.html uses hexdumps in examples. that might be useful here as well
Good idea. I put some examples for all event types:)
Thanks a lot for precious suggestions. I made some changes to address all the suggestions except for the one that breaks binary compatibility. Please take another look @dveeden @hfxsd
It's kind of hard to know why certain test failed and how to fix it.
[2021-11-17T13:39:59.228Z] functions-and-operators/expressions-pushed-down.md: this file has manual line breaks in the following lines:
[2021-11-17T13:39:59.228Z]
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L148
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L149
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L150
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L151
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L152
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L153
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L154
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L155
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L156
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L157
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L158
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L159
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L160
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L161
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L162
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L163
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L164
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L165
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L166
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L167
[2021-11-17T13:39:59.228Z]
[2021-11-17T13:39:59.228Z] functions-and-operators/json-functions.md: this file has manual line breaks in the following lines:
[2021-11-17T13:39:59.228Z]
[2021-11-17T13:39:59.228Z] MANUAL LINE BREAKS: L87
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L88
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L89
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L90
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L91
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L92
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L93
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L94
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L95
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L96
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L97
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L98
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L99
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L100
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L101
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L102
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L103
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L104
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L105
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L106
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L107
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L108
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L109
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L110
[2021-11-17T13:39:59.229Z]
[2021-11-17T13:39:59.229Z] ticdc/ticdc-craft.md: this file has manual line breaks in the following lines:
[2021-11-17T13:39:59.229Z]
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L188
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L189
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L190
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L191
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L192
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L193
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L194
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L195
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L196
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L197
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L198
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L199
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L200
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L201
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L202
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L203
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L204
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L205
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L227
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L228
[2021-11-17T13:39:59.229Z] MANUAL LINE BREAKS: L243
[2021-11-17T13:39:59.229Z]
[2021-11-17T13:39:59.229Z] The above issues will cause website build failure. Please fix them.
script returned exit code 1
From https://ci.pingcap.net/blue/organizations/jenkins/atom-common/detail/atom-common/24631/pipeline/
For now you can also run it like this:
[dvaneeden@dve-carbon docs]$ python3 <(curl -s -o - https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-manual-line-breaks.py) ticdc/ticdc-craft.md
ticdc/ticdc-craft.md: this file has manual line breaks in the following lines:
MANUAL LINE BREAKS: L188
MANUAL LINE BREAKS: L189
MANUAL LINE BREAKS: L190
MANUAL LINE BREAKS: L191
MANUAL LINE BREAKS: L192
MANUAL LINE BREAKS: L193
MANUAL LINE BREAKS: L194
MANUAL LINE BREAKS: L195
MANUAL LINE BREAKS: L196
MANUAL LINE BREAKS: L197
MANUAL LINE BREAKS: L198
MANUAL LINE BREAKS: L199
MANUAL LINE BREAKS: L200
MANUAL LINE BREAKS: L201
MANUAL LINE BREAKS: L202
MANUAL LINE BREAKS: L203
MANUAL LINE BREAKS: L204
MANUAL LINE BREAKS: L205
MANUAL LINE BREAKS: L227
MANUAL LINE BREAKS: L228
MANUAL LINE BREAKS: L243
The above issues will cause website build failure. Please fix them.
For now you can also run it like this:
[dvaneeden@dve-carbon docs]$ python3 <(curl -s -o - https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-manual-line-breaks.py) ticdc/ticdc-craft.md ticdc/ticdc-craft.md: this file has manual line breaks in the following lines: MANUAL LINE BREAKS: L188 MANUAL LINE BREAKS: L189 MANUAL LINE BREAKS: L190 MANUAL LINE BREAKS: L191 MANUAL LINE BREAKS: L192 MANUAL LINE BREAKS: L193 MANUAL LINE BREAKS: L194 MANUAL LINE BREAKS: L195 MANUAL LINE BREAKS: L196 MANUAL LINE BREAKS: L197 MANUAL LINE BREAKS: L198 MANUAL LINE BREAKS: L199 MANUAL LINE BREAKS: L200 MANUAL LINE BREAKS: L201 MANUAL LINE BREAKS: L202 MANUAL LINE BREAKS: L203 MANUAL LINE BREAKS: L204 MANUAL LINE BREAKS: L205 MANUAL LINE BREAKS: L227 MANUAL LINE BREAKS: L228 MANUAL LINE BREAKS: L243 The above issues will cause website build failure. Please fix them.
Cool. Let me fix it
For now you can also run it like this:
[dvaneeden@dve-carbon docs]$ python3 <(curl -s -o - https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-manual-line-breaks.py) ticdc/ticdc-craft.md ticdc/ticdc-craft.md: this file has manual line breaks in the following lines: MANUAL LINE BREAKS: L188 MANUAL LINE BREAKS: L189 MANUAL LINE BREAKS: L190 MANUAL LINE BREAKS: L191 MANUAL LINE BREAKS: L192 MANUAL LINE BREAKS: L193 MANUAL LINE BREAKS: L194 MANUAL LINE BREAKS: L195 MANUAL LINE BREAKS: L196 MANUAL LINE BREAKS: L197 MANUAL LINE BREAKS: L198 MANUAL LINE BREAKS: L199 MANUAL LINE BREAKS: L200 MANUAL LINE BREAKS: L201 MANUAL LINE BREAKS: L202 MANUAL LINE BREAKS: L203 MANUAL LINE BREAKS: L204 MANUAL LINE BREAKS: L205 MANUAL LINE BREAKS: L227 MANUAL LINE BREAKS: L228 MANUAL LINE BREAKS: L243 The above issues will cause website build failure. Please fix them.Cool. Let me fix it
Looks like there are other files not related to this PR failed. Do I need to fix them?
@sunxiaoguang line break issues in files unrelated to this PR can be ignored.
PR for the Chinese translation of this document is created at https://github.com/pingcap/docs-cn/pull/7547 @TomShawn PTAL
@sunxiaoguang Could you please help fix the comments and jenkins error, and finalize the document? After that, we can merge this PR. Thanks.
