Skip to content

sql-statements: use EBNF to render syntax diagrams for BACKUP and RESTORE #5069

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

Merged
merged 3 commits into from
Dec 10, 2020
Merged

sql-statements: use EBNF to render syntax diagrams for BACKUP and RESTORE #5069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76ef248
sql-statements: use ENBF to render syntax diagrams for BACKUP and RES…
TomShawn Dec 10, 2020
e6e5a92
add blank lines
TomShawn Dec 10, 2020
6989482
Merge branch 'master' into ENBF-br-graphs
TomShawn Dec 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed media/sqlgram/BRIETables.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/BackupOption.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/BackupStmt.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/BackupTSO.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/Boolean.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/RestoreOption.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/RestoreStmt.png
View file
Open in desktop
Binary file not shown.
Binary file removed media/sqlgram/ShowBRIEStmt.png
View file
Open in desktop
Binary file not shown.
41 changes: 22 additions & 19 deletions sql-statements/sql-statement-backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,28 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-backup/']

## 语法图

**BackupStmt:**

![BackupStmt](/media/sqlgram/BackupStmt.png)

**BRIETables:**

![BRIETables](/media/sqlgram/BRIETables.png)

**BackupOption:**

![BackupOption](/media/sqlgram/BackupOption.png)

**Boolean:**

![Boolean](/media/sqlgram/Boolean.png)

**BackupTSO:**

![BackupTSO](/media/sqlgram/BackupTSO.png)
```ebnf+diagram
BackupStmt ::=
"BACKUP" BRIETables "TO" stringLit BackupOption*
Copy link
Contributor

@ran-huang ran-huang Dec 10, 2020

Choose a reason for hiding this comment

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

Will the blank lines affect the display?

Copy link
Contributor

@kennytm kennytm Dec 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

No the parser treats new lines as the same as spaces which are ignored. Even

```ebnf+diagram
a ::= b c ::= d
```

will work


BRIETables ::=
"DATABASE" ( '*' | DBName (',' DBName)* )
| "TABLE" TableNameList

BackupOption ::=
"RATE_LIMIT" '='? LengthNum "MB" '/' "SECOND"
| "CONCURRENCY" '='? LengthNum
| "CHECKSUM" '='? Boolean
| "SEND_CREDENTIALS_TO_TIKV" '='? Boolean
| "LAST_BACKUP" '='? BackupTSO
| "SNAPSHOT" '='? ( BackupTSO | LengthNum TimestampUnit "AGO" )

Boolean ::=
NUM | "TRUE" | "FALSE"

BackupTSO ::=
LengthNum | stringLit
```

## 示例

Expand Down
32 changes: 17 additions & 15 deletions sql-statements/sql-statement-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,23 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-restore/']

## 语法图

**RestoreStmt:**

![RestoreStmt](/media/sqlgram/RestoreStmt.png)

**BRIETables:**

![BRIETables](/media/sqlgram/BRIETables.png)

**RestoreOption:**

![RestoreOption](/media/sqlgram/RestoreOption.png)

**Boolean:**

![Boolean](/media/sqlgram/Boolean.png)
```ebnf+diagram
RestoreStmt ::=
"RESTORE" BRIETables "FROM" stringLit RestoreOption*

BRIETables ::=
"DATABASE" ( '*' | DBName (',' DBName)* )
| "TABLE" TableNameList

RestoreOption ::=
"RATE_LIMIT" '='? LengthNum "MB" '/' "SECOND"
| "CONCURRENCY" '='? LengthNum
| "CHECKSUM" '='? Boolean
| "SEND_CREDENTIALS_TO_TIKV" '='? Boolean

Boolean ::=
NUM | "TRUE" | "FALSE"
```

## 示例

Expand Down
13 changes: 7 additions & 6 deletions sql-statements/sql-statement-show-backups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ aliases: ['/docs-cn/dev/sql-statements/sql-statement-show-backups/']

## 语法图

**ShowBRIEStmt:**
```ebnf+diagram
ShowBRIEStmt ::=
"SHOW" ("BACKUPS" | "RESTORES") ShowLikeOrWhere?

![ShowBRIEStmt](/media/sqlgram/ShowBRIEStmt.png)

**ShowLikeOrWhereOpt:**

![ShowLikeOrWhereOpt](/media/sqlgram/ShowLikeOrWhereOpt.png)
ShowLikeOrWhere ::=
"LIKE" SimpleExpr
| "WHERE" Expression
```

## 示例

Expand Down