Skip to content

sql-statements: use EBNF to render syntax diagrams - third batch#5540

Merged
ti-chi-bot merged 5 commits into
pingcap:masterfrom
CharLotteiu:ebnf-diagram-replace-patch-3
Apr 26, 2021
Merged

sql-statements: use EBNF to render syntax diagrams - third batch#5540
ti-chi-bot merged 5 commits into
pingcap:masterfrom
CharLotteiu:ebnf-diagram-replace-patch-3

Conversation

@CharLotteiu
Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

This PR changes the synopsis sections of BEGIN, CHANGE, COMMIT, CREATE, DEALLOCATE, DELETE, DO, and DROP statements to use the ```ebnf+diagrm block, replacing the original image-based sqlgrams. It is a follow-up PR to pingcap/docs#4389.

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-4.0 size/large Changes of a large size. status/PTAL This PR is ready for reviewing. translation/doing This PR’s assignee is translating this PR. labels Feb 19, 2021
@ti-srebot
Copy link
Copy Markdown
Contributor

@kennytm, @TomShawn, PTAL.

2 similar comments
@ti-srebot
Copy link
Copy Markdown
Contributor

@kennytm, @TomShawn, PTAL.

@ti-srebot
Copy link
Copy Markdown
Contributor

@kennytm, @TomShawn, PTAL.

@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 29, 2021
@ti-chi-bot ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/large Changes of a large size. labels Mar 30, 2021
Copy link
Copy Markdown
Contributor

@kennytm kennytm left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Comment thread sql-statements/sql-statement-explain.md Outdated
@@ -26,6 +26,24 @@ TiDB 支持 `EXPLAIN [options] FOR CONNECTION connection_id`,但与 MySQL 的

![ExplainableStmt](/media/sqlgram/ExplainableStmt.png)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the images are still here 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated in 4119ba2.

@@ -30,6 +30,42 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-modify-column/','/docs-cn/d

![ColumnPosition](/media/sqlgram/ColumnPosition.png)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ditto

Comment thread sql-statements/sql-statement-replace.md Outdated
@@ -34,6 +34,31 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-replace/','/docs-cn/dev/ref

![InsertValues](/media/sqlgram/InsertValues.png)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ditto

@TomShawn
Copy link
Copy Markdown
Contributor

/sig migrate docs

@ti-chi-bot ti-chi-bot added area/migrate Indicates that the Issue or PR belongs to the area of TiDB migration tools. sig/docs Indicates that the Issue or PR belongs to the docs SIG. labels Apr 26, 2021
@TomShawn
Copy link
Copy Markdown
Contributor

/lgtm

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Apr 26, 2021
@kennytm
Copy link
Copy Markdown
Contributor

kennytm commented Apr 26, 2021

/lgtm

@ti-chi-bot
Copy link
Copy Markdown
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • kennytm

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.

Details

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Apr 26, 2021
@TomShawn
Copy link
Copy Markdown
Contributor

/merge

@ti-chi-bot
Copy link
Copy Markdown
Member

This pull request has been accepted and is ready to merge.

DetailsCommit hash: 4119ba2

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 26, 2021
@ti-chi-bot ti-chi-bot merged commit 4839002 into pingcap:master Apr 26, 2021
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Apr 26, 2021
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot
Copy link
Copy Markdown
Contributor

cherry pick to release-4.0 in PR #6168

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Apr 26, 2021
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot
Copy link
Copy Markdown
Contributor

cherry pick to release-5.0 in PR #6169

@TomShawn
Copy link
Copy Markdown
Contributor

/assign @CharLotteiu

@CharLotteiu
Copy link
Copy Markdown
Contributor Author

/remove-translation doing
/translation done

@ti-chi-bot ti-chi-bot 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 Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/migrate Indicates that the Issue or PR belongs to the area of TiDB migration tools. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants