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

Documenting binary encoding used with Canal-JSON #13832

Merged
merged 22 commits into from
Jul 18, 2023
Merged

Documenting binary encoding used with Canal-JSON #13832

merged 22 commits into from
Jul 18, 2023

Conversation

benmeadowcroft
Copy link
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

I added documentation that describes how the binary data found in BINARY, VARBINARY, and BLOB columns is encoded when using the Canal-JSON format.

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

  • master (the latest development version)
  • v7.2 (TiDB 7.2 versions)
  • v7.1 (TiDB 7.1 versions)
  • v7.0 (TiDB 7.0 versions)
  • v6.6 (TiDB 6.6 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

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

None

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

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

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 9, 2023

Welcome @benmeadowcroft!

It looks like this is your first PR to pingcap/docs 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs. 😃

@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 9, 2023
zhangjinpeng87
zhangjinpeng87 approved these changes Jun 9, 2023
View reviewed changes
Copy link

@zhangjinpeng87 zhangjinpeng87 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-chi-bot
Copy link

ti-chi-bot bot commented Jun 9, 2023

@zhangjinpeng1987: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@nongfushanquan
Copy link

/cc @sdojjy

@ti-chi-bot ti-chi-bot bot requested a review from sdojjy June 10, 2023 00:32
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 12, 2023

@sdojjy: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 12, 2023
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jun 13, 2023

@nongfushanquan: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@benmeadowcroft
Copy link
Collaborator Author

It looks like the jenkins-docs/verify workflow failed. However it looks like it may be a transitory issue according to https://ci.pingcap.net/blue/organizations/jenkins/docs-verify-pipeline/detail/docs-verify-pipeline/18172/pipeline/ so not sure what the next steps on this would be. Please let me know if there is anything further needed from myself.

@nongfushanquan
Copy link

nongfushanquan commented Jun 19, 2023 •
edited
Loading

/cc @qiancai
Please review and merge this pr, thanks

@ti-chi-bot ti-chi-bot bot requested a review from qiancai June 19, 2023 09:21
@benmeadowcroft
Copy link
Collaborator Author

Updated the example encoding to address a copy paste error in d4e96f5

@benmeadowcroft
Copy link
Collaborator Author

@qiancai please let me know if there are other changes that are needed. Thank you

qiancai
qiancai reviewed Jun 30, 2023
View reviewed changes
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
@benmeadowcroft
Copy link
Collaborator Author

@qiancai I believe all of the suggested changes have been accommodated now. Thanks for your review

qiancai
qiancai reviewed Jul 10, 2023
View reviewed changes
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ran-huang
ran-huang reviewed Jul 10, 2023
View reviewed changes
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
ticdc/ticdc-canal-json.md Outdated Show resolved Hide resolved
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Jul 11, 2023
qiancai
qiancai approved these changes Jul 18, 2023
View reviewed changes
Copy link
Collaborator

@qiancai qiancai 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-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 18, 2023
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jul 18, 2023
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jul 18, 2023

[LGTM Timeline notifier]

Timeline:

  • 2023-07-18 10:11:46.407098584 +0000 UTC m=+1017998.177437298: ☑️ agreed by qiancai.
  • 2023-07-18 10:15:15.954160547 +0000 UTC m=+1018207.724499257: ☑️ agreed by ran-huang.

@qiancai
Copy link
Collaborator

qiancai commented Jul 18, 2023

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jul 18, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Jul 18, 2023
@ti-chi-bot ti-chi-bot bot merged commit a84828d into pingcap:master Jul 18, 2023
6 checks passed
@qiancai qiancai mentioned this pull request Aug 14, 2023
Merged
17 tasks
@qiancai qiancai 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 Aug 14, 2023
@qiancai qiancai added the area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. label Sep 12, 2023
This was referenced Oct 10, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdojjy sdojjy sdojjy approved these changes

@zhangjinpeng87 zhangjinpeng87 zhangjinpeng87 approved these changes

@ran-huang ran-huang ran-huang approved these changes

@qiancai qiancai qiancai approved these changes

@nongfushanquan nongfushanquan nongfushanquan approved these changes

Assignees

@qiancai qiancai

Labels
approved area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@benmeadowcroft @nongfushanquan @qiancai @sdojjy @zhangjinpeng87 @ran-huang