sql-statements: use EBNF to render syntax diagrams for BACKUP and RESTORE #5069
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TomShawn
added
translation/from-docs
ran-huang
reviewed
Dec 10, 2020
|  | ||
| ```ebnf+diagram | ||
| BackupStmt ::= | ||
| "BACKUP" BRIETables "TO" stringLit BackupOption* |
Contributor
There was a problem hiding this comment.
Will the blank lines affect the display?
Contributor
There was a problem hiding this comment.
No the parser treats new lines as the same as spaces which are ignored. Even
```ebnf+diagram
a ::= b c ::= d
```will work
kennytm
reviewed
Dec 10, 2020
Contributor
kennytm
left a comment
kennytm
left a comment
There was a problem hiding this comment.
LGTM but maybe you should fix the PR title 😉
ran-huang
approved these changes
Dec 10, 2020
TomShawn
changed the title
ti-srebot
pushed a commit
to ti-srebot/docs-cn
that referenced
this pull request
Dec 10, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
9 tasks
Contributor
|
cherry pick to release-4.0 in PR #5074 |
TomShawn
added a commit
that referenced
this pull request
Dec 10, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
lilin90
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…TORE
What is changed, added or deleted? (Required)
Change the synopsis sections of BACKUP, RESTORE and SHOW {BACKUPS|RESTORES} to use the
```ebnf+diagrmblock introduced since pingcap/website-docs#83, replacing the original image-based sqlgrams (which files are deleted).Output preview
The syntax diagrams are now rendered server-side as SVG when building (similar to SQLite3 / IBM DB2 / CockroachDB's docs), and user can also toggle between syntax diagram and the source EBNF (similar to Oracle's docs).
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?