Skip to content

sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and ANALYZE statements #4722

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
Merged
merged 7 commits into from
Feb 1, 2021
Merged

sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and ANALYZE statements #4722

merged 7 commits into from
Feb 1, 2021

Conversation

@CharLotteiu
Copy link
Contributor

@CharLotteiu CharLotteiu commented Jan 25, 2021

What is changed, added or deleted? (Required)

This PR changes the synopsis sections of ADD, ALTER and ANALYZE statements to use the ```ebnf+diagrm block, replacing the original image-based sqlgrams.

To avoid making one single PR too large, I will open 4-5 follow-up PRs to process sql-statements files in batches. And I will delete all image files in the last PR in case of any display issues.

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

  • master (the latest development version)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file 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

@CharLotteiu CharLotteiu added needs-cherry-pick-2.1 status/PTAL This PR is ready for reviewing. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. labels Jan 25, 2021
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
TomShawn
TomShawn reviewed Jan 26, 2021
View reviewed changes
CharLotteiu and others added 2 commits January 26, 2021 17:11
@CharLotteiu @TomShawn
Apply suggestions from code review
8b3705e 
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@CharLotteiu @TomShawn
Update sql-statements/sql-statement-add-column.md
ee15048 
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
TomShawn
TomShawn approved these changes Jan 26, 2021
View reviewed changes
Copy link
Contributor

@TomShawn TomShawn 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-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jan 26, 2021
@ti-srebot
Copy link
Contributor

ti-srebot commented Jan 28, 2021

@TomShawn, @kennytm, PTAL.

@kennytm
Copy link
Contributor

kennytm commented Jan 28, 2021

/lgtm

@ti-srebot
Copy link
Contributor

ti-srebot commented Jan 28, 2021

@kennytm, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. See the corresponding SIG page for more information. Related SIG: docs(slack).

@ti-srebot
Copy link
Contributor

ti-srebot commented Jan 30, 2021

@TomShawn, @kennytm, PTAL.

@CharLotteiu CharLotteiu merged commit 4c603f5 into pingcap:master Feb 1, 2021
ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Feb 1, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#4722 to release-2.1
dff45ea 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 1, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Feb 1, 2021

cherry pick to release-2.1 in PR #4764

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Feb 1, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#4722 to release-3.0
750a709 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 1, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Feb 1, 2021

cherry pick to release-3.0 in PR #4765

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Feb 1, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#4722 to release-3.1
58df1ce 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 1, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Feb 1, 2021

cherry pick to release-3.1 in PR #4766

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Feb 1, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#4722 to release-4.0
0756e0c 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 1, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Feb 1, 2021

cherry pick to release-4.0 in PR #4767

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Feb 1, 2021
@CharLotteiu @ti-srebot
cherry pick pingcap#4722 to release-5.0
c16d6d6 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 1, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Feb 1, 2021

cherry pick to release-5.0 in PR #4768

CharLotteiu added a commit that referenced this pull request Feb 1, 2021
@ti-srebot @CharLotteiu
cherry pick #4722 to release-5.0 (#4768)
030d707 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
CharLotteiu added a commit that referenced this pull request Feb 1, 2021
@ti-srebot @CharLotteiu
cherry pick #4722 to release-4.0 (#4767)
1757faa 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
TomShawn pushed a commit that referenced this pull request Feb 1, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
3694f4a 
… ANALYZE statements (#4722) (#4764)

* cherry pick #4722 to release-2.1

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

* resolve conflicts

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
TomShawn pushed a commit that referenced this pull request Feb 1, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
3f52836 
… ANALYZE statements (#4722) (#4765)

* cherry pick #4722 to release-3.0

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

* resolve conflicts

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
TomShawn pushed a commit that referenced this pull request Feb 1, 2021
@ti-srebot @CharLotteiu
sql-statements: use EBNF to render syntax diagrams for ADD, ALTER and…
aa1ab92 
… ANALYZE statements (#4722) (#4766)

* cherry pick #4722 to release-3.1

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

* resolve conflicts

Co-authored-by: Charlotte Liu <37295236+CharLotteiu@users.noreply.github.com>
@Joyinqin Joyinqin mentioned this pull request Mar 22, 2021
Merged
11 tasks
@CharLotteiu CharLotteiu deleted the ebnf-diagram-replace-patch-1 branch July 9, 2021 03:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kennytm kennytm Awaiting requested review from kennytm

1 more reviewer

@TomShawn TomShawn TomShawn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CharLotteiu @ti-srebot @kennytm @TomShawn